Orders from every connected store, newest first

GET

/api/v1/workspaces/{workspaceId}/orders

const url = 'https://api.crossmart.io/api/v1/workspaces/example/orders?status=OPEN&direction=desc&limit=25';
const options = {method: 'GET'};

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://api.crossmart.io/api/v1/workspaces/example/orders?status=OPEN&direction=desc&limit=25'

Orders hold no buyer details. Each line shows the stock it holds.

Parameters

Path Parameters

workspaceId

required

string

Query Parameters

status

string

Allowed values: OPEN PARTIALLY_FULFILLED FULFILLED CANCELLED

connectionId

string format: uuid

Orders of one store

search

string

Matches the order number

direction

string

Allowed values: asc desc

cursor

string format: uuid

nextCursor from the previous page

page

number

>= 1

1-based page number, for tables with page numbers. It wins over cursor.

limit

number

default: 25 >= 1 <= 100

Responses

200

application/json

object

items

required

Array<object>

object

required

string format: uuid

name

required

The number the merchant and buyer see

string

status

required

string

Allowed values: OPEN PARTIALLY_FULFILLED FULFILLED CANCELLED

currencyCode

required

string

total

required

What the buyer pays now

string

placedAt

required

string format: date-time

connectionId

required

string format: uuid

storeName

required

string

channel

required

string

itemCount

required

Units ordered, over every line

number

unmatchedLines

required

Lines that match no catalog variant, so their stock is not tracked

number

nextCursor

required

Null on the last page

string

nullable

total

required

How many match in all, for page numbers

number

Example

{
  "items": [
    {
      "name": "#1001",
      "status": "OPEN",
      "currencyCode": "USD",
      "total": "130.00",
      "storeName": "Demo Store",
      "channel": "shopify"
    }
  ]
}