7min

Retrieve and Apply Shipping Methods

Shipping methods are required for merchants to determine how to deliver the order to the shopper. Shipping methods are chosen by the shopper.

ο»ΏGET /checkout/cart/{cart_id}/shipping/available

Retrieve a list of all possible shipping methods for a cart. API Reference: Get Available Shipping Methods

Request

cart_id - the ID of the cart the shipping methods are being retrieved for

This action should only be performed after the items have been added to the cart and a shipping address has been applied as this information may impact the pricing of the shipping methods.

Curl
|

Response

JSON
|

ο»Ώο»Ώο»Ώ

ο»ΏPOST /checkout/cart/{cart_id}/shipping/available

Once the desired shipping method(s) have been selected they can be applied to the cart. API Reference: Set Shipping Methods

Request

cart_id - the ID of the cart the shipping method is being applied to

Each bag in a cart will require its own shipping method. For this reason data is passed in as a collection of shipping methods, one for each bag. If you only have one bag in your cart you will pass in a collection consisting of one shipping method.

Required Body Parameters (for each bag):

bag_id - the ID of the bag this shipping method applies to. shipping_method_id - the ID of the selected shipping method.

Curl
|

Response

JSON
|

ο»Ώ

Updated 13 May 2022
Did this page help you?
Yes
No