Get Orders

get https://v1/orders

Return a list of orders

Responses

Response body

object

data

array of objects

required

data*

object

fulfillments

array of objects

required

fulfillments*

object

shipments

array of objects

required

shipments*

object

shipmentVariants

array of objects

required

shipmentVariants*

object

variant

string

required

quantity

double

required

shippingDate

date-time

required

trackingUrl

string

required

trackingNumber

string

required

carrierReferenceId

string

required

carrierDisplay

string

required

carrier

string

required

ups fedex usps na lso ontrac lasershipv2 adhoc_manual ahamove ninjavan delyva amazon cdl veho druglift

deliveryInstructions

string

required

deliveryEta

string

required

externalOrderStatus

string

required

externalOrderId

string

required

statusHistory

array of objects

required

statusHistory*

object

updatedAt

date-time

required

status

string

required

order_placed received_by_fulfiller in_transit delivered cancelled

status

string

required

order_placed received_by_fulfiller in_transit delivered cancelled

timeWindow

object

required

fulfillmentVariants

array of objects

required

fulfillmentVariants*

object

variant

string

required

quantity

double

required

fulfillerLocation

string

required

fulfillmentMethod

string

required

carrier_delivery local_delivery in_store_pickup electronic none

createdAt

date-time

required

string

required

orderVariants

array of objects

required

orderVariants*

object

variant

object

required

fulfilledQuantity

double

required

quantity

double

required

string

required

shippingAddress

object

required

user

object

required

financialStatus

string

required

created authorized submitted_for_settlement settled voided error authorization_expired no_transaction settlement_declined pending authorization_unsuccessful deferred needs_remediation

statusHistory

array of objects

required

statusHistory*

object

updatedAt

date-time

required

status

string

required

created on_fulfillment_queue on_fraud_queue sent_to_fulfiller completed cancelled error

status

string

required

created on_fulfillment_queue on_fraud_queue sent_to_fulfiller completed cancelled error

createdAt

date-time

required

orderNo

double

required

string

required

message

string

required

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://v1/orders \
3
     --header 'accept: application/json'


xxxxxxxxxx
94
}
1
{
2
  "data": [
3
    {
4
      "fulfillments": [
5
        {
6
          "shipments": [
7
            {
8
              "shipmentVariants": [
9
                {
10
                  "variant": "string",
11
                  "quantity": 0
12
                }
13
              ],
14
              "shippingDate": "2025-04-03T22:33:18.003Z",
15
              "trackingUrl": "string",
16
              "trackingNumber": "string",
17
              "carrierReferenceId": "string",
18
              "carrierDisplay": "string",
19
              "carrier": "ups"
20
            }
21
          ],
22
          "deliveryInstructions": "string",
23
          "deliveryEta": "string",
24
          "externalOrderStatus": "string",
25
          "externalOrderId": "string",

200Ok

422Validation Failed