Get Shipping Options

Note

We recommend calling the Get Shipping Options API whenever a user enters the checkout or makes any change to the order or delivery location. This ensures that the shipping options are always up to date and available for the given cart.

A checkout process starts by fetching the available shipping options.

Transporter Branding

Each returned transport method can include optional transporterLogo and transporterIcon fields. These are signed URLs for the transporter's checkout branding assets and are also returned by the Shopify shipping-options endpoint. They are omitted when no corresponding asset has been configured.

Configure the assets on the transporter organization with the CHECKOUT_LOGO and CHECKOUT_ICON logo usages.

Cart Value And Discount Amount

For checkout.GetSkrymShippingOptions, provide:

• totalPrice as the cart value before discounts (smallest currency denomination).
• discountAmount optionally, if a discount should be applied.

Skrym computes the net cart value internally from these two fields for checkout.GetSkrymShippingOptions.
Do not send a separate netTotalPrice field for this endpoint.

For follow-up checkout calls that use checkoutmodels.CheckoutInput (for example reserve/finalize flows), always send totalPrice and optionally discountAmount.
Skrym derives netTotalPrice from:

• netTotalPrice = totalPrice - discountAmount when discountAmount is provided.
• netTotalPrice = totalPrice when no discount is provided.

Session ID

An important part of the Get Shipping Options API is the sessionId. This should be a unique identifier for the current session and should be provided by you. For example, if a user updates the cart or changes the delivery address, you should keep the same sessionId in all your calls to the Get Shipping Options endpoint. This ID is later used when reserving the delivery choice to identify the session.