Skip to main content
Skip to main content

ShippingProfile

A Shipping Profile has a set of defined Shipping Options that can be used to fulfill a given set of Products. For example, gift cards are shipped differently than physical products, so a shipping profile with the type gift\_card groups together the shipping options that can only be used for gift cards.

Properties

idstringRequired
The shipping profile's ID
created_atDateRequired
The date with timezone at which the resource was created.
updated_atDateRequired
The date with timezone at which the resource was updated.
deleted_atnull | DateRequired
The date with timezone at which the resource was deleted.
namestringRequired
The name given to the Shipping profile - this may be displayed to the Customer.
The type of the Shipping Profile, may be default, gift\_card or custom.
productsProduct[]Required
The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation products is expanded.
shipping_optionsShippingOption[]Required
The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.
metadataRecord<string, unknown>Required
An optional key-value map with additional details
Was this section helpful?