Skip to main content
Skip to main content

ShippingMethod

The attributes to update in the order's shipping method.

constructor

A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of.


Properties

provider_idstring
The ID of the shipping provider used in the order.
profile_idstring
The ID of the shipping profile used in the order.
pricenumber
The price of the shipping method.
dataRecord<string, unknown>
The data to attach to the shipping method.
itemsRecord<string, unknown>[]
The line items associated with this shipping methods.
Was this section helpful?