Shipping Option Object


Properties
createdDatestringRead-onlyformat date-time

Date and time the ShippingOption was created.


deliveryRegionIdstringdeprecated - use deliveryRegionIds insteadformat GUIDimmutable

Associated delivery region id.


deliveryRegionIdsArray <string>maxItems 50format GUIDimmutable

This shipping option is active for the following delivery regions.


estimatedDeliveryTimestringmaxLength 500

Estimated delivery time. For example, "2-3 business days".


extendedFieldsExtendedFields

Data Extensions


idstringRead-onlyformat GUID

ShippingOption ID.


ratesArray <ConditionalRates>minItems 1maxItems 50

at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the ShippingOption is updated. To prevent conflicting changes, the current revision must be passed when updating the ShippingOption.

Ignored when creating a ShippingOption.


titlestringmaxLength 1000

Delivery option configured for the ShippingOption


updatedDatestringRead-onlyformat date-time

Date and time the ShippingOption was last updated.

Did this help?