Get checkout

GET

/v1/{checkoutId}

curl --request GET \
  --url https://example.com/checkout/v1/example

Retrieves a checkout by its identifier, including the available delivery options.

Parameters

Path Parameters

checkoutId

required

string

Responses

200

OK

Media typeapplication/json

object

checkoutId

required

string

status

required

string

delivery

required

One of:

null

null

object

object

options

required

Array<object>

object

id

required

string

type

required

string

displayName

required

string

express

required

boolean

price

required

object

gross

required

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

net

required

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

vat

required

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

transporter

required

null | string

collectionPoint

required

One of:

null

null

object

object

id

required

string

name

required

string

addressLine

required

null | string

postCode

required

null | string

city

required

null | string

country

required

null | string

Example^generated

{
  "checkoutId": "example",
  "status": "example",
  "delivery": {
    "options": [
      {
        "id": "example",
        "type": "example",
        "displayName": "example",
        "express": true,
        "price": {
          "gross": 1,
          "net": 1,
          "vat": 1
        },
        "transporter": "example",
        "collectionPoint": {
          "id": "example",
          "name": "example",
          "addressLine": "example",
          "postCode": "example",
          "city": "example",
          "country": "example"
        }
      }
    ]
  }
}

400

Bad Request

Media typeapplication/json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

errors

required

Array<object>

object

fieldName

required

string

message

required

string

code

required

string

traceId

required

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "fieldName": "example",
      "message": "example"
    }
  ],
  "code": "example",
  "traceId": "example"
}

401

Unauthorized

Media typeapplication/json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

code

required

string

traceId

required

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

403

Forbidden

Media typeapplication/json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

code

required

string

traceId

required

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

404

Not Found

Media typeapplication/json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

code

required

string

traceId

required

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

500

Internal Server Error

Media typeapplication/json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

code

required

string

traceId

required

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}