GET /commerce/{accountId}/v2/checkouts/{checkoutId}
Bearer auth

Returns a checkout session by ID. This can be used to poll the status of a checkout session providing order placement details.

Path parameters

  • accountId string Required
  • checkoutId string Required

Responses

  • 200 application/json

    200

    One of:
    completed object pending payment object failed payment object
  • 400 application/json

    400

GET /commerce/{accountId}/v2/checkouts/{checkoutId} 
curl \
 --request GET 'https://api.staging.deliverect.com/commerce/{accountId}/v2/checkouts/{checkoutId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": "6643861d0c1914c93a846b78",
  "created": "2024-05-14T15:41:17.518000+00:00",
  "updated": "2024-05-14T15:41:18.449000+00:00",
  "deleted": false,
  "etag": "f225b232489659ed4dc0f17580f4f0200f4ca3ba",
  "accountId": "65c35d109a19b819b7cf78d8",
  "storeId": "65eee6a9984a1bc1b9637c59",
  "channelLinkId": "65eee6a9984a1bc1b9637c59",
  "status": "completed",
  "basket": {
    "currency": "EUR",
    "taxExclusive": false,
    "items": [
      {
        "menuId": "62d7f77f64c95193cc29aa91",
        "plu": "STK-01",
        "name": "Delicious Steak Frites",
        "quantity": 1,
        "price": 1500,
        "gross": 1500,
        "taxes": [],
        "net": 1500,
        "subItems": [],
        "discounts": [],
        "discountTotal": 0
      }
    ],
    "payment": {
      "tips": [
        {
          "amount": 100,
          "type": "restaurant"
        }
      ],
      "discountsTotal": 0,
      "taxTotal": 0,
      "tipTotal": 100,
      "total": 1600
    },
    "customer": {
      "name": "Test",
      "companyName": "Company LTDA",
      "phoneNumber": "12345",
      "email": "test@email.com",
      "tin": "123456789"
    },
    "fulfillment": {
      "type": "pickup"
    },
    "taxes": [],
    "discounts": []
  },
  "payment": {
    "id": "62d7f77f64c95193cc29aa91",
    "status": "authorized",
    "action": {
      "type": "redirect",
      "url": "http://payment.acme.com/1234"
    }
  },
  "order": {
    "channelOrderId": "6643861d0c1914c93a846b79",
    "channelOrderDisplayId": "01277571"
  }
}
{
  "id": "6643861d0c1914c93a846b78",
  "created": "2024-05-14T15:41:17.518000+00:00",
  "updated": "2024-05-14T15:41:18.449000+00:00",
  "deleted": false,
  "etag": "f225b232489659ed4dc0f17580f4f0200f4ca3ba",
  "accountId": "65c35d109a19b819b7cf78d8",
  "storeId": "65eee6a9984a1bc1b9637c59",
  "channelLinkId": "65eee6a9984a1bc1b9637c59",
  "status": "open",
  "basket": {
    "currency": "EUR",
    "taxExclusive": false,
    "items": [
      {
        "menuId": "62d7f77f64c95193cc29aa91",
        "plu": "STK-01",
        "name": "Delicious Steak Frites",
        "quantity": 1,
        "price": 1500,
        "gross": 1500,
        "taxes": [],
        "net": 1500,
        "subItems": [],
        "discounts": [],
        "discountTotal": 0
      }
    ],
    "payment": {
      "tips": [
        {
          "amount": 100,
          "type": "restaurant"
        }
      ],
      "discountsTotal": 0,
      "taxTotal": 0,
      "tipTotal": 100,
      "total": 1600
    },
    "customer": {
      "name": "Test",
      "companyName": "Company LTDA",
      "phoneNumber": "12345",
      "email": "test@email.com",
      "tin": "123456789"
    },
    "fulfillment": {
      "type": "pickup"
    },
    "taxes": [],
    "discounts": []
  },
  "payment": {
    "id": "62d7f77f64c95193cc29aa91",
    "status": "pending",
    "action": {
      "type": "redirect",
      "url": "http://payment.acme.com/1234"
    }
  },
  "order": null
}
{
  "id": "6643861d0c1914c93a846b78",
  "created": "2024-05-14T15:41:17.518000+00:00",
  "updated": "2024-05-14T15:41:18.449000+00:00",
  "deleted": false,
  "etag": "f225b232489659ed4dc0f17580f4f0200f4ca3ba",
  "accountId": "65c35d109a19b819b7cf78d8",
  "storeId": "65eee6a9984a1bc1b9637c59",
  "channelLinkId": "65eee6a9984a1bc1b9637c59",
  "status": "open",
  "basket": {
    "currency": "EUR",
    "taxExclusive": false,
    "items": [
      {
        "menuId": "62d7f77f64c95193cc29aa91",
        "plu": "STK-01",
        "name": "Delicious Steak Frites",
        "quantity": 1,
        "price": 1500,
        "gross": 1500,
        "taxes": [],
        "net": 1500,
        "subItems": [],
        "discounts": [],
        "discountTotal": 0
      }
    ],
    "payment": {
      "tips": [
        {
          "amount": 100,
          "type": "restaurant"
        }
      ],
      "discountsTotal": 0,
      "taxTotal": 0,
      "tipTotal": 100,
      "total": 1600
    },
    "customer": {
      "name": "Test",
      "companyName": "Company LTDA",
      "phoneNumber": "12345",
      "email": "test@email.com",
      "tin": "123456789"
    },
    "fulfillment": {
      "type": "pickup"
    },
    "taxes": [],
    "discounts": []
  },
  "payment": {
    "id": "62d7f77f64c95193cc29aa91",
    "status": "refused",
    "action": {
      "type": "redirect",
      "url": "http://payment.acme.com/1234"
    }
  },
  "order": null
}
{
  "id": "6643861d0c1914c93a846b78",
  "created": "2024-05-14T15:41:17.518000+00:00",
  "updated": "2024-05-14T15:41:18.449000+00:00",
  "deleted": false,
  "etag": "f225b232489659ed4dc0f17580f4f0200f4ca3ba",
  "accountId": "65c35d109a19b819b7cf78d8",
  "storeId": "65eee6a9984a1bc1b9637c59",
  "channelLinkId": "65eee6a9984a1bc1b9637c59",
  "status": "failed",
  "basket": {
    "currency": "EUR",
    "taxExclusive": false,
    "items": [
      {
        "menuId": "62d7f77f64c95193cc29aa91",
        "plu": "STK-01",
        "name": "Delicious Steak Frites",
        "quantity": 1,
        "price": 1500,
        "gross": 1500,
        "taxes": [],
        "net": 1500,
        "subItems": [],
        "discounts": [],
        "discountTotal": 0
      }
    ],
    "payment": {
      "tips": [
        {
          "amount": 100,
          "type": "restaurant"
        }
      ],
      "discountsTotal": 0,
      "taxTotal": 0,
      "tipTotal": 100,
      "total": 1600
    },
    "customer": {
      "name": "Test",
      "companyName": "Company LTDA",
      "phoneNumber": "12345",
      "email": "test@email.com",
      "tin": "123456789"
    },
    "fulfillment": {
      "type": "pickup"
    },
    "taxes": [],
    "discounts": []
  },
  "payment": {
    "id": "62d7f77f64c95193cc29aa91",
    "status": "failed",
    "action": null
  },
  "order": null
}
Response examples (400) 
{
  "value": ""
}