cart.set_custom_fields

Set the checkout custom fields on the cart — the declared cart / cart_customer values. Anonymous (cart_id).

• Scope: public
• System: no
• Reachable from: an ANONYMOUS face — no credential, and never /v1/commands/*. Which path serves it is not derivable from the registry; see the anonymous faces.
• 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)

{
  "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)

{
  "additionalProperties": false,
  "properties": {
    "cart_id": {
      "type": "string"
    }
  },
  "required": [
    "cart_id"
  ],
  "type": "object"
}

Errors

validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)