Skip to content

Read checkout

Reads one of the customer's checkouts.

Needs the read scope.

Call

  • Tool: get_checkout
  • Scope: read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
checkout object Yes
{
  "type": "object",
  "properties": {
    "checkout": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "checkout"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
status string Yes
order object or null Yes
under_minimum object or null Yes
refund_consent string or null Yes
card_required object or null Yes
items array of object Yes
totals object Yes
id string Yes
currency string Yes
exponent number or null Yes
coupon string or null Yes
refund_waiver object or null Yes
expires_at string or null Yes
created_at string or null Yes
updated_at string or null Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close