Authentication v1
User Self Service APIs
Experiences v2 (XM v2)
Experiences v1 (XM v1)
Product Catalog
Orders v2 (OMS v2)
Orders v1 (OMS v1)
- Order Management System
- Overview
- PATCHCancel order
- POSTSync order status
- PATCHReturn order
- GETGet order by user
- POSTReturn payment by orderId
- POSTCancel order by user
- POSTAdd shipment bulk to order
- GETGet order
- POSTOrder query
- POSTBulk cancel orders
- POSTBulk return orders
- POSTCreate POS order
- GETGet order by email
- POSTReturn order by user
- POSTOrder checkout
- POSTAdd shipment to order
- POSTCreate subscriptions orders
- POSTOrder checkout (v4)
Offers v2
Offers v1
Subscriptions (SMT API)
Loyalty (Member)
Dropship
Cart API
Checkout API
Customer
Get order by email
Copy
Ask AI
curl --request GET \
--url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user/guest \
--header 'x-site-context: <x-site-context>'Copy
Ask AI
[
{
"_id": "60271eb8f69adb00083a80ac",
"tags": "<array>",
"cartId": "602710f862e75a0009ed25b7",
"attributes": [
{
"price": 4,
"_id": "60271baf8e1368000914bd0e",
"attributeId": "60270ac95b4c090007cafde3",
"value": true,
"name": "Small Package Giftwrap",
"type": "bool",
"id": "60271baf8e1368000914bd0e"
}
],
"customerEmail": "[email protected]",
"orderCurrency": "USD",
"orderTotal": 8433,
"taxTotal": 22,
"channel": 12,
"status": "ORDER_CREATED",
"statusLog": "Order has been created",
"orderReference": "6015-4453-86622",
"orderId": "1461-8514-32344",
"shipTo": [
{
"address": {
"name": {
"first": "Mike",
"middle": "p",
"last": "holard"
},
"phone": {
"number": "998-992-9404",
"kind": "Mobile"
},
"street1": "3520 Crowley Drive",
"city": "Vancouver",
"state": "BC",
"country": "Canada",
"zipCode": 98004,
"kind": "shipping",
"email": "[email protected]"
},
"promosApplied": "<array>",
"_id": "60271c6d8d9f7a000852a107",
"shipToType": "SHIP_TO_ADDRESS",
"taxCode": "FR1000",
"shipToId": 49,
"price": 5,
"currency": "USD",
"shipmentMethodId": 10002,
"estimatedTax": 2,
"shipmentCarrier": "Fedex",
"shipmentMethod": "Next Day",
"total": 7,
"id": "60271c6d8d9f7a000852a107"
}
],
"items": [
{
"group": [
1.2312312312312322e+23
],
"promosApplied": [
{
"unit": "10%OFF",
"value": 16,
"ON": {
"kind": "SKU",
"value": "<string>"
},
"id": "6023f20cb609010008c06af8",
"promoId": "6023f20cb609010008c06af6"
}
],
"_id": "602710f862e75a0009ed25b8",
"price": 8400,
"weightUnit": "kg",
"itemId": 1000000050,
"quantity": 1,
"priceListId": 100000,
"sku": "WATCH123456",
"taxCode": "PAC12345",
"title": "Watch",
"weight": 2,
"lineItemId": 1,
"attributeTotalPrice": 2,
"attributes": [
{
"price": 2,
"_id": "60271b3cfb9109000886b4a9",
"attributeId": "602714e50e8f780007e66d97",
"value": "Happy for you",
"name": "Item Level free Text",
"type": "string",
"id": "60271b3cfb9109000886b4a9"
}
],
"currency": "USD",
"shipToId": 49,
"discount": 1600,
"estimatedTax": 20,
"total": 8420,
"id": "602710f862e75a0009ed25b8"
}
],
"shipments": "<array>",
"payments": [
{
"billToAddress": {
"name": {
"first": "Mike",
"last": "holard"
},
"phone": {
"number": 7780811973,
"kind": "Mobile"
},
"email": "[email protected]",
"street1": "345 67 Main Street",
"street2": "tex",
"city": "AUSTIN",
"state": "TX",
"country": "US",
"zipCode": 1003
},
"shipToId": [
49
],
"_id": "60271eb8f69adb00083a80b1",
"paymentIdentifier": {
"cardIdentifier": 1111
},
"paymentMethod": "Visa",
"paymentKind": "Fabric User",
"amount": 8433,
"currency": "USD",
"conversion": 1,
"paymentToken": {
"token": 40059083049,
"type": "CARD"
},
"id": "60271eb8f69adb00083a80b1"
}
],
"revision": 0,
"totalQuantity": 1,
"statusDescriptions": "<array>",
"events": "<array>",
"createdAt": "2021-02-13T00:35:04.240Z",
"updatedAt": "2021-02-13T00:35:04.240Z",
"__v": 0
}
]Order
Get order by email
Get order by email
GET
/
api-order
/
orders
/
user
/
guest
Get order by email
Copy
Ask AI
curl --request GET \
--url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user/guest \
--header 'x-site-context: <x-site-context>'Copy
Ask AI
[
{
"_id": "60271eb8f69adb00083a80ac",
"tags": "<array>",
"cartId": "602710f862e75a0009ed25b7",
"attributes": [
{
"price": 4,
"_id": "60271baf8e1368000914bd0e",
"attributeId": "60270ac95b4c090007cafde3",
"value": true,
"name": "Small Package Giftwrap",
"type": "bool",
"id": "60271baf8e1368000914bd0e"
}
],
"customerEmail": "[email protected]",
"orderCurrency": "USD",
"orderTotal": 8433,
"taxTotal": 22,
"channel": 12,
"status": "ORDER_CREATED",
"statusLog": "Order has been created",
"orderReference": "6015-4453-86622",
"orderId": "1461-8514-32344",
"shipTo": [
{
"address": {
"name": {
"first": "Mike",
"middle": "p",
"last": "holard"
},
"phone": {
"number": "998-992-9404",
"kind": "Mobile"
},
"street1": "3520 Crowley Drive",
"city": "Vancouver",
"state": "BC",
"country": "Canada",
"zipCode": 98004,
"kind": "shipping",
"email": "[email protected]"
},
"promosApplied": "<array>",
"_id": "60271c6d8d9f7a000852a107",
"shipToType": "SHIP_TO_ADDRESS",
"taxCode": "FR1000",
"shipToId": 49,
"price": 5,
"currency": "USD",
"shipmentMethodId": 10002,
"estimatedTax": 2,
"shipmentCarrier": "Fedex",
"shipmentMethod": "Next Day",
"total": 7,
"id": "60271c6d8d9f7a000852a107"
}
],
"items": [
{
"group": [
1.2312312312312322e+23
],
"promosApplied": [
{
"unit": "10%OFF",
"value": 16,
"ON": {
"kind": "SKU",
"value": "<string>"
},
"id": "6023f20cb609010008c06af8",
"promoId": "6023f20cb609010008c06af6"
}
],
"_id": "602710f862e75a0009ed25b8",
"price": 8400,
"weightUnit": "kg",
"itemId": 1000000050,
"quantity": 1,
"priceListId": 100000,
"sku": "WATCH123456",
"taxCode": "PAC12345",
"title": "Watch",
"weight": 2,
"lineItemId": 1,
"attributeTotalPrice": 2,
"attributes": [
{
"price": 2,
"_id": "60271b3cfb9109000886b4a9",
"attributeId": "602714e50e8f780007e66d97",
"value": "Happy for you",
"name": "Item Level free Text",
"type": "string",
"id": "60271b3cfb9109000886b4a9"
}
],
"currency": "USD",
"shipToId": 49,
"discount": 1600,
"estimatedTax": 20,
"total": 8420,
"id": "602710f862e75a0009ed25b8"
}
],
"shipments": "<array>",
"payments": [
{
"billToAddress": {
"name": {
"first": "Mike",
"last": "holard"
},
"phone": {
"number": 7780811973,
"kind": "Mobile"
},
"email": "[email protected]",
"street1": "345 67 Main Street",
"street2": "tex",
"city": "AUSTIN",
"state": "TX",
"country": "US",
"zipCode": 1003
},
"shipToId": [
49
],
"_id": "60271eb8f69adb00083a80b1",
"paymentIdentifier": {
"cardIdentifier": 1111
},
"paymentMethod": "Visa",
"paymentKind": "Fabric User",
"amount": 8433,
"currency": "USD",
"conversion": 1,
"paymentToken": {
"token": 40059083049,
"type": "CARD"
},
"id": "60271eb8f69adb00083a80b1"
}
],
"revision": 0,
"totalQuantity": 1,
"statusDescriptions": "<array>",
"events": "<array>",
"createdAt": "2021-02-13T00:35:04.240Z",
"updatedAt": "2021-02-13T00:35:04.240Z",
"__v": 0
}
]Headers
Example:
"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"
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\"}"
Query Parameters
User email that we want to get orders for.
Example:
Response
Order
Example:
"60271eb8f69adb00083a80ac"
Example:
"602710f862e75a0009ed25b7"
Show child attributes
Show child attributes
Example:
4
Example:
"60271baf8e1368000914bd0e"
Example:
"60270ac95b4c090007cafde3"
Example:
true
Example:
"Small Package Giftwrap"
Example:
"bool"
Example:
"60271baf8e1368000914bd0e"
Example:
Example:
"USD"
Example:
8433
Example:
22
Example:
12
Example:
"ORDER_CREATED"
Example:
"Order has been created"
Example:
"6015-4453-86622"
Example:
"1461-8514-32344"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"3520 Crowley Drive"
Example:
"Vancouver"
Example:
"BC"
Example:
"Canada"
Example:
98004
Example:
"shipping"
Example:
Example:
"60271c6d8d9f7a000852a107"
Example:
"SHIP_TO_ADDRESS"
Example:
"FR1000"
Example:
49
Example:
5
Example:
"USD"
Example:
10002
Example:
2
Example:
"Fedex"
Example:
"Next Day"
Example:
7
Example:
"60271c6d8d9f7a000852a107"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"10%OFF"
Example:
16
Example:
"6023f20cb609010008c06af8"
Example:
"6023f20cb609010008c06af6"
Example:
"602710f862e75a0009ed25b8"
Example:
8400
Example:
"kg"
Example:
1000000050
Example:
1
Example:
100000
Example:
"WATCH123456"
Example:
"PAC12345"
Example:
"Watch"
Example:
2
Example:
1
Example:
2
Show child attributes
Show child attributes
Example:
2
Example:
"60271b3cfb9109000886b4a9"
Example:
"602714e50e8f780007e66d97"
Example:
"Happy for you"
Example:
"Item Level free Text"
Example:
"string"
Example:
"60271b3cfb9109000886b4a9"
Example:
"USD"
Example:
49
Example:
1600
Example:
20
Example:
8420
Example:
"602710f862e75a0009ed25b8"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
Example:
"345 67 Main Street"
Example:
"tex"
Example:
"AUSTIN"
Example:
"TX"
Example:
"US"
Example:
1003
Example:
"60271eb8f69adb00083a80b1"
Example:
"Visa"
Example:
"Fabric User"
Example:
8433
Example:
"USD"
Example:
1
Example:
"60271eb8f69adb00083a80b1"
Example:
0
Example:
1
Example:
"2021-02-13T00:35:04.240Z"
Example:
"2021-02-13T00:35:04.240Z"
Example:
0
Was this page helpful?
⌘I