Shipping Option Object


Properties
idstringRead-onlyformat GUID

ShippingOption ID.


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.


createdDatestringRead-onlyformat date-time

Date and time the ShippingOption was created.


updatedDatestringRead-onlyformat date-time

Date and time the ShippingOption was last updated.


deliveryRegionIdstringdeprecated - use deliveryRegionIds insteadformat GUIDimmutable

Associated delivery region id.


deliveryRegionIdsArray <string>maxItems 50format GUIDimmutable

This shipping option is active for the following delivery regions.


titlestringmaxLength 1000

Delivery option configured for the ShippingOption


estimateDeliveryTimestringdeprecated - use estimatedDeliveryTime insteadmaxLength 500

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


estimatedDeliveryTimestringmaxLength 500

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


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.


extendedFieldsExtendedFields

Data Extensions

Did this help?