Page through orders

GET

/api/v1/commerce/orders/page

const url = 'https://digize.com/api/v1/commerce/orders/page';
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/orders/page \
  --header 'x-api-key: <x-api-key>'

A page of orders, the newest first, with how many match in all. Narrow it by customer (contactId), payment status, fulfillment, when it was placed, or a search for an order number or words in the customer’s name or email. Pass nextCursor back as cursor for the next page; orders placed in between don’t shift the pages.

Needs the commerce:read permission.

Authorizations

apiKey
bearer

Parameters

Query Parameters

contactId

string

>= 1 characters <= 64 characters

search

string

<= 200 characters

status

Array<string>

Allowed values: paid partially_refunded refunded disputed

fulfillment

Array<string>

Allowed values: unfulfilled fulfilled not_required

placedFrom

string format: date-time

placedTo

string format: date-time

cursor

The nextCursor of the page before. Leave it out for the first page.

string

<= 400 characters

The nextCursor of the page before. Leave it out for the first page.

limit

Rows on the page: 50 unless it says, 100 at most.

integer

>= 1 <= 100

Rows on the page: 50 unless it says, 100 at most.

Responses

200

Done

application/json

object

rows

required

Array<object>

object

required

string

number

required

number

customer

required

object

required

string

name

required

string

email

required

string

status

required

string

Allowed values: paid partially_refunded refunded disputed

fulfillment

required

string

Allowed values: unfulfilled fulfilled not_required

channel

required

string

Allowed values: storefront subscription checkout_link

currency

required

string

lines

required

Array<object>

object

required

string

productId

required

string

variantId

required

string

name

required

string

variant

required

string

sku

required

string

quantity

required

number

price

required

number

fulfilled

required

number

refunded

required

number

subtotal

required

number

discount

required

number

discountCode

required

string | null

shipping

required

number

shippingName

required

string | null

tax

required

number

taxName

required

string

taxIncluded

required

boolean

total

required

number

giftCard

required

What a gift card paid of the total.

number

refunded

required

number

checkoutId

required

string

paymentId

required

The Stripe PaymentIntent, when Stripe was paid.

string

placedAt

required

string format: date-time

fulfilledAt

required

Any of:

string
null

string format: date-time

refundedAt

required

Any of:

string
null

string format: date-time

cancelledAt

required

Any of:

string
null

string format: date-time

phone

required

string

shippingAddress

required

Any of:

object
null

object

name

required

string

line1

required

string

line2

required

string | null

city

required

string

zip

required

string

country

required

string

tracking

required

Any of:

object
null

object

carrier

required

string

number

required

string | null

url

required

string | null

note

required

string

tags

required

Array<string>

attention

required

Something the team needs to look at.

string | null

receipt

required

Unreceipted: no sending domain yet, so only Stripe’s receipt went.

string

Allowed values: queued unreceipted not_sent

nextCursor

required

Pass it as cursor for the next page; null on the last.

string | null

total

required

number

Example

{
  "rows": [
    {
      "status": "paid",
      "fulfillment": "unfulfilled",
      "channel": "storefront",
      "receipt": "queued"
    }
  ]
}

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"
  }
}