cart.set_custom_fields
Set the checkout custom fields on the cart — the declared cart / cart_customer values. A bag you send REPLACES the stored one (a cart has a single writer); the store / customer / category setters merge by key instead. Anonymous (cart_id).
- Scope:
public - System: no
- Reachable from:
POST /v1/cart/commands/cart.set_custom_fields— an ANONYMOUS face:x-forge-storeis required, no credential is sent, and it is never on/v1/commands/*· MCP toolcart.set_custom_fields - Events: none — The cart is the shopper’s own session: it is read no-store on every checkout step, never from a cached entry, and it fires many times a minute. Nothing outside the checkout derives from these values until place_order freezes them onto the order.
Input (JSON Schema)
Section titled “Input (JSON Schema)”{ "properties": { "cart": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "cart_id": { "minLength": 1, "type": "string" }, "customer": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "cart_id" ], "type": "object"}Result (200)
Section titled “Result (200)”{ "additionalProperties": false, "properties": { "cart_id": { "type": "string" } }, "required": [ "cart_id" ], "type": "object"}Errors
Section titled “Errors”validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)