List checkouts

GET

/api/v1/commerce/checkouts

const url = 'https://digize.com/api/v1/commerce/checkouts';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://digize.com/api/v1/commerce/checkouts \
  --header 'x-api-key: <x-api-key>'

Up to 1,000 checkouts, the newest first: open ones holding stock, completed ones and the order they became, and expired ones with how their reminder went.

Needs the commerce:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

object

rows

required

Array<object>

object

required

string

sessionId

required

string

customer

required

Any of:

object
null

object

required

string

name

required

string

email

required

string

lines

required

Array<object>

object

productId

required

string

variantId

required

string

name

required

string

variant

required

string

sku

required

string

quantity

required

number

price

required

number

discount

required

number

taxable

required

boolean

requiresShipping

required

boolean

reserved

required

number

imageId

required

string | null

total

required

number

status

required

string

Allowed values: open completed expired

startedAt

required

string format: date-time

expiresAt

required

string format: date-time

completedAt

required

Any of:

string
null

string format: date-time

orderNumber

required

number | null

reminder

required

Any of:

string
null

string

Allowed values: scheduled sent skipped opened clicked purchased

recoveryUrl

required

string

total

required

number

Example

{
  "rows": [
    {
      "status": "open",
      "reminder": "scheduled"
    }
  ]
}

400

What was sent isn’t valid (invalid).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}