Order query

Order query

POST /api-order/orders/query

Order query

cURL

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/query \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "offset": 0,
  "limit": 10,
  "sortBy": "createdAt",
  "sortDirection": "desc",
  "filters": {
    "status": [
      "ORDER_CREATED",
      "ORDER_PAYMENT_AUTHORIZED"
    ],
    "date": {
      "gte": "2020-11-01T18:12:03.412Z",
      "lte": "2022-12-03T18:12:03.412Z"
    },
    "orderTotal": {},
    "totalQuantity": {},
    "attributes": [
      {
        "attributeId": "60119337cb662800075717f8",
        "value": "blue"
      }
    ],
    "customerUserId": [
      "<string>"
    ],
    "customerEmail": [
      "<string>"
    ],
    "shipTo": [
      {
        "address": {
          "name": {
            "first": "Mark",
            "middle": "p",
            "last": "styler"
          },
          "phone": {
            "number": "555-555-5555",
            "kind": "mobile"
          },
          "isValidated": false,
          "email": "[e-mail]",
          "street1": "10400 NE 4th St",
          "street2": "Suite 500",
          "city": "Bellevue",
          "state": "WA",
          "country": "USA",
          "zipCode": "98004",
          "kind": "Ship to address"
        },
        "delivery": {
          "actual": "<string>"
        },
        "shipping": {
          "actual": "<string>"
        },
        "promosApplied": [
          {
            "name": "test1"
          }
        ],
        "_id": "602c1511fcc5e900078ba4af",
        "shipToId": 1000001,
        "shipToType": "SHIP_TO_ADDRESS",
        "price": 24.87,
        "currency": "USD",
        "estimatedTax": 10,
        "committedTax": 10,
        "total": 34.87,
        "taxCode": "FR020000",
        "shipmentCarrier": "Fedex",
        "shipmentMethod": "Express",
        "shipmentMethodId": "10000001",
        "promisedDeliveryDate": "2021-02-14T00:00:00.000Z",
        "shipmentInstructions": "Leave at back door",
        "shipmentStatus": "Delivered",
        "readyForPickups": "<array>",
        "id": "602c1511fcc5e900078ba4af"
      }
    ]
  }
}
'

200

{
  "query": {
    "limit": 2,
    "offset": 0,
    "count": 6,
    "orderTotalSum": 13543.5,
    "orderAverage": 2257.25,
    "totalQuantitySum": 82,
    "statusCounts": {
      "ORDER_CREATED": 0,
      "ORDER_CONFIRMED": 0,
      "ORDER_CANCELLED": 0,
      "ORDER_PARTIALLY_SHIPPED": 0,
      "ORDER_SHIPPED": 0,
      "ORDER_PARTIALLY_DELIVERED": 0,
      "ORDER_DELIVERED": 0,
      "ORDER_RETURNED": 0,
      "ORDER_PARTIALLY_RETURNED": 0,
      "ORDER_PAYMENT_AUTHORIZED": 0,
      "ORDER_PAYMENT_INVALID": 0,
      "ORDER_FULFILLED": 0,
      "ORDER_PARTIALLY_FULFILLED": 0,
      "ORDER_REFUNDED": 6
    },
    "paymentStatusCounts": {
      "succeeded": 3
    }
  },
  "orders": [
    {
      "_id": "608c8f995cc215000848a8e0",
      "tags": "<array>",
      "cartId": "608c8c9e79f00c00080fbacc",
      "attributes": "<array>",
      "customerEmail": "[e-mail]",
      "orderCurrency": "USD",
      "orderTotal": 950.5,
      "taxTotal": 2.5,
      "channel": 12,
      "status": "ORDER_REFUNDED",
      "statusLog": "Order has been shipped",
      "orderReference": "9975-7559-14446",
      "orderId": "2660-5356-89773",
      "shipTo": [
        {
          "pickupPerson": {
            "name": {
              "first": "John",
              "last": "Doe"
            },
            "phone": {
              "number": 8087769338,
              "kind": "Mobile"
            },
            "email": "[e-mail]"
          },
          "altPickupPerson": {
            "name": {
              "first": "first",
              "last": "last"
            },
            "phone": {
              "number": 8087769338,
              "kind": "Mobile"
            },
            "email": "[e-mail]"
          },
          "promosApplied": "<array>",
          "_id": "608c8d2f798c0900083f60ee",
          "shipToType": "BOPIS",
          "taxCode": "FR1000",
          "shipToId": 978,
          "price": 0,
          "currency": null,
          "shipmentMethodId": null,
          "estimatedTax": 0,
          "shipmentCarrier": null,
          "shipmentMethod": null,
          "total": 0,
          "id": "608c8d2f798c0900083f60ee"
        }
      ],
      "items": [
        {
          "group": [
            1.2312312312312322e+23
          ],
          "promosApplied": "<array>",
          "_id": "608c8cd679f00c00080fbace",
          "price": 900,
          "weightUnit": "lb",
          "isPickup": true,
          "itemId": 1000000051,
          "quantity": 1,
          "priceListId": 100269,
          "sku": 1538910,
          "taxCode": "PH060771",
          "title": "Luminous Cushion Lagoon",
          "weight": 1,
          "lineItemId": 1,
          "attributeTotalPrice": 0,
          "attributes": "<array>",
          "warehouseId": "605d0c47c87d0e0008a3b5a8",
          "currency": "USD",
          "shipToId": 978,
          "discount": 0,
          "estimatedTax": 1,
          "total": 901,
          "reservedLocation": [
            {
              "_id": "608c8f9de4b526000842505f",
              "warehouseId": "605d0c47c87d0e0008a3b5a8",
              "quantity": 1,
              "id": "608c8f9de4b526000842505f"
            }
          ],
          "id": "608c8cd679f00c00080fbace"
        }
      ],
      "shipments": [
        {
          "_id": "60936b987d5a2f0008e8bea6",
          "shippedDate": "2021-05-06T04:07:47.654Z",
          "shipToId": 978,
          "shipmentCarrier": "USPS",
          "shipmentCarrierUrl": "https://tools.usps.com/go/TrackConfirmAction?tRef=fullpage&tLc=2&text28777=&tLabels=65765798989",
          "trackingNumber": 65765798989,
          "lineItems": [
            {
              "_id": "60936b987d5a2f0008e8bea7",
              "lineItemId": 1,
              "quantity": 1,
              "id": "60936b987d5a2f0008e8bea7"
            }
          ],
          "shipmentStatus": "ORDER_SHIPPED",
          "id": "60936b987d5a2f0008e8bea6"
        }
      ],
      "revision": 2,
      "totalQuantity": 2,
      "statusDescriptions": "<array>",
      "events": "<array>",
      "createdAt": "2021-04-30T23:15:37.094Z",
      "updatedAt": "2021-05-06T04:09:09.970Z",
      "__v": 0
    }
  ]
}

Headers

x-api-key · string

Example:

"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

x-site-context · string · required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json

offset · integer · default: 0

Required range: x >= 0

limit · integer · default: 10

Required range: 1 <= x <= 500

sortBy · enum<string> · default: createdAt

Available options: createdAt, orderTotal, totalQuantity, status

sortDirection · enum<string> · default: desc

Available options: asc, desc

filters · object

Show child attributes

filters. status · enum<string>[]

Available options: ORDER_CREATED, ORDER_CONFIRMED, ORDER_CANCELLED, ORDER_PARTIALLY_SHIPPED, ORDER_SHIPPED, ORDER_PARTIALLY_DELIVERED, ORDER_DELIVERED, ORDER_RETURNED, ORDER_PARTIALLY_RETURNED, ORDER_PAYMENT_AUTHORIZED, ORDER_PAYMENT_INVALID, ORDER_FULFILLED, ORDER_PARTIALLY_FULFILLED, ORDER_REFUNDED

Example:

["ORDER_CREATED", "ORDER_PAYMENT_AUTHORIZED"]

filters. date · Date · object

Show child attributes

filters.date. gte · string

filters.date. lte · string

Example:

{
  "gte": "2020-11-01T18:12:03.412Z",
  "lte": "2022-12-03T18:12:03.412Z"
}

filters. orderTotal · object

filters. totalQuantity · object

filters. attributes · object[]

Show child attributes

filters.attributes. attributeId · string

Example:

"60119337cb662800075717f8"

filters.attributes. value · string

Example:

"blue"

filters. customerUserId · string[]

filters. customerEmail · string[]

filters. shipTo · object[]

Show child attributes

filters.shipTo. address · object

Show child attributes

filters.shipTo.address. name · object

Show child attributes

filters.shipTo.address.name. first · string

Example:

"Mark"

filters.shipTo.address.name. middle · string

Example:

"p"

filters.shipTo.address.name. last · string

Example:

"styler"

filters.shipTo.address. phone · object

Show child attributes

filters.shipTo.address.phone. number · string

Example:

"555-555-5555"

filters.shipTo.address.phone. kind · string

Example:

"mobile"

filters.shipTo.address. isValidated · boolean

Example:

false

filters.shipTo.address. email · string

Example:

"[e-mail]"

filters.shipTo.address. street1 · string

Example:

"10400 NE 4th St"

filters.shipTo.address. street2 · string

Example:

"Suite 500"

filters.shipTo.address. city · string

Example:

"Bellevue"

filters.shipTo.address. state · string

Example:

"WA"

filters.shipTo.address. country · string

Example:

"USA"

filters.shipTo.address. zipCode · string

Example:

"98004"

filters.shipTo.address. kind · string

Example:

"Ship to address"

filters.shipTo. delivery · object

Show child attributes

filters.shipTo.delivery. actual · string

filters.shipTo. shipping · object

Show child attributes

filters.shipTo.shipping. actual · string

filters.shipTo. promosApplied · object[]

Show child attributes

filters.shipTo.promosApplied. name · string

Example:

"test1"

filters.shipTo. _id · string

Example:

"602c1511fcc5e900078ba4af"

filters.shipTo. shipToId · number

Example:

1000001

filters.shipTo. shipToType · string

Example:

"SHIP_TO_ADDRESS"

filters.shipTo. price · number

Example:

24.87

filters.shipTo. currency · string

Example:

"USD"

filters.shipTo. estimatedTax · number

Example:

10

filters.shipTo. committedTax · number

Example:

10

filters.shipTo. total · number

Example:

34.87

filters.shipTo. taxCode · string

Example:

"FR020000"

filters.shipTo. shipmentCarrier · string

Example:

"Fedex"

filters.shipTo. shipmentMethod · string

Example:

"Express"

filters.shipTo. shipmentMethodId · string

Example:

"10000001"

filters.shipTo. promisedDeliveryDate · string

Example:

"2021-02-14T00:00:00.000Z"

filters.shipTo. shipmentInstructions · string

Example:

"Leave at back door"

filters.shipTo. shipmentStatus · string

Example:

"Delivered"

filters.shipTo. readyForPickups · array

filters.shipTo. id · string

Example:

"602c1511fcc5e900078ba4af"

Response

200

application/json

Returned orders

query · object

Show child attributes

query. limit · number

Example:

2

query. offset · number

Example:

0

query. count · number

Example:

6

query. orderTotalSum · number

Example:

13543.5

query. orderAverage · number

Example:

2257.25

query. totalQuantitySum · number

Example:

82

query. statusCounts · object

Show child attributes

query.statusCounts. ORDER_CREATED · number

Example:

0

query.statusCounts. ORDER_CONFIRMED · number

Example:

0

query.statusCounts. ORDER_CANCELLED · number

Example:

0

query.statusCounts. ORDER_PARTIALLY_SHIPPED · number

Example:

0

query.statusCounts. ORDER_SHIPPED · number

Example:

0

query.statusCounts. ORDER_PARTIALLY_DELIVERED · number

Example:

0

query.statusCounts. ORDER_DELIVERED · number

Example:

0

query.statusCounts. ORDER_RETURNED · number

Example:

0

query.statusCounts. ORDER_PARTIALLY_RETURNED · number

Example:

0

query.statusCounts. ORDER_PAYMENT_AUTHORIZED · number

Example:

0

query.statusCounts. ORDER_PAYMENT_INVALID · number

Example:

0

query.statusCounts. ORDER_FULFILLED · number

Example:

0

query.statusCounts. ORDER_PARTIALLY_FULFILLED · number

Example:

0

query.statusCounts. ORDER_REFUNDED · number

Example:

6

query. paymentStatusCounts · object

Show child attributes

query.paymentStatusCounts. succeeded · number

Example:

3

orders · object[]

Show child attributes

orders. _id · string

Example:

"608c8f995cc215000848a8e0"

orders. tags · array

orders. cartId · string

Example:

"608c8c9e79f00c00080fbacc"

orders. attributes · array

orders. customerEmail · string

Example:

"[e-mail]"

orders. orderCurrency · string

Example:

"USD"

orders. orderTotal · number

Example:

950.5

orders. taxTotal · number

Example:

2.5

orders. channel · number

Example:

12

orders. status · string

Example:

"ORDER_REFUNDED"

orders. statusLog · string

Example:

"Order has been shipped"

orders. orderReference · string

Example:

"9975-7559-14446"

orders. orderId · string

Example:

"2660-5356-89773"

orders. shipTo · object[]

Show child attributes

orders.shipTo. pickupPerson · object

Show child attributes

orders.shipTo.pickupPerson. name · object

Show child attributes

orders.shipTo.pickupPerson.name. first · string

Example:

"John"

orders.shipTo.pickupPerson.name. last · string

Example:

"Doe"

orders.shipTo.pickupPerson. phone · object

Show child attributes

orders.shipTo.pickupPerson.phone. number · string

Example:

8087769338

orders.shipTo.pickupPerson.phone. kind · string

Example:

"Mobile"

orders.shipTo.pickupPerson. email · string

Example:

"[e-mail]"

orders.shipTo. altPickupPerson · object

Show child attributes

orders.shipTo.altPickupPerson. name · object

Show child attributes

orders.shipTo.altPickupPerson.name. first · string

Example:

"first"

orders.shipTo.altPickupPerson.name. last · string

Example:

"last"

orders.shipTo.altPickupPerson. phone · object

Show child attributes

orders.shipTo.altPickupPerson.phone. number · string

Example:

8087769338

orders.shipTo.altPickupPerson.phone. kind · string

Example:

"Mobile"

orders.shipTo.altPickupPerson. email · string

Example:

"[e-mail]"

orders.shipTo. promosApplied · array

orders.shipTo. _id · string

Example:

"608c8d2f798c0900083f60ee"

orders.shipTo. shipToType · string

Example:

"BOPIS"

orders.shipTo. taxCode · string

Example:

"FR1000"

orders.shipTo. shipToId · number

Example:

978

orders.shipTo. price · number

Example:

0

orders.shipTo. currency · string

Example:

null

orders.shipTo. shipmentMethodId · string

Example:

null

orders.shipTo. estimatedTax · number

Example:

0

orders.shipTo. shipmentCarrier · string

Example:

null

orders.shipTo. shipmentMethod · string

Example:

null

orders.shipTo. total · number

Example:

0

orders.shipTo. id · string

Example:

"608c8d2f798c0900083f60ee"

orders. items · object[]

Show child attributes

orders.items. group · string[]

orders.items. promosApplied · array

orders.items. _id · string

Example:

"608c8cd679f00c00080fbace"

orders.items. price · number

Example:

900

orders.items. weightUnit · string

Example:

"lb"

orders.items. isPickup · boolean

orders.items. itemId · number

Example:

1000000051

orders.items. quantity · number

Example:

1

orders.items. priceListId · number

Example:

100269

orders.items. sku · string

Example:

1538910

orders.items. taxCode · string

Example:

"PH060771"

orders.items. title · string

Example:

"Luminous Cushion Lagoon"

orders.items. weight · number

Example:

1

orders.items. lineItemId · number

Example:

1

orders.items. attributeTotalPrice · number

Example:

0

orders.items. attributes · array

orders.items. warehouseId · string

Example:

"605d0c47c87d0e0008a3b5a8"

orders.items. currency · string

Example:

"USD"

orders.items. shipToId · number

Example:

978

orders.items. discount · number

Example:

0

orders.items. estimatedTax · number

Example:

1

orders.items. total · number

Example:

901

orders.items. reservedLocation · object[]

Show child attributes

orders.items.reservedLocation. _id · string

Example:

"608c8f9de4b526000842505f"

orders.items.reservedLocation. warehouseId · string

Example:

"605d0c47c87d0e0008a3b5a8"

orders.items.reservedLocation. quantity · number

Example:

1

orders.items.reservedLocation. id · string

Example:

"608c8f9de4b526000842505f"

orders.items. id · string

Example:

"608c8cd679f00c00080fbace"

orders. shipments · object[]

Show child attributes

orders.shipments. _id · string

Example:

"60936b987d5a2f0008e8bea6"

orders.shipments. shippedDate · string

Example:

"2021-05-06T04:07:47.654Z"

orders.shipments. shipToId · number

Example:

978

orders.shipments. shipmentCarrier · string

Example:

"USPS"

orders.shipments. shipmentCarrierUrl · string

Example:

"https://tools.usps.com/go/TrackConfirmAction?tRef=fullpage&tLc=2&text28777=&tLabels=65765798989"

orders.shipments. trackingNumber · string

Example:

65765798989

orders.shipments. lineItems · object[]

Show child attributes

orders.shipments.lineItems. _id · string

Example:

"60936b987d5a2f0008e8bea7"

orders.shipments.lineItems. lineItemId · number

Example:

1

orders.shipments.lineItems. quantity · number

Example:

1

orders.shipments.lineItems. id · string

Example:

"60936b987d5a2f0008e8bea7"

orders.shipments. shipmentStatus · string

Example:

"ORDER_SHIPPED"

orders.shipments. id · string

Example:

"60936b987d5a2f0008e8bea6"

orders. revision · number

Example:

2

orders. totalQuantity · number

Example:

2

orders. statusDescriptions · array

orders. events · array

orders. createdAt · string

Example:

"2021-04-30T23:15:37.094Z"

orders. updatedAt · string

Example:

"2021-05-06T04:09:09.970Z"

orders. __v · number

Example:

0