One order with its lines and the stock each holds

GET

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

const url = 'https://api.crossmart.io/api/v1/workspaces/example/orders/example';
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/example

Parameters

Path Parameters

workspaceId

required

string

orderId

required

string

Responses

200

application/json

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

externalId

required

The order’s id on its channel

string

lines

required

Array<object>

object

required

string format: uuid

title

required

string

sku

required

string

nullable

quantity

required

number

unitPrice

required

string

reservedQuantity

required

Units held for the order until they ship

number

fulfilledQuantity

required

Units shipped

number

variantId

required

string format: uuid

nullable

productId

required

string format: uuid

nullable

Example

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