Release Notes
- January 2025
- October 2024
- July 2024
- November 2023
- Feedback and Contact
Create new order
This endpoint creates a new order in the fabric Orders (OMS) system, regardless of whether it originates from fabric CnC service or an external system. The response includes an order ID, which is required for subsequent calls such as updating pickup information, getting order details, verifying eligibility for order cancellations, returns, exchanges, as well as creating appeasements, and processing order returns, cancellations, and exchanges.
curl --request POST \
--url https://api.fabric.inc/v3/orders \
--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 '{
"adjustmentTotal": 123.45,
"adjustments": [
{
"adjustmentCounter": 1,
"amount": 2.4,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"cancelQuantity": 2,
"invoiceQuantity": 10,
"notes": "Any additional info",
"quantity": 2,
"reasonCode": "RFC",
"returnQuantity": 1,
"subReasonCode": "Late shipping"
}
],
"attributes": {
"fraudCheckStatus": "UPDATED",
"fraudStatus": "FRAUD_PASS"
},
"cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"currency": "USD",
"customer": {
"accountId": "62272e917b12209e68751d94",
"company": "Demo Inc",
"email": "test@example.com",
"employeeId": "62272e917b12209e68751d94",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94"
},
"discounts": [
{
"amount": 2.4,
"promotionCode": "HNY2022",
"promotionId": "HNY2022",
"promotionName": "New Year",
"quantity": 2,
"type": "promotion",
"unit": "AMOUNT_OFF",
"value": 2
}
],
"employeeId": "62272e917b12209e68751d94",
"feeTotal": 12.34,
"fees": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"invoicedAmount": 34.56,
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
],
"items": [
{
"adjustments": [
{
"adjustmentCounter": 1,
"amount": 2.4,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"cancelQuantity": 2,
"invoiceQuantity": 10,
"notes": "Any additional info",
"quantity": 2,
"reasonCode": "RFC",
"returnQuantity": 1,
"subReasonCode": "Late shipping"
}
],
"attributes": {
"colorCode": "001",
"isDonation": "false",
"style": "570223020"
},
"currency": "USD",
"discounts": [
{
"amount": 2.4,
"promotionCode": "HNY2022",
"promotionId": "HNY2022",
"promotionName": "New Year",
"quantity": 2,
"type": "promotion",
"unit": "AMOUNT_OFF",
"value": 2
}
],
"employeeId": "62272e917b12209e68751d94",
"fees": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
],
"isBackorder": true,
"isDonation": true,
"isPreorder": true,
"itemDiscountsTotal": 10,
"itemFeeTotal": 10,
"itemId": 1234,
"itemName": "Item",
"itemSubtotal": 600,
"itemSubtype": "Borderfree",
"itemTaxTotal": 10,
"itemTotal": 10,
"itemUnitPrice": 10,
"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"lineItemNumber": 1,
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"notes": "Fragile - handle with care",
"user": "62272e917b12209e68751d94"
}
],
"orderedQuantity": 60,
"segment": "P1234",
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"sku": "P1234",
"taxCode": "FR01",
"taxDetails": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
],
"type": "WEB_SHIP",
"uom": "EA",
"vendorId": "P1234"
}
],
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"notes": "Fragile - handle with care",
"user": "62272e917b12209e68751d94"
}
],
"orderDiscount": 1.23,
"orderNumber": "309019176",
"orderSubtotal": 123.45,
"orderTotal": 146.9,
"orderedAt": "2022-05-12T09:30:31.198Z",
"payments": [
{
"attributes": {
"captureCurrencyCode": "USD",
"payerId": "M7AWTK3YK3B46",
"referenceId": "4DY41894J2904533S"
},
"authorizationExpirationDate": "2022-01-27T16:15:58-05:00",
"authorizedAmount": 123.2,
"billToAddress": {
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"countryCode": "US",
"email": "test@example.com",
"latitude": 47.6205,
"longitude": -122.3493,
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"postalCode": "98121",
"region": "WA",
"type": "Home"
},
"chargedAmount": 60,
"currency": "USD",
"paidAt": "2022-01-27T16:15:58-05:00",
"paymentCounter": 1,
"paymentIdentifier": {
"cardIdentifier": "3456",
"expirationMonth": "12",
"expirationYear": "2029",
"fabricPaymentReference": "f886c96c-5f65-11ed-9b6a-0242ac120002",
"paymentId": "62272e917b12209e68751d94"
},
"paymentMethod": "CREDIT_CARD",
"paymentProvider": "stripe",
"paymentStatus": "Paid",
"paymentToken": {
"paymentType": "VISA",
"token": "pi_34tr6787rt"
}
}
],
"retail": {
"cashierId": "C-123",
"locationNumber": 334,
"registerId": "113",
"transactionId": "328942333412"
},
"shipInfo": [
{
"attributes": {
"giftMessage": "[]"
},
"discounts": [
{
"amount": 2.99,
"promotionCode": "SHIPFREE",
"promotionId": "SHIPFREE",
"promotionName": "Free Shipping",
"quantity": 1,
"unit": "AMOUNT_OFF",
"value": 10
}
],
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"isInvoiced": true,
"locationNumber": "123",
"pickups": [
{
"email": "test@example.com",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"pickupType": "PRIMARY"
}
],
"shipMethod": "Parcel post delivery",
"shipToAddress": {
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"countryCode": "US",
"email": "test@example.com",
"latitude": 47.6205,
"longitude": -122.3493,
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"postalCode": "98121",
"region": "WA",
"type": "Home"
},
"shipToDiscount": 12.6,
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"shipToPrice": 20,
"shipToTaxTotal": 12.6,
"shipToType": "SHIP_TO_ADDRESS",
"shipToUnitPrice": 20,
"shipmentInstructions": "Handle with care",
"taxCode": "FR01",
"taxDetails": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
]
}
],
"statusCode": "ORDER_CREATED",
"statusDescription": "Order Created",
"subtype": "INTERNATIONAL",
"taxTotal": 12.34,
"type": "WEB"
}'{
"adjustmentTotal": 123.45,
"adjustments": [
{
"adjustmentCounter": 1,
"amount": 2.4,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"cancelQuantity": 2,
"invoiceQuantity": 10,
"notes": "Any additional info",
"quantity": 2,
"reasonCode": "RFC",
"returnQuantity": 1,
"subReasonCode": "Late shipping"
}
],
"allocatedAt": "2022-05-12T09:30:31.198Z",
"appeasementTotal": 12.34,
"appeasements": [
{
"amount": 34.56,
"appeasementCounter": 1,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"invoicedAmount": 34.56,
"payments": [
{
"paymentCounter": 1,
"refundAmount": 34.56
}
],
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping"
}
],
"attributes": {
"fraudCheckStatus": "UPDATED",
"loyaltyStatus": "N"
},
"auditLogs": [
{
"amount": 2.4,
"attributes": {
"key": "value"
},
"auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
"auditType": "CANCEL",
"auditedAt": "2023-03-12T09:24:54.804Z",
"employeeId": "6227",
"isSuccess": true,
"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"lineItemNumber": 1,
"note": "Note",
"paymentToken": {
"paymentType": "VISA",
"token": "pi_34tr6787rt"
},
"policyCode": "POS",
"quantity": 1,
"reasonCode": "Scratched item",
"sku": "SKU0023",
"source": "POS",
"subReasonCode": "Scratched item",
"updatedFields": [
{
"fieldName": "UOM",
"fieldOriginalValue": "PK"
}
]
}
],
"cancelTotal": 12.34,
"cancelledAt": "2022-05-12T09:30:31.198Z",
"cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"channelId": "12",
"createdAt": "2022-05-12T09:30:31.198Z",
"currency": "USD",
"customer": {
"accountId": "62272e917b12209e68751d94",
"company": "Demo Inc",
"email": "test@example.com",
"employeeId": "62272e917b12209e68751d94",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94"
},
"discounts": [
{
"amount": 2.99,
"invoiceQuantity": 10,
"promotionCode": "HNY2022",
"promotionId": "HNY2022",
"promotionName": "New Year",
"quantity": 1,
"unit": "AMOUNT_OFF",
"value": 10
}
],
"employeeId": "43278",
"erroredFields": [
{
"amended": false,
"errorMessage": "Invalid email address",
"fieldName": "shipInfo.shipToAddress.email"
}
],
"feeTotal": 12.34,
"fees": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"invoicedAmount": 34.56,
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
],
"invoiceTotal": 12.34,
"items": [
{
"adjustments": [
{
"adjustmentCounter": 1,
"amount": 2.4,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"cancelQuantity": 2,
"invoiceQuantity": 10,
"notes": "Any additional info",
"quantity": 2,
"reasonCode": "RFC",
"returnQuantity": 1,
"subReasonCode": "Late shipping"
}
],
"appeasementTotal": 5.5,
"appeasements": [
{
"amount": 34.56,
"appeasementCounter": 1,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"invoicedAmount": 34.56,
"payments": [
{
"paymentCounter": 1,
"refundAmount": 34.56
}
],
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping"
}
],
"attributes": {
"colorCode": "001",
"isDonation": "false",
"style": "570223020"
},
"backOrderedQuantity": 10,
"cancelledAmount": 12.4,
"cancelledQuantity": 10,
"channelId": "WHBM",
"currency": "USD",
"deliveredQuantity": 10,
"discounts": [
{
"amount": 2.99,
"invoiceQuantity": 10,
"promotionCode": "HNY2022",
"promotionId": "HNY2022",
"promotionName": "New Year",
"quantity": 1,
"unit": "AMOUNT_OFF",
"value": 10
}
],
"employeeId": "5345HJH",
"exchangeQuantity": 13,
"fees": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"invoiceQuantity": 10,
"name": "STATE",
"quantity": 12,
"refundAmount": 21.5,
"taxCode": "FR01"
}
],
"hasInfiniteConsent": true,
"invoiceTotal": 800,
"invoicedQuantity": 10,
"isBackorder": true,
"isDonation": true,
"isExchangeItem": true,
"isGifting": true,
"isPreorder": true,
"itemAdjustmentTotal": 123.45,
"itemDiscountsTotal": 80,
"itemFeeTotal": 200,
"itemId": 1234,
"itemName": "Item",
"itemShippingTotal": 10,
"itemSubtotal": 600,
"itemSubtype": "Borderfree",
"itemTaxTotal": 80,
"itemTotal": 800,
"itemUnitPrice": 10,
"lineItemId": "d538b1f1-0e45-43c6-bfc6-9666fc1188ca",
"lineItemNumber": 1,
"lineOrderStatus": "VALID",
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"notes": "Fragile - handle with care",
"user": "62272e917b12209e68751d94"
}
],
"orderedQuantity": 60,
"orderedQuantityToShip": 10,
"originalDiscounts": 50,
"originalFeeTotal": 300,
"originalItemSubtotal": 800,
"originalItemTotal": 500,
"originalShippingTotal": 80,
"originalTaxTotal": 90,
"parentLineItemNumber": 12,
"pendingExchangeQuantity": 12,
"pendingReturnQuantity": 10,
"pendingShippedBackOrderQuantity": 10,
"processingReturnQuantity": 10,
"quantityInStatus": {
"cancelled": 10,
"created": 10,
"delivered": 10,
"hold": 10,
"pendingShipped": 10,
"returned": 10,
"shipped": 10
},
"refundAmount": 21.5,
"rejectedReturnQuantity": 10,
"reshippedQuantity": 10,
"returnedQuantity": 10,
"returns": [
{
"exchangeLineItemId": "62f3dfc438bcab1951be0a19",
"fees": [
{
"amount": 34.56,
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"invoicedAmount": 11.29,
"isExchangeItemReturned": true,
"reasonCode": "Incorrect item",
"refundAmount": 11.29,
"refunds": [
{
"amount": 34.56,
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnRequestCounter": 1,
"returnsReceivedAt": "2022-09-14T14:07:36.861Z",
"shipmentId": "62b37697c67b204dd18a7465",
"shipmentInvoice": {
"invoiceId": "62ff5c0bec0aed3c86202c32",
"invoiceNumber": "23940791",
"invoicedAt": "2022-08-01T20:03:28.483971941Z"
},
"shipmentLineItemId": "234",
"shipmentQuantity": 1
}
],
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"shippedQuantity": 10,
"sku": "P1234",
"taxCode": "FR01",
"taxDetails": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
],
"type": "WEB_SHIP",
"uom": "EA",
"vendorId": "P1234"
}
],
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"notes": "Fragile - handle with care",
"user": "62272e917b12209e68751d94"
}
],
"orderDiscount": 1.23,
"orderId": "5349b4ddd2781d08c09890f4",
"orderNumber": "309019176",
"orderReleasedAt": "2022-05-12T09:30:31.198Z",
"orderSubtotal": 123.45,
"orderTotal": 146.9,
"orderedAt": "2022-05-12T09:30:31.198Z",
"originalDiscount": 1.45,
"originalFeeTotal": 12.34,
"originalOrderTotal": 146.9,
"originalSubtotal": 113.45,
"originalTaxTotal": 12.34,
"payments": [
{
"attributes": {
"captureCurrencyCode": "USD",
"payerId": "M7AWTK3YK3B46",
"referenceId": "4DY41894J2904533S"
},
"authorizationAttempts": 0,
"authorizedAmount": 123.2,
"billToAddress": {
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"countryCode": "US",
"email": "test@example.com",
"latitude": 47.6205,
"longitude": -122.3493,
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"postalCode": "98121",
"region": "WA",
"type": "Home"
},
"chargedAmount": 60,
"currency": "USD",
"isFinalCapture": false,
"isPartialCapture": false,
"paidAt": "2022-01-27T16:15:58-05:00",
"paymentCounter": 1,
"paymentIdentifier": {
"cardIdentifier": "3456",
"expirationMonth": "12",
"expirationYear": "2029",
"fabricPaymentReference": "f886c96c-5f65-11ed-9b6a-0242ac120002",
"paymentId": "62272e917b12209e68751d94"
},
"paymentLogs": [
{
"amount": -12.4,
"attributes": {
"key": "value"
},
"data": {
"body": {
"attributes": {
"key": "value"
},
"errors": [
{
"key": "value"
}
],
"responseCode": "OK",
"status": "Authorized",
"transactionId": "328942333412",
"transactionTimestamp": "2022-04-10T23:00:45:12.111Z"
},
"paymentStatusCode": "200"
},
"id": "328942333412",
"paymentId": "328942333412",
"paymentLogId": "328942333412",
"paymentLogRefId": "328942333412",
"status": "Authorized",
"type": "REFUND"
}
],
"paymentMethod": "CREDIT_CARD",
"paymentProvider": "stripe",
"paymentStatus": "Paid",
"paymentToken": {
"paymentType": "VISA",
"token": "pi_34tr6787rt"
},
"reauthorizationAttempts": 0,
"refundAmount": 21.5
}
],
"retail": {
"cashierId": "C-123",
"locationNumber": 334,
"registerId": "113",
"transactionId": "328942333412"
},
"returnTotal": 12.34,
"returns": [
{
"fees": [
{
"amount": 34.56,
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"invoicedAmount": 11.29,
"paymentCounterRefundDetails": [
{
"amount": 34.56,
"paymentCounter": 1
}
],
"refunds": [
{
"amount": 34.56,
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnCounter": 1,
"totalRefundAmount": 11.29
}
],
"shipInfo": [
{
"attributes": {
"giftMessage": "[]"
},
"discounts": [
{
"amount": 2.99,
"promotionCode": "SHIPFREE",
"promotionId": "SHIPFREE",
"promotionName": "Free Shipping",
"quantity": 1,
"unit": "AMOUNT_OFF",
"value": 10
}
],
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"isInvoiced": true,
"locationNumber": "123",
"pickups": [
{
"email": "test@example.com",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"pickupType": "PRIMARY"
}
],
"shipMethod": "Parcel post delivery",
"shipToAddress": {
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"countryCode": "US",
"email": "test@example.com",
"latitude": 47.6205,
"longitude": -122.3493,
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"postalCode": "98121",
"region": "WA",
"type": "Home"
},
"shipToDiscount": 12.6,
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"shipToPrice": 20,
"shipToTaxTotal": 12.6,
"shipToType": "SHIP_TO_ADDRESS",
"shipToUnitPrice": 20,
"shipmentInstructions": "Handle with care",
"taxCode": "FR01",
"taxDetails": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
]
}
],
"statusCode": "ORDER_CREATED",
"statusDescription": "Order Created",
"subtype": "INTERNATIONAL",
"taxTotal": 12.34,
"type": "WEB",
"updatedAt": "2022-05-12T09:30:31.198Z",
"version": 2
}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
Details to create order
Items
Order item model
Unique identifier of item from fabric Products (PIM) service.
1234
Merchant-defined unique identifier for each item in an order. When omitted, fabric auto-generates this value during order creation, in UUID format.
"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
Merchant-defined line item number to identify each item in an order.
1
System-generated UUID associated with shipInfo, generated from CnC service. Note: An order can have multiple ship-to (delivery) locations and items going to the same location have one shipToId.
"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
Stock keeping unit (SKU), unique identifier of item.
"P1234"
Price adjustments are made to modify product prices during order creation, aiming to incentivize shoppers by offering discounts and promotions based on specified criteria. Price adjustments are also made to apply coupons that the shopper has used.
Details of price adjustment
Sequential or incremental counter for price adjustment
1
Adjustment amount
2.4
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs.
{
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}
Cancel quantity
2
Total quantity invoiced
10
Placeholder for additional info, if any.
"Any additional info"
Adjustment quantity
2
Reason code
"RFC"
Returned quantity of given item
1
Subreason code
"Late shipping"
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs
{
"colorCode": "001",
"isDonation": "false",
"style": "570223020"
}
Three-letter currency code as defined by ISO-4217
"USD"
Order discount
Discount amount for quantity
2.4
Promotion code used by shoppers to take advantage of an ongoing promotion and available.
"HNY2022"
Unique promotion ID either from fabric Offers service or external Offers service. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of Create promotion endpoint.
"HNY2022"
Promotion name
"New Year"
Discounted quantity of given item
2
Promotion type. There are no pre-defined values.
"promotion"
Discount offer - dollar value or percentage
"AMOUNT_OFF"
Discount value in amount or percentage
2
Employee (ID or name) who initiated the request
"62272e917b12209e68751d94"
Tax details
Tax amount
34.56
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Three-letter currency code as defined by ISO-4217
"USD"
Applied tax name
"STATE"
Rate
10
Rate type
"PERCENTAGE"
Tax code applied
"FR01"
true: Backordered item. false: Ordered item.
true
true: Item is a donation <br> false: Item is not a donation
true
true: Preordered item. false: Ordered item.
true
Item's total discount = summationOfAll(discounts[].amount)'. Refer to amountinorderDiscount`.
10
Recalculated item's fee = summationOfAll(fees[].amount). Refer to amount in itemFeeDetails
10
Item name
"Item"
Recalculated item's subtotal - Item unit price x (orderedQuantity - cancelledQuantity)
600
Subtype of type, for another layer of classification.
"Borderfree"
Recalculated total tax on item = summationOfAll(itemTaxTotal)
10
Recalculated item's total cost = itemSubTotal - itemDiscountTotal + itemTaxTotal + itemFeeTotal
10
Item's unit price
10
Notes section to be used by customer service representative (CSR) only
Note for attention
Time note was created (UTC)
"2022-05-12T09:30:31.198Z"
Additional info about the order, if any
"Fragile - handle with care"
Customer Service Representative or Employee (ID or name) who created the note
"62272e917b12209e68751d94"
Ordered quantity of given item
60
Segment
"P1234"
Applicable tax code, varies from state to state
"FR01"
Tax details
Tax amount
34.56
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Three-letter currency code as defined by ISO-4217
"USD"
Applied tax name
"STATE"
Rate
10
Rate type
"PERCENTAGE"
Tax code applied
"FR01"
Identify order type whether it's a pickup, web ship, or international order.
"WEB_SHIP"
Unit in which a product is sold or measured. It is important for accurately fulfilling orders and ensuring customers receive the correct quantity of products they have ordered. The possible values are EA (Each) or GAL (Gallon), DZ (Dozen), etc.
"EA"
Vendor ID
"P1234"
Merchant-defined order identifier. If omitted, this is generated by fabric's sequence generator using Configuration service.
"309019176"
Status code. Primarily used for Point-of-Sale (POS) orders.
"ORDER_CREATED"
Total price adjustments for all items of the order.
123.45
Price adjustments are made to modify product prices during order creation, aiming to incentivize shoppers by offering discounts and promotions based on specified criteria. Price adjustments are also made to apply coupons that the shopper has used.
Details of price adjustment
Sequential or incremental counter for price adjustment
1
Adjustment amount
2.4
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs.
{
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}
Cancel quantity
2
Total quantity invoiced
10
Placeholder for additional info, if any.
"Any additional info"
Adjustment quantity
2
Reason code
"RFC"
Returned quantity of given item
1
Subreason code
"Late shipping"
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
{
"fraudCheckStatus": "UPDATED",
"fraudStatus": "FRAUD_PASS"
}
Unique identifier of a cart, either from fabric Cart service or an external Cart service. It is used for linking an order to a specific cart. If available, it is also used for inventory reservation from cart workflow.
"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
Three-letter currency code as defined by ISO-4217
"USD"
Invoice customer
Customer's loyalty account ID or external identifier that is used to track their loyalty program activity and rewards earned.
"62272e917b12209e68751d94"
Shopper's company name. This may be used for company discounts.
"Demo Inc"
Contact person's email
"test@example.com"
Employee (ID or name) who initiated an update request
"62272e917b12209e68751d94"
Identifier of the logged in user who initiated the request. This could be from either fabric Identity service or an external Identity service.
"62272e917b12209e68751d94"
Discounts
Order discount
Discount amount for quantity
2.4
Promotion code used by shoppers to take advantage of an ongoing promotion and available.
"HNY2022"
Unique promotion ID either from fabric Offers service or external Offers service. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of Create promotion endpoint.
"HNY2022"
Promotion name
"New Year"
Discounted quantity of given item
2
Promotion type. There are no pre-defined values.
"promotion"
Discount offer - dollar value or percentage
"AMOUNT_OFF"
Discount value in amount or percentage
2
Employee (ID or name) who initiated the order creation request
"62272e917b12209e68751d94"
Total item fee = orderedQuantity * Item Fee Total
12.34
Fees
Fee details
Tax amount
34.56
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Three-letter currency code as defined by ISO-4217
"USD"
System-generated amount from Invoice service based on requested amount
34.56
Applied tax name
"STATE"
Rate
10
Rate type
"PERCENTAGE"
Tax code applied
"FR01"
Additional info, if any. To be used by customer service representative (CSR) only
Note for attention
Time note was created (UTC)
"2022-05-12T09:30:31.198Z"
Additional info about the order, if any
"Fragile - handle with care"
Customer Service Representative or Employee (ID or name) who created the note
"62272e917b12209e68751d94"
Order discount = summationOfAll(itemDiscountTotal)
1.23
Recalculated order subtotal = summationOfAll(itemSubTotal)
123.45
Total amount to be charged for the order = orderSubTotal - orderDiscountTotal + orderFeeTotal + orderTaxTotal
146.9
Merchant-defined order creation time (UTC). It is mandatory in the request body of Create Order endpoint - POST /orders.
"2022-05-12T09:30:31.198Z"
Payments
Payment details for order
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
{
"captureCurrencyCode": "USD",
"payerId": "M7AWTK3YK3B46",
"referenceId": "4DY41894J2904533S"
}
Expiration time for authorization
"2022-01-27T16:15:58-05:00"
Amount authorized to be debited from the given paymentMethod
123.2
Address details
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
"test@example.com"
Charged amount
60
Three-letter currency code as defined by ISO-4217
"USD"
System-generated time of payment capture at shipment. When payment is captured at checkout, this is a merchant-defined value during order creation.
"2022-01-27T16:15:58-05:00"
A sequential or incremental counter associated with a payment for an order. Applicable in refund scenarios to identify the specific payment for refund.
1
Details of payment mode and payment identifiers
Last 4 digits of the card
"3456"
Card expiration month
"12"
Card expiration year
"2029"
System-generated UUID referenced internally for Invoice and Orders services.
"f886c96c-5f65-11ed-9b6a-0242ac120002"
Merchant provided unique identifier for a payment based on payment connector. When omitted, it is a fabric-generated UUID.
"62272e917b12209e68751d94"
Payment method
"CREDIT_CARD"
Payment provider
"stripe"
Payment status. There are no pre-defined values; possible values are Paid, Partially Paid, Authorized, and Error.
"Paid"
Optionally used as reference, for orders created from Point-of-Sale systems
Merchant-defined cashier ID during order creation
"C-123"
Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.
334
Merchant-defined register ID during order creation
"113"
Transaction ID such as the Point-of-Sale system's version of the orderId.
"328942333412"
Shipping info
Order shipment details
System-generated UUID associated with shipInfo, generated from CnC service. Note: An order can have multiple ship-to (delivery) locations and items going to the same location have one shipToId.
"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
User defined custom attributes. This is a placeholder for additional info (in key: value pairs).
{ "giftMessage": "[]" }
Details of shipping discount
Discounted amount for the given quantity
2.99
Promotion code used by shoppers to take advantage of an ongoing promotion.
"SHIPFREE"
Unique promotion ID either from fabric Offers service or an external Offers service. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of the create promotion endpoint.
"SHIPFREE"
Promotion name
"Free Shipping"
Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.
1
Indicates whether the discount is in amount or percentage
"AMOUNT_OFF"
Value corresponding to unit
10
Estimated delivery time (UTC) provided by carrier
"2022-05-12T09:30:31.198Z"
Estimated shipping time (UTC) provided by merchant
"2022-05-12T09:30:31.198Z"
true: At least one captured invoice is created by Invoice service. false: Captured invoice is not created.
true
Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.
"123"
Order pickup details
Order pickup details
Contact person's email
"test@example.com"
Order pickup type
PRIMARY, ALTERNATE "PRIMARY"
Shipping method
"Parcel post delivery"
Address details
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
"test@example.com"
Merchant-defined shipping discount amount
12.6
Merchant-defined shipping cost
20
Total shipping tax
12.6
Type of shipping address. There are no pre-defined values; the possible values are SDD (Same Day Delivery), Point-of-Sale (POS), etc.
"SHIP_TO_ADDRESS"
A number indicating the ship to unit price.
20
Shipment instructions
"Handle with care"
Applicable tax code, varies from state to state
"FR01"
Tax details
Tax amount
34.56
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Three-letter currency code as defined by ISO-4217
"USD"
Applied tax name
"STATE"
Rate
10
Rate type
"PERCENTAGE"
Tax code applied
"FR01"
Description corresponding to statusCode
"Order Created"
Order subtype, for additional classification
IOS, ANDROID, INTERNATIONAL "INTERNATIONAL"
Total tax on order = summationOfAll(itemTaxTotal)+summationOfAll(tax[].value)
12.34
Order type. It is critical for order life cycle as it indicates the workflow that varies with the type. For example, Storefront orders have different workflows than Call Center orders. fabric Orders service offers standard configurations for Storefront, Call Center, Point of Sale, iOS, Android, and International.
WEB, CSC, MOBILE_APP, POS "WEB"
Response
Order details
Sales channel ID
"12"
Item details
Item details
System-generated unique identifier of item from fabric Products (PIM) service
1234
Merchant-defined unique identifier for each item in an order. When omitted, fabric will generate it (in UUID format) during order creation.
"d538b1f1-0e45-43c6-bfc6-9666fc1188ca"
Merchant-defined line item number to identify each item in an order
1
System-generated ship-to ID (UUID) associated with shipInfo, generated from CnC service. Note: An order can have multiple ship-to (delivery) locations and items going to the one location will have the same shipToId.
"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
Stock keeping unit (SKU), unique identifier of item
"P1234"
Price adjustments are made to modify product prices during order creation, aiming to incentivize shoppers by offering discounts and promotions based on specified criteria. Price adjustments are also made to apply coupons that the shopper has used.
Details of price adjustment
Sequential or incremental counter for price adjustment
1
Adjustment amount
2.4
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs.
{
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}
Cancel quantity
2
Total quantity invoiced
10
Placeholder for additional info, if any.
"Any additional info"
Adjustment quantity
2
Reason code
"RFC"
Returned quantity of given item
1
Subreason code
"Late shipping"
Appeasement total = summationOfAll(appeasements[].amount and items[].appeasements[].amount)
5.5
Appeasement info
Appeasement details
Merchant-defined appeasement amount, which should not exceed (charged amount - already refunded amount)
34.56
Sequential or incremental counter for appeasement. Used for keeping track of duplicates in the request. If omitted in the request, it is automatically generated and will not be used to check duplicates. Multiple appeasement calls for the same order can cause repetition of appeasement counter and may cause the request to be rejected completely.
1
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs
{
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}
System-generated amount from Invoice service based on requested amount
34.56
Merchant-defined appeasement reason code; varies from merchant to merchant
"Incorrect Item"
Subreason code for appeasement, for another layer of classification
"Late shipping"
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
{
"colorCode": "001",
"isDonation": "false",
"style": "570223020"
}
Backordered quantity of given item
10
Cancelled amount is either voided (payment is only authorized but not captured at checkout) or refunded (amount is authorized and captured at checkout)
12.4
Cancelled quantity of an item
10
Sales channel ID
"WHBM"
Three-letter currency code as defined by ISO-4217
"USD"
Delivered quantity of an item
10
Discount details
Details of order discount
Discounted amount for the given quantity
2.99
Total quantity invoiced. If customer placed order for 10 quantity of an item and only 2 got shipped, then 2 is the invoiceQuantity.
10
Promotion code used by shoppers to take advantage of an ongoing promotion.
"HNY2022"
Unique promotion ID either from fabric Offers service or external Offers service. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of create promotion endpoint.
"HNY2022"
Promotion name
"New Year"
Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.
1
Indicates whether the discount is in amount or percentage
"AMOUNT_OFF"
Value corresponding to unit
10
Employee (ID or name) who initiated the request
"5345HJH"
System-generated item quantity that are exchanged
13
Fee details
Details of item fees
Tax amount
34.56
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Three-letter currency code as defined by ISO-4217
"USD"
Total quantity invoiced. If customer placed order for 10 quantity of an item and only 2 got shipped then 2 is the invoiceQuantity
10
Applied tax name
"STATE"
Total number of items in the order
12
Total refund amount
21.5
Tax code applied
"FR01"
Applicable for backorder and preorder scenarios where customer consents for further delay in delivery of preordered and backordered items than the initial estimate. true: Customer consents for delayed delivery. false: Customer does not consent for delayed delivery.
true
Invoice total is updated once invoice created
800
Invoiced quantity of an item
10
Merchant-defined value. true: Backordered item. false: Ordered item.
true
true: Item is a donation. false: Item is not a donation.
true
Merchant-defined value for exchange scenarios. true: Item is an exchange. false: Item is not an exchange.
true
true: Item is a gift. false: Item is not a gift.
true
Merchant-defined value. true: Pre-ordered item. false: Ordered item.
true
Total price adjustment made to the item.
123.45
Item's total discount = summationOfAll(discounts[].amount)'. Refer to amountinorderDiscount`
80
Recalculated item's fee = summationOfAll(itemFeeTotal). Refer to amount in itemFeeDetails
200
Item name
"Item"
Merchant-defined item's shipping total
10
Recalculated item's subtotal = itemUnitPrice x (orderedQuantity - cancelledQuantity)
600
Subtype of type, for another layer of classification
"Borderfree"
Recalculated total tax on item = summationOfAll(itemTaxTotal)
80
Recalculated item's total cost = itemSubTotal - itemDiscountTotal + itemTaxTotal + itemFeeTotal
800
Item's unit price
10
System-generated status for each item in the orders - SHIPPED, RETURNED, CANCELLED, EXCHANGED, VALID, and the like
"VALID"
For additional information, to be used by Customer Service Representative (CSR) only
Note for attention
Time note was created (UTC)
"2022-05-12T09:30:31.198Z"
Additional info about the order, if any
"Fragile - handle with care"
Customer Service Representative or Employee (ID or name) who created the note
"62272e917b12209e68751d94"
Ordered quantity of given item
60
Quantity of given item that is yet to ship, out of the initially allocated quantity. For example, if a customer orders four units of an item, inventory will reserve four units of the item. If only two units are currently available and are shipped, the remaining two units will be considered as the pendingShippedQuantity.
10
System-generated total discount, auto-filled by Orders service when the order is placed
50
System-generated fee total, auto-filled by Orders service when the order is placed. This is saved for reference in case the value changes later.
300
System-generated total discount, auto-filled by Orders service when the order is placed
800
System-generated item total cost, auto-filled by Orders service when the order is placed
500
System-generated total shipping cost, auto-filled by Orders service when the order is placed
80
System-generated total tax, auto-filled by Orders service when the order is placed
90
Applicable in exchange scenarios. Item being returned is the parentLineItemNumber.
12
System-generated item quantity pending for exchange
12
Quantity of an item awaiting approval for return. For example, when customer initiates return request for 2 units of an item, the request will be initially in a pending status because they are awaiting approval from merchant. They are referred to as pendingReturnQuantity.
10
Backordered quantity that is yet to be shipped. For example, If a customer places a backorder for four units of an item, inventory will reserve four units of the item to ship when they become available. If only two units are available and are shipped, the remaining two backordered units will be considered as the pendingShippedBackOrderQuantity.
10
Quantity of an item currently being processed for return. For example, when merchant approves return of 1 out of 2 units of an item, then 1 is the processingReturnQuantity
10
Item quantity for each status
Cancelled quantity of given item
10
Ordered quantity of given item
10
Delivered quantity of given item
10
Held quantity of given item
10
Pending quantity of given item
10
Returned quantity of given item
10
Shipped quantity of given item
10
Merchant-defined total refund amount
21.5
Quantity of an item rejected in return request. For example, For example, when merchant rejects return of 1 out of 2 units of an item, then 1 is the rejectedReturnQuantity
10
Reshipped quantity of given item (in case of lost shipment)
10
Returned quantity of given item
10
Order return details
Order return details
Exchange line item ID
"62f3dfc438bcab1951be0a19"
Return fee details
Merchant-defined return amount
34.56
Fee name
"RETURN_FEE"
Merchant-defined return reason
"Return fee"
Return fee type
TAX, DISCOUNT, FEE, ITEM, ADJUSTMENT "FEE"
System-generated amount from Invoice service based on requested amount
11.29
true: Item received for exchange is returned. false: Item received for exchange is not returned.
true
Merchant-defined reason code for return
"Incorrect item"
Refund amount
11.29
Return fee details
Merchant-defined return amount
34.56
Fee name
"RETURN_FEE"
Merchant-defined return reason
"Return fee"
Return fee type
TAX, DISCOUNT, FEE, ITEM, ADJUSTMENT "FEE"
Unique, sequential, or incremental counter for return request
1
System-generated time of returned item that has come back to the facility (UTC)
"2022-09-14T14:07:36.861Z"
24-character system-generated shipment ID
"62b37697c67b204dd18a7465"
Shipment Invoice resource
Unique Id of the invoice
"62ff5c0bec0aed3c86202c32"
Unique number of the invoice
"23940791"
Date when order invoiced
"2022-08-01T20:03:28.483971941Z"
Unique identifier for each item in the shipment
"234"
Shipped quantity of given item
1
Shipped quantity of an item
10
Applicable tax code, varies from state to state
"FR01"
Tax details
Tax details
Tax amount
34.56
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Three-letter currency code as defined by ISO-4217
"USD"
Applied tax name
"STATE"
Rate
10
Rate type
"PERCENTAGE"
Tax code applied
"FR01"
Order type. Critical in order life cycle as it indicates the workflow that varies with the type. For example, Storefront orders have a different workflow than Call Center orders. fabric Orders service offers default configurations for Storefront, Call Center, Point of Sale, iOS, Android, and International.
"WEB_SHIP"
Unit in which a product is sold or measured. It is important to accurately fulfill orders and ensure customers receive the correct quantity of products they have ordered. The possible values are EA (Each) or GAL (Gallon), DZ (Dozen), etc.
"EA"
Vendor ID. Applicable in drop shipping to indicate vendor responsible for given item.
"P1234"
Merchant-defined order identifier. If omitted, this is generated by fabric's sequence generator using Configuration service
"309019176"
Order shipment details
System-generated UUID associated with shipInfo, generated from CnC service. Note: An order can have multiple ship-to (delivery) locations and items going to the same location have one shipToId.
"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
User defined custom attributes. This is a placeholder for additional info (in key: value pairs).
{ "giftMessage": "[]" }
Details of shipping discount
Discounted amount for the given quantity
2.99
Promotion code used by shoppers to take advantage of an ongoing promotion.
"SHIPFREE"
Unique promotion ID either from fabric Offers service or an external Offers service. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of the create promotion endpoint.
"SHIPFREE"
Promotion name
"Free Shipping"
Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.
1
Indicates whether the discount is in amount or percentage
"AMOUNT_OFF"
Value corresponding to unit
10
Estimated delivery time (UTC) provided by carrier
"2022-05-12T09:30:31.198Z"
Estimated shipping time (UTC) provided by merchant
"2022-05-12T09:30:31.198Z"
true: At least one captured invoice is created by Invoice service. false: Captured invoice is not created.
true
Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.
"123"
Order pickup details
Order pickup details
Contact person's email
"test@example.com"
Order pickup type
PRIMARY, ALTERNATE "PRIMARY"
Shipping method
"Parcel post delivery"
Address details
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
"test@example.com"
Merchant-defined shipping discount amount
12.6
Merchant-defined shipping cost
20
Total shipping tax
12.6
Type of shipping address. There are no pre-defined values; the possible values are SDD (Same Day Delivery), Point-of-Sale (POS), etc.
"SHIP_TO_ADDRESS"
A number indicating the ship to unit price.
20
Shipment instructions
"Handle with care"
Applicable tax code, varies from state to state
"FR01"
Tax details
Tax amount
34.56
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Three-letter currency code as defined by ISO-4217
"USD"
Applied tax name
"STATE"
Rate
10
Rate type
"PERCENTAGE"
Tax code applied
"FR01"
Status code. There are no pre-defined values; possible values are - ORDER_ALLOCATED ("Order Allocated"), ORDER_SHIPPED ("Order Shipped"), ORDER_PARTIALLY_SHIPPED ("Order Partially Shipped"), ORDER_PICKED_UP ("Order Picked Up"), ORDER_PARTIALLY_PICKED_UP ("Order Partially Picked Up"), ORDER_DELIVERED ("Order Delivered"), ORDER_PARTIALLY_DELIVERED ("Order Partially Delivered"), ORDER_RETURNED ("Order Returned"), etc.
"ORDER_CREATED"
Current version of order document. Indicates the number of times the order is updated by any operation.
2
The total amount of price adjustments for all items of the order.
123.45
Price adjustments refer to changes or modifications made to the listed price of a product. A Customer Sales Representative (CSR) makes the price adjustments to provide discounts, promotional offers, or coupons that the shopper used.
Details of price adjustment
Sequential or incremental counter for price adjustment
1
Adjustment amount
2.4
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs.
{
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}
Cancel quantity
2
Total quantity invoiced
10
Placeholder for additional info, if any.
"Any additional info"
Adjustment quantity
2
Reason code
"RFC"
Returned quantity of given item
1
Subreason code
"Late shipping"
System-generated order allocation time (UTC) once the order is allocated using Allocation service
"2022-05-12T09:30:31.198Z"
Final appeasement amount
12.34
Appeasement details
Merchant-defined appeasement amount, which should not exceed (charged amount - already refunded amount)
34.56
Sequential or incremental counter for appeasement. Used for keeping track of duplicates in the request. If omitted in the request, it is automatically generated and will not be used to check duplicates. Multiple appeasement calls for the same order can cause repetition of appeasement counter and may cause the request to be rejected completely.
1
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs
{
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}
System-generated amount from Invoice service based on requested amount
34.56
Merchant-defined appeasement reason code; varies from merchant to merchant
"Incorrect Item"
Subreason code for appeasement, for another layer of classification
"Late shipping"
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
{
"fraudCheckStatus": "UPDATED",
"loyaltyStatus": "N"
}
Audit log to capture change history
Amount for which audit is done
2.4
Custom attributes
{ "key": "value" }
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"
true: Update operation (any update to the service) is successful false: Update operation has failed
true
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"
Item identifier
1
Additional info, if any
"Note"
Configurable in Copilot as per requirement. If omitted, default policy is used.
"POS"
Ordered quantity of given item
1
Merchant-defined reason code, varies from merchant to merchant
"Scratched item"
Stock keeping unit (SKU), unique item identifier
"SKU0023"
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"
Amount to be returned after order cancellation, calculated as cancelledQuantity / orderedQuantity * itemTotal
12.34
System-generated order cancellation time (UTC). This is returned in the response of Cancel order by ID - POST /orders/{orderId}/actions/cancel or Cancel order by order number - POST /orders/order-number/{orderNumber}/actions/cancel once the order is successfully cancelled.
"2022-05-12T09:30:31.198Z"
Unique cart identifier, either from fabric Cart service or an external Cart service. It is used for linking an order to a specific cart. If available, it is also used for inventory reservation from cart workflow.
"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
Order creation time (UTC)
"2022-05-12T09:30:31.198Z"
Three-letter currency code as defined by ISO-4217
"USD"
Invoice customer
Customer's loyalty account ID or external identifier that is used to track their loyalty program activity and rewards earned.
"62272e917b12209e68751d94"
Shopper's company name. This may be used for company discounts.
"Demo Inc"
Contact person's email
"test@example.com"
Employee (ID or name) who initiated an update request
"62272e917b12209e68751d94"
Identifier of the logged in user who initiated the request. This could be from either fabric Identity service or an external Identity service.
"62272e917b12209e68751d94"
Details of order discount
Discounted amount for the given quantity
2.99
Total quantity invoiced. If customer placed order for 10 quantity of an item and only 2 got shipped, then 2 is the invoiceQuantity.
10
Promotion code used by shoppers to take advantage of an ongoing promotion.
"HNY2022"
Unique promotion ID either from fabric Offers service or external Offers service. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of create promotion endpoint.
"HNY2022"
Promotion name
"New Year"
Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.
1
Indicates whether the discount is in amount or percentage
"AMOUNT_OFF"
Value corresponding to unit
10
Employee (ID or name) who initiated the request
"43278"
An object containing information on error fields, error messages, and the amended status.
A boolean that signifies if the error has been amended.
false
The reason the error occurred.
"Invalid email address"
The name of the field where the error occurred.
"shipInfo.shipToAddress.email"
Recalculated total fee, calculated as orderedQuantity* itemFeeTotal
12.34
Fee details
Tax amount
34.56
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Three-letter currency code as defined by ISO-4217
"USD"
System-generated amount from Invoice service based on requested amount
34.56
Applied tax name
"STATE"
Rate
10
Rate type
"PERCENTAGE"
Tax code applied
"FR01"
Total payment captured by fabric Invoice service. If merchant is using third-party service, then this amount will be null. For partial payment scenarios, this value will be different from orderTotal.
12.34
Note for attention
Time note was created (UTC)
"2022-05-12T09:30:31.198Z"
Additional info about the order, if any
"Fragile - handle with care"
Customer Service Representative or Employee (ID or name) who created the note
"62272e917b12209e68751d94"
Recalculated order discount
1.23
24-character system-generated order ID
"5349b4ddd2781d08c09890f4"
Order released time (UTC). When an order is placed, its status is On Hold by default and the duration of hold may vary from merchant to merchant (~1 min). After the hold period, the order is released from hold.
"2022-05-12T09:30:31.198Z"
Recalculated orderSubtotal - summationOfAll(itemSubTotal)
123.45
Total amount to be charged for the order = orderSubTotal - orderDiscountTotal + orderFeeTotal + orderTaxTotal
146.9
Merchant-defined order creation time (UTC). It is mandatory in the request body of Create Order endpoint - POST /orders.
"2022-05-12T09:30:31.198Z"
System-generated total discount, auto-filled by Orders service when the order is placed. This is saved for reference in case the value changes later.
1.45
System-generated total fees, auto-filled by Orders service when the order is placed
12.34
System-generated order total, auto-filled by Orders service when the order is placed. This is saved for reference in case the orderTotal changes later.
146.9
System-generated order subtotal, auto-filled by Orders service when the order is placed. This is saved for reference in case the value changes later.
113.45
System-generated total tax, auto-filled by Orders service when the order is placed
12.34
Payment details
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
{
"captureCurrencyCode": "USD",
"payerId": "M7AWTK3YK3B46",
"referenceId": "4DY41894J2904533S"
}
An integer representing the number of payment authorization attempts.
0
Amount authorized to be debited from the given paymentMethod
123.2
Address details
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
"test@example.com"
Amount charged to the given paymentMethod
60
Three-letter currency code as defined by ISO-4217
"USD"
true: Payment is final capture. false: Payment is not a final capture.
false
true: Payment is partial capture. false: Payment is full capture.
false
System-generated time when payment was captured at shipment. In case of payment captured at checkout, this is a merchant-defined value given during order creation.
"2022-01-27T16:15:58-05:00"
A sequential or incremental counter associated with a payment for an order. Applicable in refund scenarios to identify the specific payment for refund.
1
Details of payment mode and payment identifiers
Last 4 digits of the card
"3456"
Card expiration month
"12"
Card expiration year
"2029"
System-generated UUID referenced internally for Invoice and Orders services.
"f886c96c-5f65-11ed-9b6a-0242ac120002"
Merchant provided unique identifier for a payment based on payment connector. When omitted, it is a fabric-generated UUID.
"62272e917b12209e68751d94"
Payment details
Payment information
Transaction amount for the payment operation
-12.4
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
{ "key": "value" }
Payment details
Payment info
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
{ "key": "value" }
Error details
Error map
Response code such as success, OK, or failure
"OK"
Payment status such as Authorized, Captured, etc.
"Authorized"
Transaction ID such as the point-of-sale system's version of the orderId.
"328942333412"
Transaction time (UTC) when the payment was successful
"2022-04-10T23:00:45:12.111Z"
Status code for payment. There are no pre-defined values; possible values are 200, 400, 402, etc.
"200"
ID provided by payment gateway in response to payment operation
"328942333412"
Merchant-provided unique identifier for a payment based on payment connector. When omitted, this value will be generated by fabric in UUID format.
"328942333412"
ID generated by fabric to uniquely identify the payment log
"328942333412"
Payment reference log ID with which this record is associated
"328942333412"
Payment status such as Authorized, Captured, etc.
"Authorized"
Transaction type such as VOID, CAPTURED, REDUND, etc.
"REFUND"
Payment method such as PayPal or credit card
"CREDIT_CARD"
Payment provider
"stripe"
Payment status. There are no pre-defined values; possible values are Paid, Partially Paid, Authorized, and Error.
"Paid"
An integer representing the number of payment reauthorization attempts.
0
Merchant-defined refund amount
21.5
Optionally used as reference, for orders created from Point-of-Sale systems
Merchant-defined cashier ID during order creation
"C-123"
Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.
334
Merchant-defined register ID during order creation
"113"
Transaction ID such as the Point-of-Sale system's version of the orderId.
"328942333412"
Return total of order, for return scenarios, calculated as summationOfAll(itemReturnTotal)
12.34
Order returns info
Return fee details
Merchant-defined return amount
34.56
Fee name
"RETURN_FEE"
Merchant-defined return reason
"Return fee"
Return fee type
TAX, DISCOUNT, FEE, ITEM, ADJUSTMENT "FEE"
System-generated invoiced amount for the return request
11.29
Return fee details
Merchant-defined return amount
34.56
Fee name
"RETURN_FEE"
Merchant-defined return reason
"Return fee"
Return fee type
TAX, DISCOUNT, FEE, ITEM, ADJUSTMENT "FEE"
Unique, sequential or incremental counter for return request
1
Merchant-defined total refund amount for the return request
11.29
Human-readable brief description based on statusCode
"Order Created"
Order subtype, for further classification
IOS, ANDROID, INTERNATIONAL "INTERNATIONAL"
Recalculated total tax on order summationOfAll(itemTaxTotal)+summationOf(tax[].value)
12.34
Order type. It is critical for order life cycle as it indicates the workflow that varies with the type. For example, Storefront orders have a different workflow than Call Center orders. fabric Orders service offers standard configurations for Storefront, Call Center, Point of Sale, iOS, Android, and International.
WEB, CSC, MOBILE_APP, POS "WEB"
Time of last update to order (UTC)
"2022-05-12T09:30:31.198Z"
Was this page helpful?
curl --request POST \
--url https://api.fabric.inc/v3/orders \
--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 '{
"adjustmentTotal": 123.45,
"adjustments": [
{
"adjustmentCounter": 1,
"amount": 2.4,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"cancelQuantity": 2,
"invoiceQuantity": 10,
"notes": "Any additional info",
"quantity": 2,
"reasonCode": "RFC",
"returnQuantity": 1,
"subReasonCode": "Late shipping"
}
],
"attributes": {
"fraudCheckStatus": "UPDATED",
"fraudStatus": "FRAUD_PASS"
},
"cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"currency": "USD",
"customer": {
"accountId": "62272e917b12209e68751d94",
"company": "Demo Inc",
"email": "test@example.com",
"employeeId": "62272e917b12209e68751d94",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94"
},
"discounts": [
{
"amount": 2.4,
"promotionCode": "HNY2022",
"promotionId": "HNY2022",
"promotionName": "New Year",
"quantity": 2,
"type": "promotion",
"unit": "AMOUNT_OFF",
"value": 2
}
],
"employeeId": "62272e917b12209e68751d94",
"feeTotal": 12.34,
"fees": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"invoicedAmount": 34.56,
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
],
"items": [
{
"adjustments": [
{
"adjustmentCounter": 1,
"amount": 2.4,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"cancelQuantity": 2,
"invoiceQuantity": 10,
"notes": "Any additional info",
"quantity": 2,
"reasonCode": "RFC",
"returnQuantity": 1,
"subReasonCode": "Late shipping"
}
],
"attributes": {
"colorCode": "001",
"isDonation": "false",
"style": "570223020"
},
"currency": "USD",
"discounts": [
{
"amount": 2.4,
"promotionCode": "HNY2022",
"promotionId": "HNY2022",
"promotionName": "New Year",
"quantity": 2,
"type": "promotion",
"unit": "AMOUNT_OFF",
"value": 2
}
],
"employeeId": "62272e917b12209e68751d94",
"fees": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
],
"isBackorder": true,
"isDonation": true,
"isPreorder": true,
"itemDiscountsTotal": 10,
"itemFeeTotal": 10,
"itemId": 1234,
"itemName": "Item",
"itemSubtotal": 600,
"itemSubtype": "Borderfree",
"itemTaxTotal": 10,
"itemTotal": 10,
"itemUnitPrice": 10,
"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"lineItemNumber": 1,
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"notes": "Fragile - handle with care",
"user": "62272e917b12209e68751d94"
}
],
"orderedQuantity": 60,
"segment": "P1234",
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"sku": "P1234",
"taxCode": "FR01",
"taxDetails": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
],
"type": "WEB_SHIP",
"uom": "EA",
"vendorId": "P1234"
}
],
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"notes": "Fragile - handle with care",
"user": "62272e917b12209e68751d94"
}
],
"orderDiscount": 1.23,
"orderNumber": "309019176",
"orderSubtotal": 123.45,
"orderTotal": 146.9,
"orderedAt": "2022-05-12T09:30:31.198Z",
"payments": [
{
"attributes": {
"captureCurrencyCode": "USD",
"payerId": "M7AWTK3YK3B46",
"referenceId": "4DY41894J2904533S"
},
"authorizationExpirationDate": "2022-01-27T16:15:58-05:00",
"authorizedAmount": 123.2,
"billToAddress": {
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"countryCode": "US",
"email": "test@example.com",
"latitude": 47.6205,
"longitude": -122.3493,
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"postalCode": "98121",
"region": "WA",
"type": "Home"
},
"chargedAmount": 60,
"currency": "USD",
"paidAt": "2022-01-27T16:15:58-05:00",
"paymentCounter": 1,
"paymentIdentifier": {
"cardIdentifier": "3456",
"expirationMonth": "12",
"expirationYear": "2029",
"fabricPaymentReference": "f886c96c-5f65-11ed-9b6a-0242ac120002",
"paymentId": "62272e917b12209e68751d94"
},
"paymentMethod": "CREDIT_CARD",
"paymentProvider": "stripe",
"paymentStatus": "Paid",
"paymentToken": {
"paymentType": "VISA",
"token": "pi_34tr6787rt"
}
}
],
"retail": {
"cashierId": "C-123",
"locationNumber": 334,
"registerId": "113",
"transactionId": "328942333412"
},
"shipInfo": [
{
"attributes": {
"giftMessage": "[]"
},
"discounts": [
{
"amount": 2.99,
"promotionCode": "SHIPFREE",
"promotionId": "SHIPFREE",
"promotionName": "Free Shipping",
"quantity": 1,
"unit": "AMOUNT_OFF",
"value": 10
}
],
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"isInvoiced": true,
"locationNumber": "123",
"pickups": [
{
"email": "test@example.com",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"pickupType": "PRIMARY"
}
],
"shipMethod": "Parcel post delivery",
"shipToAddress": {
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"countryCode": "US",
"email": "test@example.com",
"latitude": 47.6205,
"longitude": -122.3493,
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"postalCode": "98121",
"region": "WA",
"type": "Home"
},
"shipToDiscount": 12.6,
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"shipToPrice": 20,
"shipToTaxTotal": 12.6,
"shipToType": "SHIP_TO_ADDRESS",
"shipToUnitPrice": 20,
"shipmentInstructions": "Handle with care",
"taxCode": "FR01",
"taxDetails": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
]
}
],
"statusCode": "ORDER_CREATED",
"statusDescription": "Order Created",
"subtype": "INTERNATIONAL",
"taxTotal": 12.34,
"type": "WEB"
}'{
"adjustmentTotal": 123.45,
"adjustments": [
{
"adjustmentCounter": 1,
"amount": 2.4,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"cancelQuantity": 2,
"invoiceQuantity": 10,
"notes": "Any additional info",
"quantity": 2,
"reasonCode": "RFC",
"returnQuantity": 1,
"subReasonCode": "Late shipping"
}
],
"allocatedAt": "2022-05-12T09:30:31.198Z",
"appeasementTotal": 12.34,
"appeasements": [
{
"amount": 34.56,
"appeasementCounter": 1,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"invoicedAmount": 34.56,
"payments": [
{
"paymentCounter": 1,
"refundAmount": 34.56
}
],
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping"
}
],
"attributes": {
"fraudCheckStatus": "UPDATED",
"loyaltyStatus": "N"
},
"auditLogs": [
{
"amount": 2.4,
"attributes": {
"key": "value"
},
"auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
"auditType": "CANCEL",
"auditedAt": "2023-03-12T09:24:54.804Z",
"employeeId": "6227",
"isSuccess": true,
"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"lineItemNumber": 1,
"note": "Note",
"paymentToken": {
"paymentType": "VISA",
"token": "pi_34tr6787rt"
},
"policyCode": "POS",
"quantity": 1,
"reasonCode": "Scratched item",
"sku": "SKU0023",
"source": "POS",
"subReasonCode": "Scratched item",
"updatedFields": [
{
"fieldName": "UOM",
"fieldOriginalValue": "PK"
}
]
}
],
"cancelTotal": 12.34,
"cancelledAt": "2022-05-12T09:30:31.198Z",
"cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"channelId": "12",
"createdAt": "2022-05-12T09:30:31.198Z",
"currency": "USD",
"customer": {
"accountId": "62272e917b12209e68751d94",
"company": "Demo Inc",
"email": "test@example.com",
"employeeId": "62272e917b12209e68751d94",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94"
},
"discounts": [
{
"amount": 2.99,
"invoiceQuantity": 10,
"promotionCode": "HNY2022",
"promotionId": "HNY2022",
"promotionName": "New Year",
"quantity": 1,
"unit": "AMOUNT_OFF",
"value": 10
}
],
"employeeId": "43278",
"erroredFields": [
{
"amended": false,
"errorMessage": "Invalid email address",
"fieldName": "shipInfo.shipToAddress.email"
}
],
"feeTotal": 12.34,
"fees": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"invoicedAmount": 34.56,
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
],
"invoiceTotal": 12.34,
"items": [
{
"adjustments": [
{
"adjustmentCounter": 1,
"amount": 2.4,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"cancelQuantity": 2,
"invoiceQuantity": 10,
"notes": "Any additional info",
"quantity": 2,
"reasonCode": "RFC",
"returnQuantity": 1,
"subReasonCode": "Late shipping"
}
],
"appeasementTotal": 5.5,
"appeasements": [
{
"amount": 34.56,
"appeasementCounter": 1,
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
},
"invoicedAmount": 34.56,
"payments": [
{
"paymentCounter": 1,
"refundAmount": 34.56
}
],
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping"
}
],
"attributes": {
"colorCode": "001",
"isDonation": "false",
"style": "570223020"
},
"backOrderedQuantity": 10,
"cancelledAmount": 12.4,
"cancelledQuantity": 10,
"channelId": "WHBM",
"currency": "USD",
"deliveredQuantity": 10,
"discounts": [
{
"amount": 2.99,
"invoiceQuantity": 10,
"promotionCode": "HNY2022",
"promotionId": "HNY2022",
"promotionName": "New Year",
"quantity": 1,
"unit": "AMOUNT_OFF",
"value": 10
}
],
"employeeId": "5345HJH",
"exchangeQuantity": 13,
"fees": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"invoiceQuantity": 10,
"name": "STATE",
"quantity": 12,
"refundAmount": 21.5,
"taxCode": "FR01"
}
],
"hasInfiniteConsent": true,
"invoiceTotal": 800,
"invoicedQuantity": 10,
"isBackorder": true,
"isDonation": true,
"isExchangeItem": true,
"isGifting": true,
"isPreorder": true,
"itemAdjustmentTotal": 123.45,
"itemDiscountsTotal": 80,
"itemFeeTotal": 200,
"itemId": 1234,
"itemName": "Item",
"itemShippingTotal": 10,
"itemSubtotal": 600,
"itemSubtype": "Borderfree",
"itemTaxTotal": 80,
"itemTotal": 800,
"itemUnitPrice": 10,
"lineItemId": "d538b1f1-0e45-43c6-bfc6-9666fc1188ca",
"lineItemNumber": 1,
"lineOrderStatus": "VALID",
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"notes": "Fragile - handle with care",
"user": "62272e917b12209e68751d94"
}
],
"orderedQuantity": 60,
"orderedQuantityToShip": 10,
"originalDiscounts": 50,
"originalFeeTotal": 300,
"originalItemSubtotal": 800,
"originalItemTotal": 500,
"originalShippingTotal": 80,
"originalTaxTotal": 90,
"parentLineItemNumber": 12,
"pendingExchangeQuantity": 12,
"pendingReturnQuantity": 10,
"pendingShippedBackOrderQuantity": 10,
"processingReturnQuantity": 10,
"quantityInStatus": {
"cancelled": 10,
"created": 10,
"delivered": 10,
"hold": 10,
"pendingShipped": 10,
"returned": 10,
"shipped": 10
},
"refundAmount": 21.5,
"rejectedReturnQuantity": 10,
"reshippedQuantity": 10,
"returnedQuantity": 10,
"returns": [
{
"exchangeLineItemId": "62f3dfc438bcab1951be0a19",
"fees": [
{
"amount": 34.56,
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"invoicedAmount": 11.29,
"isExchangeItemReturned": true,
"reasonCode": "Incorrect item",
"refundAmount": 11.29,
"refunds": [
{
"amount": 34.56,
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnRequestCounter": 1,
"returnsReceivedAt": "2022-09-14T14:07:36.861Z",
"shipmentId": "62b37697c67b204dd18a7465",
"shipmentInvoice": {
"invoiceId": "62ff5c0bec0aed3c86202c32",
"invoiceNumber": "23940791",
"invoicedAt": "2022-08-01T20:03:28.483971941Z"
},
"shipmentLineItemId": "234",
"shipmentQuantity": 1
}
],
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"shippedQuantity": 10,
"sku": "P1234",
"taxCode": "FR01",
"taxDetails": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
],
"type": "WEB_SHIP",
"uom": "EA",
"vendorId": "P1234"
}
],
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"notes": "Fragile - handle with care",
"user": "62272e917b12209e68751d94"
}
],
"orderDiscount": 1.23,
"orderId": "5349b4ddd2781d08c09890f4",
"orderNumber": "309019176",
"orderReleasedAt": "2022-05-12T09:30:31.198Z",
"orderSubtotal": 123.45,
"orderTotal": 146.9,
"orderedAt": "2022-05-12T09:30:31.198Z",
"originalDiscount": 1.45,
"originalFeeTotal": 12.34,
"originalOrderTotal": 146.9,
"originalSubtotal": 113.45,
"originalTaxTotal": 12.34,
"payments": [
{
"attributes": {
"captureCurrencyCode": "USD",
"payerId": "M7AWTK3YK3B46",
"referenceId": "4DY41894J2904533S"
},
"authorizationAttempts": 0,
"authorizedAmount": 123.2,
"billToAddress": {
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"countryCode": "US",
"email": "test@example.com",
"latitude": 47.6205,
"longitude": -122.3493,
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"postalCode": "98121",
"region": "WA",
"type": "Home"
},
"chargedAmount": 60,
"currency": "USD",
"isFinalCapture": false,
"isPartialCapture": false,
"paidAt": "2022-01-27T16:15:58-05:00",
"paymentCounter": 1,
"paymentIdentifier": {
"cardIdentifier": "3456",
"expirationMonth": "12",
"expirationYear": "2029",
"fabricPaymentReference": "f886c96c-5f65-11ed-9b6a-0242ac120002",
"paymentId": "62272e917b12209e68751d94"
},
"paymentLogs": [
{
"amount": -12.4,
"attributes": {
"key": "value"
},
"data": {
"body": {
"attributes": {
"key": "value"
},
"errors": [
{
"key": "value"
}
],
"responseCode": "OK",
"status": "Authorized",
"transactionId": "328942333412",
"transactionTimestamp": "2022-04-10T23:00:45:12.111Z"
},
"paymentStatusCode": "200"
},
"id": "328942333412",
"paymentId": "328942333412",
"paymentLogId": "328942333412",
"paymentLogRefId": "328942333412",
"status": "Authorized",
"type": "REFUND"
}
],
"paymentMethod": "CREDIT_CARD",
"paymentProvider": "stripe",
"paymentStatus": "Paid",
"paymentToken": {
"paymentType": "VISA",
"token": "pi_34tr6787rt"
},
"reauthorizationAttempts": 0,
"refundAmount": 21.5
}
],
"retail": {
"cashierId": "C-123",
"locationNumber": 334,
"registerId": "113",
"transactionId": "328942333412"
},
"returnTotal": 12.34,
"returns": [
{
"fees": [
{
"amount": 34.56,
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"invoicedAmount": 11.29,
"paymentCounterRefundDetails": [
{
"amount": 34.56,
"paymentCounter": 1
}
],
"refunds": [
{
"amount": 34.56,
"name": "RETURN_FEE",
"reason": "Return fee",
"type": "FEE"
}
],
"returnCounter": 1,
"totalRefundAmount": 11.29
}
],
"shipInfo": [
{
"attributes": {
"giftMessage": "[]"
},
"discounts": [
{
"amount": 2.99,
"promotionCode": "SHIPFREE",
"promotionId": "SHIPFREE",
"promotionName": "Free Shipping",
"quantity": 1,
"unit": "AMOUNT_OFF",
"value": 10
}
],
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"isInvoiced": true,
"locationNumber": "123",
"pickups": [
{
"email": "test@example.com",
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"pickupType": "PRIMARY"
}
],
"shipMethod": "Parcel post delivery",
"shipToAddress": {
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"countryCode": "US",
"email": "test@example.com",
"latitude": 47.6205,
"longitude": -122.3493,
"name": {
"firstName": "Alex",
"lastName": "Doe",
"middleName": "E"
},
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"postalCode": "98121",
"region": "WA",
"type": "Home"
},
"shipToDiscount": 12.6,
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"shipToPrice": 20,
"shipToTaxTotal": 12.6,
"shipToType": "SHIP_TO_ADDRESS",
"shipToUnitPrice": 20,
"shipmentInstructions": "Handle with care",
"taxCode": "FR01",
"taxDetails": [
{
"amount": 34.56,
"attributes": {},
"currency": "USD",
"name": "STATE",
"rate": 10,
"rateType": "PERCENTAGE",
"taxCode": "FR01"
}
]
}
],
"statusCode": "ORDER_CREATED",
"statusDescription": "Order Created",
"subtype": "INTERNATIONAL",
"taxTotal": 12.34,
"type": "WEB",
"updatedAt": "2022-05-12T09:30:31.198Z",
"version": 2
}