Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

storeId
string
required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

checkoutExperienceId
string
required

Checkout experience ID.

Example:

"66b2f1c9e4b0a1d2c3f4a5b6"

Body

application/json

Only the fields you send are changed.

name
string

New merchant-facing name. Must not be blank.

Example:

"Holiday rates"

addLandedCosts
boolean

Add landed costs (duties and import fees) to every shipping method's price in this experience. Enabling it fails if a method uses a carrier service that does not support landed cost calculation.

fulfillmentDelayDaysOverride
integer | null

Days of fulfillment delay to assume for delivery estimates across this experience, overriding the store-level value. A whole number of days, zero or more. Send null to remove the override so the store-level value applies again.

Required range: x >= 0
Example:

2

Response

Updated

checkoutExperienceId
string
required

The checkout experience that was written. Read it back with GET /stores/{storeId}/checkout-experiences/{checkoutExperienceId}.

Example:

"66b2f1c9e4b0a1d2c3f4a5b6"