Skip to content
Guides
ES
API reference
stable

Get checkout

Returns the current state of the checkout: which steps are complete, the totals and the payment methods the merchant has enabled. Poll it when the payment settles outside the storefront.

GET/v1/carts/{cartToken}/checkout

Returns the current state of the checkout: which steps are complete, the totals and the payment methods the merchant has enabled. Poll it when the payment settles outside the storefront.

Path Parameters

cartToken*string

Opaque token identifying the cart.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/carts/string/checkout"
{  "cart": {    "id": "string",    "token": "string",    "cartNumber": "string",    "email": null,    "phone": null,    "firstName": null,    "lastName": null,    "currencyCode": "string",    "status": "inProgress",    "completedAt": null,    "shippingAddress": null,    "billingAddress": null,    "promotionCodes": [      "string"    ],    "items": [      {        "id": "string",        "productId": null,        "title": "string",        "variantLabel": null,        "productHandle": null,        "thumbnail": null,        "quantity": 0,        "variantId": null,        "variantSku": null,        "unitPrice": 0.1,        "compareAtUnitPrice": null,        "bundleItems": [          {            "productId": "string",            "variantId": "string",            "productName": "string",            "variantName": null,            "sku": null,            "brand": null,            "imageUrl": null,            "quantity": 0          }        ],        "requiresShipping": true      }    ],    "shippingMethods": [      {        "id": "string",        "shippingMethodId": null,        "rateId": null,        "name": "string",        "description": null,        "total": 0.1,        "locationId": null,        "estimatedDays": null,        "pickupPointId": null,        "scheduledDate": null,        "scheduledTime": null,        "serviceCode": null,        "sellerId": null,        "shippingProfileId": null      }    ],    "totals": {      "subtotal": 0.1,      "discountTotal": 0.1,      "shippingOriginalTotal": 0.1,      "shippingTotal": 0.1,      "taxTotal": 0.1,      "warrantyTotal": 0.1,      "total": 0.1    }  },  "paymentMethods": {    "methods": [      {        "code": "string",        "name": "string",        "description": null,        "kind": "offline",        "isActive": true,        "isDefault": true,        "isManual": true,        "sortOrder": 0,        "phoneNumber": null,        "accountHolder": null,        "qrImageUrl": null,        "providerId": null      }    ]  },  "orderBumps": [    {      "id": "string",      "productId": "string",      "variantId": "string",      "productName": "string",      "variantName": null,      "imageUrl": null,      "currencyCode": "string",      "regularPrice": 0.1,      "offerPrice": 0.1,      "badgeLabel": null,      "callToAction": "string",      "description": null    }  ]}