Change cart settings

post

https://apis.kentro.live/store/v1/cart.update

Changes the cart's settings: fulfillment method and location, shipping and billing addresses (shipToId, billToId), payment method (paymentId; "new-card" to enter one at checkout), carrier account, shipping rate, coupon or referral code, store credit (useCredits, creditsDecision), purchase order number, note, requested date, subscription plan and frequency. Send only the fields that change. Any change invalidates the quote: read cart.get { quote: true } again before checkout.

Who may call it: A guest (X-Storefront-Guest), or a signed-in buyer (X-Storefront-Buyer) whose account is confirmed; an unconfirmed buyer is refused with 403 CONFIRMATION_REQUIRED.

Revision. Send expectedRevision, the revision of the cart you last received (cart.get or the previous write). The cart is written only when it still matches; otherwise the answer is 409 and you reload the cart before retrying. ownershipVersion, from the cart, pins the cart a guest or a claim acts on. A successful write answers the whole cart with its new revision.

Body Params

expectedRevision

integer

required

≥ 0

ownershipVersion

string

^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$

fulfillment

enum

locationId

^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$

searchLocation

object | null

lineLocations

object

shipToId

^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$

billToId

^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$

paymentId

string

carrierId

^(?:[a-fA-F0-9]{24}|[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12})$

shippingRateId

length ≤ 255

coupon

string

length ≤ 100

referralCode

string

length ≤ 100

useCredits

boolean

creditsDecision

enum

adoptionNoticeDismissed

boolean

enum

Allowed:

purchaseOrder

string

length ≤ 255

notes

string

length ≤ 4000

requestedDate

string

length ≤ 32

subscriptionInterval

string

enum

Allowed:

subscriptionPlanId

^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$

selectedFrequency

Schema_7fd65b4d2b | null

Headers

X-Storefront-Host

string

required

length between 1 and 253

The published storefront host the request serves (shop.example.com, lower case). It must belong to the tenant of the API key; 404 NOT_FOUND when no published storefront answers it, 403 FORBIDDEN when it belongs to another account.

X-Storefront-Buyer

string

The signed-in buyer's access token (accessToken from POST https://apis.kentro.live/auth/login/customer). Absent for a guest or an anonymous visitor.

X-Storefront-Guest

string

The guest token session.guest answered, which identifies a guest cart and a guest checkout. Send it along with X-Storefront-Buyer at sign-in so the buyer can choose between the guest cart and the account cart.

X-Storefront-Client-Ip

string

The end buyer's IP address as your storefront server saw it. Used for per-visitor limits (search typeahead, sign-up); without it the limits apply to your server.

X-Expected-Portal

string

The store id (store.get answers id) your page was rendered for. When the host now resolves to another store the answer is 409 CONFLICT, so a stale page never acts on the wrong store.

X-Expected-Buyer

string

The identity your page was rendered for: the buyer id, guest:<guestId> for a guest, or guest for an anonymous visitor. A mismatch with the tokens sent is 409 CONFLICT, so a stale page never acts for the wrong buyer.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The cart after the change.

defaultThe request was refused or could not be completed; the status says why (400 validation, 401 sign-in needed, 403 not allowed, 404 unknown, 409 stale revision or version, 422 commerce rule, 429 too many, 503 unavailable).