latestOpenAPI 3.0.02026-08-101013821017.9 KB

4b69392f93b9

Access Tokens2

Address1

Addresses4

API Trigger Offer2

Apply or Detach Payment Methods3

Apply Shipping Option1

postApply shipping option to cart

Apply Shopper1

Billing Address3

Cart Offers4

Carts2

Categories3

Email Updater1

Financing1

Immediate Midterm Change1

Inventory Status2

Line Items8

Manage The Subscription1

Manage The The Subscription's Renewal Plan2

Offers8

Order1

Order Address2

Order Lookup1

Orders2

Payment2

Payment Methods1

Payment-Options4

Pending Action1

Price override3

Pricing1

Product Variations1

Products4

Purchase Plan1

Purchase Plan Authorize1

Purchase Plan Search1

Resume Cart1

Retrieve Subscription2

Returns2

Shipping Address3

Shipping Options2

Shoppers4

Submit Cart1

Tax Registration4

Third Party Subscription Engine Support1

Token3

Web Checkout2

Apply Shipping Option

Apply shipping option to cart

Sets the shipping method for a cart. The shopping cart must contain a physical product before you can apply shipping options to the cart.

post/v1/shoppers/me/carts/active/apply-shipping-option

Query parameters

tokenstring

Provide the authorized or anonymous token for a shopper.

shippingOptionIdstring

Provide the identifier of the shipping option chosen for the cart.

expandstring

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstring

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

Response

Successful response.