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.

Constructors

constructor

**new 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

created_atDateRequired

The date with timezone at which the resource was created.

deleted_atnull | DateRequired

The date with timezone at which the resource was deleted.

idstringRequired

The shipping profile's ID

metadataRecord<string, unknown>Required

An optional key-value map with additional details

namestringRequired

The name given to the Shipping profile - this may be displayed to the Customer.

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.

typeShippingProfileTypeRequired

The type of the Shipping Profile, may be default, gift\_card or custom.

updated_atDateRequired

The date with timezone at which the resource was updated.

Methods

beforeInsert

Private **beforeInsert**(): void

Returns

void

voidvoid