Get order

Get order

GET /api-order/orders/orderNumber/{orderId}

Get order

cURL

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

200

{
  "order": {
    "_id": "6021f6b8bd6ce10008579e8e",
    "tags": "<array>",
    "cartId": "5e4876e10cfe1d8902005d33",
    "channel": 12,
    "orderTotal": 125.33,
    "taxTotal": 5.23,
    "orderCurrency": "USD",
    "status": "ORDER_CANCELLED",
    "statusLog": "Order has been cancelled",
    "customerUserId": "5e3598e3007c5e00080d2bb8",
    "customerAccountId": "5e3598e3007c5e00080d2bb8",
    "customerEmail": "[e-mail]",
    "customerPhone": {
      "number": "555-555-5555",
      "kind": "mobile"
    },
    "orderId": "8426-1549-34543",
    "shipTo": [
      {
        "address": {
          "name": {
            "first": "john",
            "middle": "p",
            "last": "smith"
          },
          "phone": {
            "number": "555-555-5555",
            "kind": "mobile"
          },
          "isValidated": true,
          "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": "6021f6b8bd6ce10008579e8f",
        "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": "2019-12-14T00:00:00.000Z",
        "shipmentInstructions": "Leave at back door",
        "shipmentStatus": "Delivered",
        "readyForPickups": "<array>",
        "id": "6021f6b8bd6ce10008579e8f"
      }
    ],
    "items": [
      {
        "group": [
          123
        ],
        "promosApplied": [
          {
            "name": "test"
          }
        ],
        "_id": "6021f6b8bd6ce10008579e90",
        "lineItemId": 1,
        "itemId": 1000000051098,
        "priceListId": 1000000,
        "sku": 1538910,
        "title": "abcDNA Luminous Cushion Lagoon",
        "quantity": 1,
        "price": 4.5,
        "discount": 1,
        "currency": "USD",
        "shipToId": 1000001,
        "estimatedTax": 10.25,
        "committedTax": 10.25,
        "total": 4.54,
        "taxCode": "FR020000",
        "weight": 10,
        "weightUnit": "lb",
        "reservedLocation": "<array>",
        "attributes": "<array>",
        "id": "6021f6b8bd6ce10008579e90"
      }
    ],
    "shipments": "<array>",
    "payments": [
      {
        "billToAddress": {
          "name": {
            "first": "john",
            "middle": "p",
            "last": "smith"
          },
          "phone": {
            "number": "555-555-5555",
            "kind": "mobile"
          },
          "isValidated": true,
          "email": "[e-mail]",
          "street1": "10400 NE 4th St",
          "street2": "Suite 500",
          "city": "Bellevue",
          "state": "WA",
          "country": "USA",
          "zipCode": 98004,
          "kind": "Ship to address"
        },
        "shipToId": [
          1000001
        ],
        "_id": "6021f6b8bd6ce10008579e92",
        "billToId": 1000001,
        "paymentIdentifier": {
          "cardIdentifier": 4242
        },
        "paymentMethod": "Visa",
        "paymentToken": {
          "token": 12345689
        },
        "paymentKind": "Default payment",
        "amount": 533.33,
        "currency": "USD",
        "conversion": 1,
        "paymentStatus": "Pending",
        "id": "6021f6b8bd6ce10008579e92"
      }
    ],
    "revision": 1,
    "totalQuantity": 2,
    "statusDescriptions": [
      {
        "_id": "614b25234a2b4e0009870c49",
        "status": "ORDER_CANCELLED",
        "code": 1001,
        "description": "Merchant Out of Stock",
        "date": "2021-09-22T12:44:19.703Z",
        "id": "614b25234a2b4e0009870c49"
      }
    ],
    "events": "<array>",
    "createdAt": "2021-02-09T02:43:04.926Z",
    "updatedAt": "2021-09-22T12:44:19.696Z",
    "__v": 0
  },
  "history": [
    {
      "_id": "614b25234a2b4e0009870c4f",
      "tags": "<array>",
      "cartId": "5e4876e10cfe1d8902005d33",
      "channel": 12,
      "orderTotal": 125.33,
      "taxTotal": 5.23,
      "orderCurrency": "USD",
      "status": "ORDER_CANCELLED",
      "statusLog": "Order has been cancelled",
      "customerUserId": "5e3598e3007c5e00080d2bb8",
      "customerAccountId": "5e3598e3007c5e00080d2bb8",
      "customerEmail": "[e-mail]",
      "customerPhone": {
        "number": "555-555-5555",
        "kind": "mobile"
      },
      "orderId": "8426-1549-34543",
      "shipTo": [
        {
          "address": {
            "name": {
              "first": "john",
              "middle": "p",
              "last": "smith"
            },
            "phone": {
              "number": "555-555-5555",
              "kind": "mobile"
            },
            "email": "[e-mail]",
            "street1": "10400 NE 4th St",
            "street2": "Suite 500",
            "city": "Bellevue",
            "state": "WA",
            "country": "USA",
            "zipCode": 98004,
            "kind": "Ship to address"
          },
          "promosApplied": [
            {
              "name": "test1"
            }
          ],
          "_id": "6021f6b8bd6ce10008579e8f",
          "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": "2019-12-14T00:00:00.000Z",
          "shipmentInstructions": "Leave at back door",
          "shipmentStatus": "Delivered",
          "id": "6021f6b8bd6ce10008579e8f"
        }
      ],
      "items": [
        {
          "group": [
            123
          ],
          "promosApplied": [
            {
              "name": "test"
            }
          ],
          "_id": "6021f6b8bd6ce10008579e90",
          "lineItemId": 1,
          "itemId": 1000000051098,
          "sku": 1538910,
          "title": "abcDNA Luminous Cushion Lagoon",
          "quantity": 1,
          "price": 4.5,
          "discount": 1,
          "currency": "USD",
          "shipToId": 1000001,
          "estimatedTax": 10.25,
          "committedTax": 10.25,
          "total": 4.54,
          "taxCode": "FR020000",
          "weight": 10,
          "weightUnit": "lb",
          "id": "6021f6b8bd6ce10008579e90"
        }
      ],
      "shipments": "<array>",
      "payments": [
        {
          "billToAddress": {
            "name": {
              "first": "john",
              "middle": "p",
              "last": "smith"
            },
            "phone": {
              "number": "555-555-5555",
              "kind": "mobile"
            },
            "email": "[e-mail]",
            "street1": "10400 NE 4th St",
            "street2": "Suite 500",
            "city": "Bellevue",
            "state": "WA",
            "country": "USA",
            "zipCode": 98004,
            "kind": "Ship to address"
          },
          "shipToId": [
            1000001
          ],
          "_id": "6021f6b8bd6ce10008579e92",
          "billToId": 1000001,
          "paymentIdentifier": {
            "cardIdentifier": 4242
          },
          "paymentMethod": "Visa",
          "paymentToken": {
            "token": 12345689
          },
          "paymentKind": "Default payment",
          "amount": 533.33,
          "currency": "USD",
          "conversion": 1,
          "paymentStatus": "Pending",
          "id": "6021f6b8bd6ce10008579e92"
        }
      ],
      "revision": 1,
      "totalQuantity": 2,
      "statusDescriptions": [
        {
          "_id": "614b25234a2b4e0009870c49",
          "status": "ORDER_CANCELLED",
          "code": 1001,
          "description": "Merchant Out of Stock",
          "date": "2021-09-22T12:44:19.703Z",
          "id": "614b25234a2b4e0009870c49"
        }
      ],
      "events": "<array>",
      "__v": 0,
      "createdAt": "2021-09-22T12:44:19.817Z",
      "updatedAt": "2021-09-22T12:44:19.817Z"
    }
  ]
}

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

Path Parameters

orderId · string · required

Required string length: 15

Example:

"2947-5955-82579"

Response

200

application/json

Order

order · object

Show child attributes

order. _id · string

Example:

"6021f6b8bd6ce10008579e8e"

order. tags · array

order. cartId · string

Example:

"5e4876e10cfe1d8902005d33"

order. channel · number

Example:

12

order. orderTotal · number

Example:

125.33

order. taxTotal · number

Example:

5.23

order. orderCurrency · string

Example:

"USD"

order. status · string

Example:

"ORDER_CANCELLED"

order. statusLog · string

Example:

"Order has been cancelled"

order. customerUserId · string

Example:

"5e3598e3007c5e00080d2bb8"

order. customerAccountId · string

Example:

"5e3598e3007c5e00080d2bb8"

order. customerEmail · string

Example:

"[e-mail]"

order. customerPhone · object

Show child attributes

order.customerPhone. number · string

Example:

"555-555-5555"

order.customerPhone. kind · string

Example:

"mobile"

order. orderId · string

Example:

"8426-1549-34543"

order. shipTo · object[]

Show child attributes

order.shipTo. address · object

Show child attributes

order.shipTo.address. name · object

Show child attributes

order.shipTo.address.name. first · string

Example:

"john"

order.shipTo.address.name. middle · string

Example:

"p"

order.shipTo.address.name. last · string

Example:

"smith"

order.shipTo.address. phone · object

Show child attributes

order.shipTo.address.phone. number · string

Example:

"555-555-5555"

order.shipTo.address.phone. kind · string

Example:

"mobile"

order.shipTo.address. isValidated · boolean

order.shipTo.address. email · string

Example:

"[e-mail]"

order.shipTo.address. street1 · string

Example:

"10400 NE 4th St"

order.shipTo.address. street2 · string

Example:

"Suite 500"

order.shipTo.address. city · string

Example:

"Bellevue"

order.shipTo.address. state · string

Example:

"WA"

order.shipTo.address. country · string

Example:

"USA"

order.shipTo.address. zipCode · string

Example:

98004

order.shipTo.address. kind · string

Example:

"Ship to address"

order.shipTo. delivery · object

Show child attributes

order.shipTo.delivery. actual · string<nullable>

order.shipTo. shipping · object

Show child attributes

order.shipTo.shipping. actual · string<nullable>

order.shipTo. promosApplied · object[]

Show child attributes

order.shipTo.promosApplied. name · string

Example:

"test1"

order.shipTo. _id · string

Example:

"6021f6b8bd6ce10008579e8f"

order.shipTo. shipToId · number

Example:

1000001

order.shipTo. shipToType · string

Example:

"SHIP_TO_ADDRESS"

order.shipTo. price · number

Example:

24.87

order.shipTo. currency · string

Example:

"USD"

order.shipTo. estimatedTax · number

Example:

10

order.shipTo. committedTax · number

Example:

10

order.shipTo. total · number

Example:

34.87

order.shipTo. taxCode · string

Example:

"FR020000"

order.shipTo. shipmentCarrier · string

Example:

"Fedex"

order.shipTo. shipmentMethod · string

Example:

"Express"

order.shipTo. shipmentMethodId · string

Example:

10000001

order.shipTo. promisedDeliveryDate · string

Example:

"2019-12-14T00:00:00.000Z"

order.shipTo. shipmentInstructions · string

Example:

"Leave at back door"

order.shipTo. shipmentStatus · string

Example:

"Delivered"

order.shipTo. readyForPickups · array

order.shipTo. id · string

Example:

"6021f6b8bd6ce10008579e8f"

order. items · object[]

Show child attributes

order.items. group · string[]

order.items. promosApplied · object[]

Show child attributes

order.items.promosApplied. name · string

Example:

"test"

order.items. _id · string

Example:

"6021f6b8bd6ce10008579e90"

order.items. lineItemId · number

Example:

1

order.items. itemId · number

Example:

1000000051098

order.items. priceListId · number

Example:

1000000

order.items. sku · string

Example:

1538910

order.items. title · string

Example:

"abcDNA Luminous Cushion Lagoon"

order.items. quantity · number

Example:

1

order.items. price · number

Example:

4.5

order.items. discount · number

Example:

1

order.items. currency · string

Example:

"USD"

order.items. shipToId · number

Example:

1000001

order.items. estimatedTax · number

Example:

10.25

order.items. committedTax · number

Example:

10.25

order.items. total · number

Example:

4.54

order.items. taxCode · string

Example:

"FR020000"

order.items. weight · number

Example:

10

order.items. weightUnit · string

Example:

"lb"

order.items. reservedLocation · array

order.items. attributes · array

order.items. id · string

Example:

"6021f6b8bd6ce10008579e90"

order. shipments · array

order. payments · object[]

Show child attributes

order.payments. billToAddress · object

Show child attributes

order.payments.billToAddress. name · object

Show child attributes

order.payments.billToAddress.name. first · string

Example:

"john"

order.payments.billToAddress.name. middle · string

Example:

"p"

order.payments.billToAddress.name. last · string

Example:

"smith"

order.payments.billToAddress. phone · object

Show child attributes

order.payments.billToAddress.phone. number · string

Example:

"555-555-5555"

order.payments.billToAddress.phone. kind · string

Example:

"mobile"

order.payments.billToAddress. isValidated · boolean

order.payments.billToAddress. email · string

Example:

"[e-mail]"

order.payments.billToAddress. street1 · string

Example:

"10400 NE 4th St"

order.payments.billToAddress. street2 · string

Example:

"Suite 500"

order.payments.billToAddress. city · string

Example:

"Bellevue"

order.payments.billToAddress. state · string

Example:

"WA"

order.payments.billToAddress. country · string

Example:

"USA"

order.payments.billToAddress. zipCode · string

Example:

98004

order.payments.billToAddress. kind · string

Example:

"Ship to address"

order.payments. shipToId · number[]

order.payments. _id · string

Example:

"6021f6b8bd6ce10008579e92"

order.payments. billToId · number

Example:

1000001

order.payments. paymentIdentifier · object

Show child attributes

order.payments.paymentIdentifier. cardIdentifier · number

Example:

4242

order.payments. paymentMethod · string

Example:

"Visa"

order.payments. paymentToken · object

Show child attributes

order.payments.paymentToken. token · number

Example:

12345689

order.payments. paymentKind · string

Example:

"Default payment"

order.payments. amount · number

Example:

533.33

order.payments. currency · string

Example:

"USD"

order.payments. conversion · number

Example:

1

order.payments. paymentStatus · string

Example:

"Pending"

order.payments. id · string

Example:

"6021f6b8bd6ce10008579e92"

order. revision · number

Example:

1

order. totalQuantity · number

Example:

2

order. statusDescriptions · object[]

Show child attributes

order.statusDescriptions. _id · string

Example:

"614b25234a2b4e0009870c49"

order.statusDescriptions. status · string

Example:

"ORDER_CANCELLED"

order.statusDescriptions. code · string

Example:

1001

order.statusDescriptions. description · string

Example:

"Merchant Out of Stock"

order.statusDescriptions. date · string

Example:

"2021-09-22T12:44:19.703Z"

order.statusDescriptions. id · string

Example:

"614b25234a2b4e0009870c49"

order. events · array

order. createdAt · string

Example:

"2021-02-09T02:43:04.926Z"

order. updatedAt · string

Example:

"2021-09-22T12:44:19.696Z"

order. __v · number

Example:

0

history · object[]

Show child attributes

history. _id · string

Example:

"614b25234a2b4e0009870c4f"

history. tags · array

history. cartId · string

Example:

"5e4876e10cfe1d8902005d33"

history. channel · number

Example:

12

history. orderTotal · number

Example:

125.33

history. taxTotal · number

Example:

5.23

history. orderCurrency · string

Example:

"USD"

history. status · string

Example:

"ORDER_CANCELLED"

history. statusLog · string

Example:

"Order has been cancelled"

history. customerUserId · string

Example:

"5e3598e3007c5e00080d2bb8"

history. customerAccountId · string

Example:

"5e3598e3007c5e00080d2bb8"

history. customerEmail · string

Example:

"[e-mail]"

history. customerPhone · object

Show child attributes

history.customerPhone. number · string

Example:

"555-555-5555"

history.customerPhone. kind · string

Example:

"mobile"

history. orderId · string

Example:

"8426-1549-34543"

history. shipTo · object[]

Show child attributes

history.shipTo. address · object

Show child attributes

history.shipTo.address. name · object

Show child attributes

history.shipTo.address.name. first · string

Example:

"john"

history.shipTo.address.name. middle · string

Example:

"p"

history.shipTo.address.name. last · string

Example:

"smith"

history.shipTo.address. phone · object

Show child attributes

history.shipTo.address.phone. number · string

Example:

"555-555-5555"

history.shipTo.address.phone. kind · string

Example:

"mobile"

history.shipTo.address. email · string

Example:

"[e-mail]"

history.shipTo.address. street1 · string

Example:

"10400 NE 4th St"

history.shipTo.address. street2 · string

Example:

"Suite 500"

history.shipTo.address. city · string

Example:

"Bellevue"

history.shipTo.address. state · string

Example:

"WA"

history.shipTo.address. country · string

Example:

"USA"

history.shipTo.address. zipCode · string

Example:

98004

history.shipTo.address. kind · string

Example:

"Ship to address"

history.shipTo. promosApplied · object[]

Show child attributes

history.shipTo.promosApplied. name · string

Example:

"test1"

history.shipTo. _id · string

Example:

"6021f6b8bd6ce10008579e8f"

history.shipTo. shipToId · number

Example:

1000001

history.shipTo. shipToType · string

Example:

"SHIP_TO_ADDRESS"

history.shipTo. price · number

Example:

24.87

history.shipTo. currency · string

Example:

"USD"

history.shipTo. estimatedTax · number

Example:

10

history.shipTo. committedTax · number

Example:

10

history.shipTo. total · number

Example:

34.87

history.shipTo. taxCode · string

Example:

"FR020000"

history.shipTo. shipmentCarrier · string

Example:

"Fedex"

history.shipTo. shipmentMethod · string

Example:

"Express"

history.shipTo. shipmentMethodId · string

Example:

10000001

history.shipTo. promisedDeliveryDate · string

Example:

"2019-12-14T00:00:00.000Z"

history.shipTo. shipmentInstructions · string

Example:

"Leave at back door"

history.shipTo. shipmentStatus · string

Example:

"Delivered"

history.shipTo. id · string

Example:

"6021f6b8bd6ce10008579e8f"

history. items · object[]

Show child attributes

history.items. group · string[]

history.items. promosApplied · object[]

Show child attributes

history.items.promosApplied. name · string

Example:

"test"

history.items. _id · string

Example:

"6021f6b8bd6ce10008579e90"

history.items. lineItemId · number

Example:

1

history.items. itemId · number

Example:

1000000051098

history.items. sku · string

Example:

1538910

history.items. title · string

Example:

"abcDNA Luminous Cushion Lagoon"

history.items. quantity · number

Example:

1

history.items. price · number

Example:

4.5

history.items. discount · number

Example:

1

history.items. currency · string

Example:

"USD"

history.items. shipToId · number

Example:

1000001

history.items. estimatedTax · number

Example:

10.25

history.items. committedTax · number

Example:

10.25

history.items. total · number

Example:

4.54

history.items. taxCode · string

Example:

"FR020000"

history.items. weight · number

Example:

10

history.items. weightUnit · string

Example:

"lb"

history.items. id · string

Example:

"6021f6b8bd6ce10008579e90"

history. shipments · array

history. payments · object[]

Show child attributes

history.payments. billToAddress · object

Show child attributes

history.payments.billToAddress. name · object

Show child attributes

history.payments.billToAddress.name. first · string

Example:

"john"

history.payments.billToAddress.name. middle · string

Example:

"p"

history.payments.billToAddress.name. last · string

Example:

"smith"

history.payments.billToAddress. phone · object

Show child attributes

history.payments.billToAddress.phone. number · string

Example:

"555-555-5555"

history.payments.billToAddress.phone. kind · string

Example:

"mobile"

history.payments.billToAddress. email · string

Example:

"[e-mail]"

history.payments.billToAddress. street1 · string

Example:

"10400 NE 4th St"

history.payments.billToAddress. street2 · string

Example:

"Suite 500"

history.payments.billToAddress. city · string

Example:

"Bellevue"

history.payments.billToAddress. state · string

Example:

"WA"

history.payments.billToAddress. country · string

Example:

"USA"

history.payments.billToAddress. zipCode · string

Example:

98004

history.payments.billToAddress. kind · string

Example:

"Ship to address"

history.payments. shipToId · number[]

history.payments. _id · string

Example:

"6021f6b8bd6ce10008579e92"

history.payments. billToId · number

Example:

1000001

history.payments. paymentIdentifier · object

Show child attributes

history.payments.paymentIdentifier. cardIdentifier · number

Example:

4242

history.payments. paymentMethod · string

Example:

"Visa"

history.payments. paymentToken · object

Show child attributes

history.payments.paymentToken. token · number

Example:

12345689

history.payments. paymentKind · string

Example:

"Default payment"

history.payments. amount · number

Example:

533.33

history.payments. currency · string

Example:

"USD"

history.payments. conversion · number

Example:

1

history.payments. paymentStatus · string

Example:

"Pending"

history.payments. id · string

Example:

"6021f6b8bd6ce10008579e92"

history. revision · number

Example:

1

history. totalQuantity · number

Example:

2

history. statusDescriptions · object[]

Show child attributes

history.statusDescriptions. _id · string

Example:

"614b25234a2b4e0009870c49"

history.statusDescriptions. status · string

Example:

"ORDER_CANCELLED"

history.statusDescriptions. code · string

Example:

1001

history.statusDescriptions. description · string

Example:

"Merchant Out of Stock"

history.statusDescriptions. date · string

Example:

"2021-09-22T12:44:19.703Z"

history.statusDescriptions. id · string

Example:

"614b25234a2b4e0009870c49"

history. events · array

history. __v · number

Example:

0

history. createdAt · string

Example:

"2021-09-22T12:44:19.817Z"

history. updatedAt · string

Example:

"2021-09-22T12:44:19.817Z"