Orders & Inventory
Order User Guides
Inventory User Guides
Orders API Endpoints
Inventory API Endpoints
curl --request POST \
--url https://api.fabric.inc/v3/shipments/actions/update-tracking \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-fabric-channel-id: <x-fabric-channel-id>' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
--data '
{
"shipmentNumber": "78974156816152",
"trackingNumber": "1Z999AA10123456784",
"tracking": [
{
"event": "picked up",
"eventId": "627963716b19511e8a3a631b",
"eventRecordedAt": "2019-09-30T07:58:30.996Z",
"location": "Reno, NV",
"notes": {
"description": "Shipment picked up"
},
"shipmentCarrier": "FEDEX"
}
],
"trackingURL": "https://example.com/tracking"
}
'{
"shipments": [
{
"version": 2,
"allocationId": "6413e3d3fd03a35efccb426e",
"auditLogs": [
{
"auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
"auditType": "CANCEL",
"auditedAt": "2023-03-12T09:24:54.804Z",
"employeeId": "6227",
"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"note": "Note",
"reasonCode": "Scratched item",
"source": "POS",
"subReasonCode": "Scratched item",
"updatedFields": [
{
"fieldName": "UOM",
"fieldOriginalValue": "PK"
}
]
}
],
"cartons": [
{
"cartonNumber": "1",
"cartonType": "Package",
"estimatedDeliveryDate": "2023-04-26T07:58:30.996Z",
"estimatedShipmentDate": "2023-03-25T07:58:30.996Z",
"items": [
{
"fees": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"giftCards": [
{
"amount": 50,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"giftCardActivatedAt": "2023-04-26T07:58:30.996Z",
"giftCardActivationRequestedAt": "2023-03-26T07:58:30.996Z",
"giftCardNumber": "453456765",
"giftCardStatus": "ACTIVE"
}
],
"itemId": 100023,
"lineItemId": "1",
"orderId": "6413e370cb0dc859b6c0dcb0",
"orderNumber": "309020213",
"orderedQuantity": 2,
"refundAmount": 10,
"refundAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"returnQuantity": 1,
"segment": "segment",
"shipmentLineItemId": "607f1f77bcf86cd799439011",
"shippedQuantity": 2,
"sku": "SKU0023",
"uom": "EA",
"vendorId": "vend12346667"
}
],
"promisedDeliveryDate": "2023-03-26T07:58:30.996Z",
"shipmentCarrier": "FEDEX",
"shipmentMethod": "ground",
"tracking": [
{
"event": "picked up",
"eventId": "627963716b19511e8a3a631b",
"eventRecordedAt": "2019-09-30T07:58:30.996Z",
"location": "Reno, NV",
"notes": {
"description": "Shipment picked up"
},
"shipmentCarrier": "FEDEX"
}
],
"trackingNumber": "1Z999AA10123456784",
"trackingURL": "https://example.com/tracking",
"weight": "500 grams"
}
],
"createdAt": "2023-04-06T07:58:30.996Z",
"invoiceId": "63ef4360aafa8a7f5247fe48",
"locationNumber": "WH334",
"locationType": "DC",
"masterTrackingNumber": "TX112345678",
"orderNumbers": [
"309020213, 459020213"
],
"poNumber": "1125",
"recipients": [
{
"email": "[email protected]",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
}
],
"reshipmentReasonCode": "Order is missing",
"scratchedItems": [
{
"reasonCode": "ReasonCode23454",
"itemId": 100043,
"lineItemId": "2",
"orderId": "6413e370cb0dc859b6c0dcb0",
"quantity": 1,
"sku": "SKU00043",
"subReasonCode": "SubReasonCode23242",
"uom": "EA"
}
],
"shipToAddress": {
"addressLine1": "123 Main St.",
"city": "Seattle",
"countryCode": "US",
"latitude": 47.6205,
"longitude": -122.3493,
"postalCode": "98121",
"region": "WA",
"type": "Home",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"email": "[email protected]",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
},
"shipToId": "1",
"shipmentId": "627963716b19511e8a3a631b",
"shipmentNumber": "78974156816152",
"shipmentExternalId": "123k4h123k",
"shippedAt": "2023-04-06T07:58:30.996Z",
"statusCode": "SHIPMENT_CREATED",
"subtype": "COD",
"totalCartons": 2,
"type": "STANDARD",
"updatedAt": "2023-04-06T07:58:30.996Z",
"vendorId": "56"
}
]
}Update shipment tracking
The update tracking endpoint creates a new tracking log that can be used to update the order status. The most common application of this endpoint is to connect to external web services or ‘adapters’ that have been integrated with carrier tracking applications. With this endpoint, fabric Shipment service gets information from carrier tracking applications, and in turn, updates customers about their shipment status.
curl --request POST \
--url https://api.fabric.inc/v3/shipments/actions/update-tracking \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-fabric-channel-id: <x-fabric-channel-id>' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
--data '
{
"shipmentNumber": "78974156816152",
"trackingNumber": "1Z999AA10123456784",
"tracking": [
{
"event": "picked up",
"eventId": "627963716b19511e8a3a631b",
"eventRecordedAt": "2019-09-30T07:58:30.996Z",
"location": "Reno, NV",
"notes": {
"description": "Shipment picked up"
},
"shipmentCarrier": "FEDEX"
}
],
"trackingURL": "https://example.com/tracking"
}
'{
"shipments": [
{
"version": 2,
"allocationId": "6413e3d3fd03a35efccb426e",
"auditLogs": [
{
"auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
"auditType": "CANCEL",
"auditedAt": "2023-03-12T09:24:54.804Z",
"employeeId": "6227",
"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"note": "Note",
"reasonCode": "Scratched item",
"source": "POS",
"subReasonCode": "Scratched item",
"updatedFields": [
{
"fieldName": "UOM",
"fieldOriginalValue": "PK"
}
]
}
],
"cartons": [
{
"cartonNumber": "1",
"cartonType": "Package",
"estimatedDeliveryDate": "2023-04-26T07:58:30.996Z",
"estimatedShipmentDate": "2023-03-25T07:58:30.996Z",
"items": [
{
"fees": [
{
"amount": 34.56,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"giftCards": [
{
"amount": 50,
"amountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"giftCardActivatedAt": "2023-04-26T07:58:30.996Z",
"giftCardActivationRequestedAt": "2023-03-26T07:58:30.996Z",
"giftCardNumber": "453456765",
"giftCardStatus": "ACTIVE"
}
],
"itemId": 100023,
"lineItemId": "1",
"orderId": "6413e370cb0dc859b6c0dcb0",
"orderNumber": "309020213",
"orderedQuantity": 2,
"refundAmount": 10,
"refundAmountInCurrencies": [
{
"currency": "USD",
"group": "SHOPPER",
"amount": 123.45
}
],
"returnQuantity": 1,
"segment": "segment",
"shipmentLineItemId": "607f1f77bcf86cd799439011",
"shippedQuantity": 2,
"sku": "SKU0023",
"uom": "EA",
"vendorId": "vend12346667"
}
],
"promisedDeliveryDate": "2023-03-26T07:58:30.996Z",
"shipmentCarrier": "FEDEX",
"shipmentMethod": "ground",
"tracking": [
{
"event": "picked up",
"eventId": "627963716b19511e8a3a631b",
"eventRecordedAt": "2019-09-30T07:58:30.996Z",
"location": "Reno, NV",
"notes": {
"description": "Shipment picked up"
},
"shipmentCarrier": "FEDEX"
}
],
"trackingNumber": "1Z999AA10123456784",
"trackingURL": "https://example.com/tracking",
"weight": "500 grams"
}
],
"createdAt": "2023-04-06T07:58:30.996Z",
"invoiceId": "63ef4360aafa8a7f5247fe48",
"locationNumber": "WH334",
"locationType": "DC",
"masterTrackingNumber": "TX112345678",
"orderNumbers": [
"309020213, 459020213"
],
"poNumber": "1125",
"recipients": [
{
"email": "[email protected]",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
}
],
"reshipmentReasonCode": "Order is missing",
"scratchedItems": [
{
"reasonCode": "ReasonCode23454",
"itemId": 100043,
"lineItemId": "2",
"orderId": "6413e370cb0dc859b6c0dcb0",
"quantity": 1,
"sku": "SKU00043",
"subReasonCode": "SubReasonCode23242",
"uom": "EA"
}
],
"shipToAddress": {
"addressLine1": "123 Main St.",
"city": "Seattle",
"countryCode": "US",
"latitude": 47.6205,
"longitude": -122.3493,
"postalCode": "98121",
"region": "WA",
"type": "Home",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"email": "[email protected]",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
}
},
"shipToId": "1",
"shipmentId": "627963716b19511e8a3a631b",
"shipmentNumber": "78974156816152",
"shipmentExternalId": "123k4h123k",
"shippedAt": "2023-04-06T07:58:30.996Z",
"statusCode": "SHIPMENT_CREATED",
"subtype": "COD",
"totalCartons": 2,
"type": "STANDARD",
"updatedAt": "2023-04-06T07:58:30.996Z",
"vendorId": "56"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
Unique request ID
Body
Shipment tracking details
Merchant-defined unique shipment identifier
"78974156816152"
Tracking number
"1Z999AA10123456784"
Tracking details
Show child attributes
Show child attributes
Shipment-specific event. Mandatory in the request body of Update shipment tracking - POST /shipments/actions/update-tracking endpoint
"picked up"
Event ID provided by carrier
"627963716b19511e8a3a631b"
Time event was recorded (UTC)
"2019-09-30T07:58:30.996Z"
Delivery location
"Reno, NV"
Shipment carrier
"FEDEX"
Tracking URL
"https://example.com/tracking"
Response
OK
Shipment response
Shipment details
Show child attributes
Show child attributes
The current version of the shipment document. This integer indicates the number of times the shipment has been updated by any operation.
2
System-generated allocation ID (UUID) from the Create allocation endpoint of fabric Allocation service. It refers to the given shipment. Note: Allocation occurs prior to Shipment Creation. allocationId is mandatory to create a Shipment.
"6413e3d3fd03a35efccb426e"
Audit log details
Show child attributes
Show child attributes
System-generated audit ID (UUID format)
"a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111"
Audit type such as cancel, return, etc.
"CANCEL"
Audit time (UTC)
"2023-03-12T09:24:54.804Z"
Employee (ID or name) who made the last update
"6227"
Merchant-defined unique identifier for each item in an order. When omitted, fabric will generate it during order creation, in UUID format.
"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
Additional info, if any
"Note"
Merchant-defined reason code, varies from merchant to merchant
"Scratched item"
Merchant-defined source from where the update was initiated. There are no predefined values; possible values could be Customer Service Representative (CSR), Point-of-Sale (POS), etc.
"POS"
Merchant-defined sub reason code; provides more clarity to audit reason
"Scratched item"
Carton details
Show child attributes
Show child attributes
Merchant-defined unique identifier. This can optionally be generated by fabric by using the resource generator feature of the Configuration service.
"1"
Carton type
"Package"
Estimated delivery date given by carrier based on several factors including selected shipping method and delivery location (UTC).
"2023-04-26T07:58:30.996Z"
Estimated ship date given by seller based on availability of items, their processing time, delivery location, and selected shipping method (UTC).
"2023-03-25T07:58:30.996Z"
Carton item details
Show child attributes
Show child attributes
Fee details
Show child attributes
Show child attributes
Merchant-defined return amount
34.56
The return amount represented in one or more currencies.
Each entry specifies the refunded value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.
Show child attributes
Show child attributes
Currency in ISO-4217
"USD"
Customer defined function name which uses this currency.
"SHOPPER"
Amount in currency
123.45
Fee name
"RETURN_FEE"
Merchant-defined return reason
"Return fee"
Return fee type
TAX, DISCOUNT, FEE, ITEM, ADJUSTMENT "FEE"
Gift card details
Show child attributes
Show child attributes
Gift card amount
50
The gift card amount represented in one or more currencies.
Each entry specifies the refunded value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.
Show child attributes
Show child attributes
Currency in ISO-4217
"USD"
Customer defined function name which uses this currency.
"SHOPPER"
Amount in currency
123.45
Time gift card was activated (UTC)
"2023-04-26T07:58:30.996Z"
Time of placing gift card activation request (UTC)
"2023-03-26T07:58:30.996Z"
Gift card number
"453456765"
Gift card status
PENDING_ACTIVATION, ACTIVE, FAILED "ACTIVE"
Unique item identifier
100023
Unique number assigned by merchant to identify each item in an order. When this value isn't provided, fabric will auto generate (in UUID format) during order creation.
"1"
24-character order ID generated in the response of Create Order endpoint - POST /orders
"6413e370cb0dc859b6c0dcb0"
Merchant-defined order identifier
"309020213"
Ordered quantity of given item
2
Refund amount for returned items
10
The refund amount for returned items represented in one or more currencies.
Each entry specifies the refunded value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.
Show child attributes
Show child attributes
Currency in ISO-4217
"USD"
Customer defined function name which uses this currency.
"SHOPPER"
Amount in currency
123.45
Returned quantity of given item
1
Item segment
"segment"
Unique number assigned by merchant to identify item in a shipment. When this value isn't provided, fabric will auto generate it (UUID format) during shipment.
"607f1f77bcf86cd799439011"
Shipped quantity of given item
2
Stock keeping unit (SKU), unique item identifier
"SKU0023"
Unit in which a product is measured or sold. UOM can be set to 'each' (EA) or GAL (Gallon), DZ (Dozen), etc.
"EA"
Vendor ID. Applicable in dropshipping scenarios to indicate the vendor responsible for the given item.
"vend12346667"
Promised delivery date given by seller (UTC)
"2023-03-26T07:58:30.996Z"
Shipment carrier name
"FEDEX"
Shipment method
"ground"
Carton tracking details
Show child attributes
Show child attributes
Shipment-specific event. Mandatory in the request body of Update shipment tracking - POST /shipments/actions/update-tracking endpoint
"picked up"
Event ID provided by carrier
"627963716b19511e8a3a631b"
Time event was recorded (UTC)
"2019-09-30T07:58:30.996Z"
Delivery location
"Reno, NV"
Shipment carrier
"FEDEX"
Carton tracking number. There is a single tracking number per carton
"1Z999AA10123456784"
Carton tracking URL
"https://example.com/tracking"
Carton weight
"500 grams"
Shipment creation time (UTC)
"2023-04-06T07:58:30.996Z"
Invoice ID generated from fabric Invoice service during shipment creation. Note: Invoices are only created for Shipments where merchants have payment Capture at Shipment feature enabled. The value will be “Null” if merchants don't have “Capture at Shipment” feature enabled.
"63ef4360aafa8a7f5247fe48"
Unique value to identify ship-from location. This must be the locationNumber stored in the fabric Location service.
"WH334"
Location type, such as distribution center (DC) or warehouse
"DC"
Master tracking number for all cartons in the shipment
"TX112345678"
List of order numbers associated with a shipment. Note: Currently, a shipment can be associated with only one order. In the future, this property will support a scenario where a customer places a second order for the same product immediately after their first order. Multiple order numbers can be linked to one shipment in such cases.
Merchant-defined purchase order number
"1125"
Recipient details
Show child attributes
Show child attributes
Recipient's email
The reshipment reason code.
"Order is missing"
Details of scratched items
Show child attributes
Show child attributes
Reason code for scratch
"ReasonCode23454"
Unique item identifier
100043
Unique number assigned by merchant to identify each item in an order. When this value isn't provided, fabric will auto generate it (in UUID format) during order creation.
"2"
24-character ID displayed in the response of Create Order endpoint - POST /orders
"6413e370cb0dc859b6c0dcb0"
Number of scratched items
1
Stock keeping unit (SKU), unique item identifier
"SKU00043"
Sub-reason code
"SubReasonCode23242"
Unit in which a product is measured or sold. UOM can be set to 'each' (EA) or GAL (Gallon), DZ (Dozen), etc.
"EA"
Address details
Show child attributes
Show child attributes
Address line 1
"123 Main St."
City name
"Seattle"
ISO 3166-1 alpha-2 based country code
"US"
Address latitude, used with longitude to specify the address location. Decimal degrees format; negative is degrees South. **Note:**Value must be between -90 and 90, both inclusive.
47.6205
Address longitude, used with latitude to specify the address location. Decimal degrees format; negative is degrees South. **Note:**Value must be between -180 and 180, both inclusive.
-122.3493
Postal or ZIP code
"98121"
Region or state
"WA"
Address type
"Home"
Address line 2
"Suite 100"
Address line 3
"Seventh floor"
Address line 4
"Attention: Pat E. Kake"
Contact person's email
Contact person's name
Ship-to ID generated in the response of Create shipping endpoint of Shipping service
"1"
System-generated shipment ID (UUID)
"627963716b19511e8a3a631b"
Merchant-defined unique shipment identifier. Note: It can be optionally generated by fabric by using resource generator feature in the Configuration service
"78974156816152"
Unique shipment identifier defined by the merchant. This value can be used to track or reconcile shipments in external systems and serves as a reference between fabric and the merchant's order management or fulfillment system.
"123k4h123k"
Order shipment time (UTC)
"2023-04-06T07:58:30.996Z"
Current shipment status (fabric-defined codes). Note: For standard shipments, the status would be SHIPMENT_CREATED. For pickup shipment, the initial status would be PICKUP_CREATED and once the customer picks up, the status changes to PICKUP_COMPLETED
SHIPMENT_CREATED, SHIPMENT_UPDATED, SHIPMENT_CANCELLED, PICKUP_CREATED, PICKUP_COMPLETED, SHIPMENT_DELIVERED, SHIPMENT_RETURN_PENDING, SHIPMENT_RETURN_RECEIVED, SHIPMENT_PARTIALLY_DELIVERED "SHIPMENT_CREATED"
Shipment subtype, for another layer of classification. There are no pre-defined values; the possible value is Cash On Delivery (COD)
"COD"
Total number of cartons in the given shipment. There can be only one carton per trackingNumber.
2
Shipment types
STANDARD, RESHIP, RETURN, SCRATCH, PENDING_RETURN, PICKUP, TRANSFER "STANDARD"
Time of last update to shipment (UTC)
"2023-04-06T07:58:30.996Z"
Vendor ID. Applicable in dropshipping scenarios to indicate the vendor responsible for the given item.
"56"
Was this page helpful?