Get order by user

curl --request GET \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user \
  --header 'Authorization: <authorization>' \
  --header 'x-site-context: <x-site-context>'

{
  "query": {
    "limit": 2,
    "offset": 0,
    "count": 19,
    "orderTotalSum": 31719.46,
    "orderAverage": 1669.45,
    "totalQuantitySum": 132,
    "statusCounts": {
      "ORDER_CREATED": 13,
      "ORDER_CONFIRMED": 0,
      "ORDER_CANCELLED": 1,
      "ORDER_PARTIALLY_SHIPPED": 0,
      "ORDER_SHIPPED": 2,
      "ORDER_PARTIALLY_DELIVERED": 0,
      "ORDER_DELIVERED": 0,
      "ORDER_RETURNED": 0,
      "ORDER_PARTIALLY_RETURNED": 0,
      "ORDER_PAYMENT_AUTHORIZED": 2,
      "ORDER_PAYMENT_INVALID": 0,
      "ORDER_FULFILLED": 0,
      "ORDER_PARTIALLY_FULFILLED": 1
    }
  },
  "orders": [
    {
      "_id": "60ca5d3dc0fac00008e64c91",
      "tags": "<array>",
      "cartId": "60ca5b6ae3b5d900081ae44a",
      "customerUserId": "60c128045a38bf0009ad6502",
      "attributes": "<array>",
      "customerEmail": "[email protected]",
      "orderCurrency": "USD",
      "orderTotal": 90.5,
      "taxTotal": 0.5,
      "channel": 12,
      "status": "ORDER_CREATED",
      "statusLog": "Order has been created",
      "orderReference": "1635-8532-92190",
      "orderId": "8677-7648-19307",
      "shipTo": [
        {
          "pickupPerson": {
            "name": {
              "first": "John",
              "last": "Doe"
            },
            "phone": {
              "number": 8087769338,
              "kind": "Mobile"
            },
            "email": "[email protected]"
          },
          "altPickupPerson": {
            "name": {
              "first": "first",
              "last": "last"
            },
            "phone": {
              "number": 8087769338,
              "kind": "Mobile"
            },
            "email": "[email protected]"
          },
          "promosApplied": "<array>",
          "_id": "60ca5c1c9f490e0008020b28",
          "shipToType": "BOPIS",
          "taxCode": "FR1000",
          "shipToId": 390,
          "price": 0,
          "currency": null,
          "shipmentMethodId": null,
          "estimatedTax": 0.5,
          "shipmentCarrier": null,
          "shipmentMethod": null,
          "total": 0.5,
          "id": "60ca5c1c9f490e0008020b28"
        }
      ],
      "items": [
        {
          "group": [
            1.2312312312312322e+23
          ],
          "promosApplied": "<array>",
          "_id": "60ca5b6ae3b5d900081ae44b",
          "price": 90,
          "weightUnit": "lb",
          "isPickup": true,
          "itemId": 89,
          "quantity": 1,
          "priceListId": 100000,
          "sku": "GardenWoodSofa",
          "taxCode": "tytuy",
          "title": "Garden Wood Sofa",
          "weight": 2345,
          "lineItemId": 1,
          "attributeTotalPrice": 0,
          "attributes": "<array>",
          "warehouseId": "60bf9615e66d120008b37e5e",
          "currency": "USD",
          "shipToId": 390,
          "discount": 0,
          "estimatedTax": 0,
          "total": 90,
          "reservedLocation": [
            {
              "_id": "60ca5d3e06b91d0008427435",
              "warehouseId": "60bf9615e66d120008b37e5e",
              "quantity": 1,
              "id": "60ca5d3e06b91d0008427435"
            }
          ],
          "id": "60ca5b6ae3b5d900081ae44b"
        }
      ],
      "shipments": "<array>",
      "payments": [
        {
          "billToAddress": {
            "name": {
              "first": "John",
              "last": "Smith"
            },
            "phone": {
              "number": 7780811973,
              "kind": "mobile"
            },
            "email": "[email protected]",
            "street1": "600 Congress Ave",
            "street2": "suite 219",
            "city": "Austin",
            "state": "Tx",
            "country": "US",
            "zipCode": 10033
          },
          "shipToId": [
            390
          ],
          "_id": "60ca5d3dc0fac00008e64c94",
          "paymentStatus": "succeeded",
          "amount": 90.5,
          "currency": "USD",
          "paymentIdentifier": {
            "cardIdentifier": 4242
          },
          "paymentMethod": "visa",
          "paymentKind": "CARD_STRIPE",
          "conversion": 1,
          "paymentToken": {
            "token": "pi_1J35DCJxr7zyIFb9axtM3OKv",
            "type": "CARD_STRIPE"
          },
          "id": "60ca5d3dc0fac00008e64c94"
        }
      ],
      "revision": 0,
      "totalQuantity": 1,
      "statusDescriptions": "<array>",
      "events": "<array>",
      "pickups": "<array>",
      "createdAt": "2021-06-16T20:21:17.038Z",
      "updatedAt": "2021-06-16T20:21:18.355Z",
      "__v": 0
    }
  ]
}

GET

api-order

orders

user

Get order by user

curl --request GET \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user \
  --header 'Authorization: <authorization>' \
  --header 'x-site-context: <x-site-context>'

{
  "query": {
    "limit": 2,
    "offset": 0,
    "count": 19,
    "orderTotalSum": 31719.46,
    "orderAverage": 1669.45,
    "totalQuantitySum": 132,
    "statusCounts": {
      "ORDER_CREATED": 13,
      "ORDER_CONFIRMED": 0,
      "ORDER_CANCELLED": 1,
      "ORDER_PARTIALLY_SHIPPED": 0,
      "ORDER_SHIPPED": 2,
      "ORDER_PARTIALLY_DELIVERED": 0,
      "ORDER_DELIVERED": 0,
      "ORDER_RETURNED": 0,
      "ORDER_PARTIALLY_RETURNED": 0,
      "ORDER_PAYMENT_AUTHORIZED": 2,
      "ORDER_PAYMENT_INVALID": 0,
      "ORDER_FULFILLED": 0,
      "ORDER_PARTIALLY_FULFILLED": 1
    }
  },
  "orders": [
    {
      "_id": "60ca5d3dc0fac00008e64c91",
      "tags": "<array>",
      "cartId": "60ca5b6ae3b5d900081ae44a",
      "customerUserId": "60c128045a38bf0009ad6502",
      "attributes": "<array>",
      "customerEmail": "[email protected]",
      "orderCurrency": "USD",
      "orderTotal": 90.5,
      "taxTotal": 0.5,
      "channel": 12,
      "status": "ORDER_CREATED",
      "statusLog": "Order has been created",
      "orderReference": "1635-8532-92190",
      "orderId": "8677-7648-19307",
      "shipTo": [
        {
          "pickupPerson": {
            "name": {
              "first": "John",
              "last": "Doe"
            },
            "phone": {
              "number": 8087769338,
              "kind": "Mobile"
            },
            "email": "[email protected]"
          },
          "altPickupPerson": {
            "name": {
              "first": "first",
              "last": "last"
            },
            "phone": {
              "number": 8087769338,
              "kind": "Mobile"
            },
            "email": "[email protected]"
          },
          "promosApplied": "<array>",
          "_id": "60ca5c1c9f490e0008020b28",
          "shipToType": "BOPIS",
          "taxCode": "FR1000",
          "shipToId": 390,
          "price": 0,
          "currency": null,
          "shipmentMethodId": null,
          "estimatedTax": 0.5,
          "shipmentCarrier": null,
          "shipmentMethod": null,
          "total": 0.5,
          "id": "60ca5c1c9f490e0008020b28"
        }
      ],
      "items": [
        {
          "group": [
            1.2312312312312322e+23
          ],
          "promosApplied": "<array>",
          "_id": "60ca5b6ae3b5d900081ae44b",
          "price": 90,
          "weightUnit": "lb",
          "isPickup": true,
          "itemId": 89,
          "quantity": 1,
          "priceListId": 100000,
          "sku": "GardenWoodSofa",
          "taxCode": "tytuy",
          "title": "Garden Wood Sofa",
          "weight": 2345,
          "lineItemId": 1,
          "attributeTotalPrice": 0,
          "attributes": "<array>",
          "warehouseId": "60bf9615e66d120008b37e5e",
          "currency": "USD",
          "shipToId": 390,
          "discount": 0,
          "estimatedTax": 0,
          "total": 90,
          "reservedLocation": [
            {
              "_id": "60ca5d3e06b91d0008427435",
              "warehouseId": "60bf9615e66d120008b37e5e",
              "quantity": 1,
              "id": "60ca5d3e06b91d0008427435"
            }
          ],
          "id": "60ca5b6ae3b5d900081ae44b"
        }
      ],
      "shipments": "<array>",
      "payments": [
        {
          "billToAddress": {
            "name": {
              "first": "John",
              "last": "Smith"
            },
            "phone": {
              "number": 7780811973,
              "kind": "mobile"
            },
            "email": "[email protected]",
            "street1": "600 Congress Ave",
            "street2": "suite 219",
            "city": "Austin",
            "state": "Tx",
            "country": "US",
            "zipCode": 10033
          },
          "shipToId": [
            390
          ],
          "_id": "60ca5d3dc0fac00008e64c94",
          "paymentStatus": "succeeded",
          "amount": 90.5,
          "currency": "USD",
          "paymentIdentifier": {
            "cardIdentifier": 4242
          },
          "paymentMethod": "visa",
          "paymentKind": "CARD_STRIPE",
          "conversion": 1,
          "paymentToken": {
            "token": "pi_1J35DCJxr7zyIFb9axtM3OKv",
            "type": "CARD_STRIPE"
          },
          "id": "60ca5d3dc0fac00008e64c94"
        }
      ],
      "revision": 0,
      "totalQuantity": 1,
      "statusDescriptions": "<array>",
      "events": "<array>",
      "pickups": "<array>",
      "createdAt": "2021-06-16T20:21:17.038Z",
      "updatedAt": "2021-06-16T20:21:18.355Z",
      "__v": 0
    }
  ]
}

Headers

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

Authorization

string

required

Query Parameters

Pagination parameters

object

Show child attributes

Pagination parameters.offset

integer

default:0

Required range: x >= 0

Pagination parameters.limit

integer

Required range: x >= 1

Response

Order

query

object

Show child attributes

query.limit

number

Example:

2

query.offset

number

Example:

0

query.count

number

Example:

19

query.orderTotalSum

number

Example:

31719.46

query.orderAverage

number

Example:

1669.45

query.totalQuantitySum

number

Example:

132

query.statusCounts

object

Show child attributes

query.statusCounts.ORDER_CREATED

number

Example:

13

query.statusCounts.ORDER_CONFIRMED

number

Example:

0

query.statusCounts.ORDER_CANCELLED

number

Example:

1

query.statusCounts.ORDER_PARTIALLY_SHIPPED

number

Example:

0

query.statusCounts.ORDER_SHIPPED

number

Example:

2

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:

2

query.statusCounts.ORDER_PAYMENT_INVALID

number

Example:

0

query.statusCounts.ORDER_FULFILLED

number

Example:

0

query.statusCounts.ORDER_PARTIALLY_FULFILLED

number

Example:

1

orders

object[]

Show child attributes

orders._id

string

Example:

"60ca5d3dc0fac00008e64c91"

orders.tags

array

orders.cartId

string

Example:

"60ca5b6ae3b5d900081ae44a"

orders.customerUserId

string

Example:

"60c128045a38bf0009ad6502"

orders.attributes

array

orders.customerEmail

string

Example:

"[email protected]"

orders.orderCurrency

string

Example:

"USD"

orders.orderTotal

number

Example:

90.5

orders.taxTotal

number

Example:

0.5

orders.channel

number

Example:

12

orders.status

string

Example:

"ORDER_CREATED"

orders.statusLog

string

Example:

"Order has been created"

orders.orderReference

string

Example:

"1635-8532-92190"

orders.orderId

string

Example:

"8677-7648-19307"

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:

"[email protected]"

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:

"[email protected]"

orders.shipTo.promosApplied

array

orders.shipTo._id

string

Example:

"60ca5c1c9f490e0008020b28"

orders.shipTo.shipToType

string

Example:

"BOPIS"

orders.shipTo.taxCode

string

Example:

"FR1000"

orders.shipTo.shipToId

number

Example:

390

orders.shipTo.price

number

Example:

0

orders.shipTo.currency

string

Example:

null

orders.shipTo.shipmentMethodId

string

Example:

null

orders.shipTo.estimatedTax

number

Example:

0.5

orders.shipTo.shipmentCarrier

string

Example:

null

orders.shipTo.shipmentMethod

string

Example:

null

orders.shipTo.total

number

Example:

0.5

orders.shipTo.id

string

Example:

"60ca5c1c9f490e0008020b28"

orders.items

object[]

Show child attributes

orders.items.group

string[]

orders.items.promosApplied

array

orders.items._id

string

Example:

"60ca5b6ae3b5d900081ae44b"

orders.items.price

number

Example:

90

orders.items.weightUnit

string

Example:

"lb"

orders.items.isPickup

boolean

orders.items.itemId

number

Example:

89

orders.items.quantity

number

Example:

1

orders.items.priceListId

number

Example:

100000

orders.items.sku

string

Example:

"GardenWoodSofa"

orders.items.taxCode

string

Example:

"tytuy"

orders.items.title

string

Example:

"Garden Wood Sofa"

orders.items.weight

number

Example:

2345

orders.items.lineItemId

number

Example:

1

orders.items.attributeTotalPrice

number

Example:

0

orders.items.attributes

array

orders.items.warehouseId

string

Example:

"60bf9615e66d120008b37e5e"

orders.items.currency

string

Example:

"USD"

orders.items.shipToId

number

Example:

390

orders.items.discount

number

Example:

0

orders.items.estimatedTax

number

Example:

0

orders.items.total

number

Example:

90

orders.items.reservedLocation

object[]

Show child attributes

orders.items.reservedLocation._id

string

Example:

"60ca5d3e06b91d0008427435"

orders.items.reservedLocation.warehouseId

string

Example:

"60bf9615e66d120008b37e5e"

orders.items.reservedLocation.quantity

number

Example:

1

orders.items.reservedLocation.id

string

Example:

"60ca5d3e06b91d0008427435"

orders.items.id

string

Example:

"60ca5b6ae3b5d900081ae44b"

orders.shipments

array

orders.payments

object[]

Show child attributes

orders.payments.billToAddress

object

Show child attributes

orders.payments.billToAddress.name

object

Show child attributes

orders.payments.billToAddress.name.first

string

Example:

"John"

orders.payments.billToAddress.name.last

string

Example:

"Smith"

orders.payments.billToAddress.phone

object

Show child attributes

orders.payments.billToAddress.phone.number

string

Example:

7780811973

orders.payments.billToAddress.phone.kind

string

Example:

"mobile"

orders.payments.billToAddress.email

string

Example:

"[email protected]"

orders.payments.billToAddress.street1

string

Example:

"600 Congress Ave"

orders.payments.billToAddress.street2

string

Example:

"suite 219"

orders.payments.billToAddress.city

string

Example:

"Austin"

orders.payments.billToAddress.state

string

Example:

"Tx"

orders.payments.billToAddress.country

string

Example:

"US"

orders.payments.billToAddress.zipCode

string

Example:

10033

orders.payments.shipToId

number[]

orders.payments._id

string

Example:

"60ca5d3dc0fac00008e64c94"

orders.payments.paymentStatus

string

Example:

"succeeded"

orders.payments.amount

number

Example:

90.5

orders.payments.currency

string

Example:

"USD"

orders.payments.paymentIdentifier

object

Show child attributes

orders.payments.paymentIdentifier.cardIdentifier

string

Example:

4242

orders.payments.paymentMethod

string

Example:

"visa"

orders.payments.paymentKind

string

Example:

"CARD_STRIPE"

orders.payments.conversion

number

Example:

1

orders.payments.paymentToken

object

Show child attributes

orders.payments.paymentToken.token

string

Example:

"pi_1J35DCJxr7zyIFb9axtM3OKv"

orders.payments.paymentToken.type

string

Example:

"CARD_STRIPE"

orders.payments.id

string

Example:

"60ca5d3dc0fac00008e64c94"

orders.revision

number

Example:

0

orders.totalQuantity

number

Example:

1

orders.statusDescriptions

array

orders.events

array

orders.pickups

array

orders.createdAt

string

Example:

"2021-06-16T20:21:17.038Z"

orders.updatedAt

string

Example:

"2021-06-16T20:21:18.355Z"

orders.__v

number

Example:

0

Return order Return payment by orderId

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Get order by user

Headers

Query Parameters

Response