- Support
- Product Releases
- Blog
- Overview
- API References
- API Authentication
- Getting Started with fabric APIs
- Making your first API request
- Example
- Using Developer Portal
- Security and Compliance
- Product Catalog API - Overview
- Developer Guide
Attributes & Attribute Mapping
Categories
Products
Collections
Background Jobs
Bulk Import & Export
Published Products
Allocations
- Orders (3.0.0)
Backorders Preorders
Exports
Developer Guide
Invoices
Shopping Lists
Shopping List Items
Notifications
Orders
- Overview
- POSTUpdate Shipping information for an existing order by order ID
- POSTUpdate Shipping information for an existing order by order number
- POSTUpdate customer details for given order IDs
- GETGet order by order number
- GETGet order by order ID
- POSTCreate new order
- PUTUpdates order pick-up details
- POSTFind orders
Returns
Cancellations
Tracking
Frauds
Payments
Appeasements
Credits
Shipments
Shipping Methods
Shipping Method Items
Webhooks
- Orders FAQ(s)
- Overview
- Algolia standard integration
- Avalara standard integration
- Constructor.io standard integration
- Stripe standard integration
- Offers (3.0.0)
Real-time Pricing Engine
Promotions
Webhook Events
Redemptions
Priced Products
Product Exclusion Lists
Price Types
Coupons
Coupon Codes
Segments
Prices
Price Methods
Price Controls
Price Lists
Add-ons
Exports
Imports
Attributes
Customer Profile
Customer Address
Customer Self
Getting Started
Product Catalog
Orders
Integrations
Offers
Customers
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.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Merchant's 24-character tenant ID
Sales channel ID
Unique request ID
Details to create order
Merchant-defined order identifier. If omitted, this is generated by fabric's sequence generator using Configuration service.
Merchant-defined order creation time (UTC). It is mandatory in the request body of Create Order endpoint - POST /orders.
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.
Total price adjustments for all items of the order.
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.
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.
Order subtype, for additional classification
Employee (ID or name) who initiated the order creation request
Optionally used as reference, for orders created from Point-of-Sale systems
Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.
Merchant-defined cashier ID during order creation
Merchant-defined register ID during order creation
Transaction ID such as the Point-of-Sale system's version of the orderId.
Recalculated order subtotal = summationOfAll(itemSubTotal)
Order discount = summationOfAll(itemDiscountTotal)
Total item fee = orderedQuantity * Item Fee Total
Total tax on order = summationOfAll(itemTaxTotal)+summationOfAll(tax[].value)
Total amount to be charged for the order = orderSubTotal - orderDiscountTotal + orderFeeTotal + orderTaxTotal
Three-letter currency code as defined by ISO-4217
Status code. Primarily used for Point-of-Sale (POS) orders.
Description corresponding to statusCode
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Fees
Discounts
Invoice customer
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
Identifier of the logged in user who initiated the request. This could be from either fabric Identity service or an external Identity service.
Customer's loyalty account ID or external identifier that is used to track their loyalty program activity and rewards earned.
Employee (ID or name) who initiated an update request
Shopper's company name. This may be used for company discounts.
Address details
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
Address line 1
Address line 2
Address line 3
Address line 4
City name
Region or state
Postal or ZIP code
ISO 3166-1 alpha-2 based country code
Address type
Address latitude, used with longitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -90 and 90, both inclusive.
Address longitude, used with latitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -180 and 180, both inclusive.
Payments
Items
Shipping info
Additional info, if any. To be used by customer service representative (CSR) only
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 '{
"orderNumber": "309019176",
"orderedAt": "2022-05-12T09:30:31.198Z",
"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"
}
],
"adjustmentTotal": 123.45,
"cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"type": "WEB",
"subtype": "INTERNATIONAL",
"employeeId": "62272e917b12209e68751d94",
"retail": {
"locationNumber": 334,
"cashierId": "C-123",
"registerId": "113",
"transactionId": "328942333412"
},
"orderSubtotal": 123.45,
"orderDiscount": 1.23,
"feeTotal": 12.34,
"taxTotal": 12.34,
"orderTotal": 146.9,
"currency": "USD",
"statusCode": "ORDER_CREATED",
"statusDescription": "Order Created",
"attributes": {
"fraudStatus": "FRAUD_PASS",
"fraudCheckStatus": "UPDATED"
},
"fees": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {},
"invoicedAmount": 34.56
}
],
"discounts": [
{
"quantity": 2,
"amount": 2.4,
"unit": "AMOUNT_OFF",
"value": 2,
"promotionId": "HNY2022",
"promotionCode": "HNY2022",
"promotionName": "New Year",
"type": "promotion"
}
],
"customer": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94",
"accountId": "62272e917b12209e68751d94",
"employeeId": "62272e917b12209e68751d94",
"company": "Demo Inc",
"address": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
}
},
"payments": [
{
"paymentCounter": 1,
"paidAt": "2022-01-27T16:15:58-05:00",
"paymentIdentifier": {
"cardIdentifier": "3456",
"expirationYear": "2029",
"expirationMonth": "12",
"paymentId": "62272e917b12209e68751d94",
"fabricPaymentReference": "f886c96c-5f65-11ed-9b6a-0242ac120002"
},
"paymentProvider": "stripe",
"paymentToken": {
"token": "pi_34tr6787rt",
"paymentType": "VISA"
},
"paymentMethod": "CREDIT_CARD",
"authorizedAmount": 123.2,
"chargedAmount": 60,
"currency": "USD",
"paymentStatus": "Paid",
"authorizationExpirationDate": "2022-01-27T16:15:58-05:00",
"billToAddress": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
},
"attributes": {
"referenceId": "4DY41894J2904533S",
"payerId": "M7AWTK3YK3B46",
"captureCurrencyCode": "USD"
}
}
],
"items": [
{
"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"lineItemNumber": 1,
"itemId": 1234,
"sku": "P1234",
"segment": "P1234",
"vendorId": "P1234",
"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"
}
],
"itemAdjustmentTotal": 123.45,
"itemName": "Item",
"type": "WEB_SHIP",
"itemSubtype": "Borderfree",
"orderedQuantity": 60,
"uom": "EA",
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"itemUnitPrice": 10,
"itemSubtotal": 600,
"itemFeeTotal": 10,
"itemDiscountsTotal": 10,
"itemTaxTotal": 10,
"itemTotal": 10,
"currency": "USD",
"employeeId": "62272e917b12209e68751d94",
"fees": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {}
}
],
"taxCode": "FR01",
"taxDetails": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {}
}
],
"discounts": [
{
"quantity": 2,
"amount": 2.4,
"unit": "AMOUNT_OFF",
"value": 2,
"promotionId": "HNY2022",
"promotionCode": "HNY2022",
"promotionName": "New Year",
"type": "promotion"
}
],
"attributes": {
"style": "570223020",
"colorCode": "001",
"isDonation": "false"
},
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"user": "62272e917b12209e68751d94",
"notes": "Fragile - handle with care"
}
],
"isBackorder": true,
"isPreorder": true,
"isDonation": true
}
],
"shipInfo": [
{
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"taxCode": "FR01",
"locationNumber": "123",
"pickups": [
{
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"pickupType": "PRIMARY"
}
],
"shipToAddress": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
},
"taxDetails": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {}
}
],
"shipMethod": "Parcel post delivery",
"shipToType": "SHIP_TO_ADDRESS",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"shipToPrice": 20,
"shipToDiscount": 12.6,
"discounts": [
{
"quantity": 1,
"amount": 2.99,
"unit": "AMOUNT_OFF",
"value": 10,
"promotionId": "SHIPFREE",
"promotionCode": "SHIPFREE",
"promotionName": "Free Shipping"
}
],
"shipToTaxTotal": 12.6,
"shipmentInstructions": "Handle with care",
"isInvoiced": true,
"attributes": {
"giftMessage": "[]"
}
}
],
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"user": "62272e917b12209e68751d94",
"notes": "Fragile - handle with care"
}
]
}'{
"orderId": "5349b4ddd2781d08c09890f4",
"orderNumber": "309019176",
"version": 2,
"orderedAt": "2022-05-12T09:30:31.198Z",
"cancelledAt": "2022-05-12T09:30:31.198Z",
"allocatedAt": "2022-05-12T09:30:31.198Z",
"channelId": "12",
"cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"type": "WEB",
"subtype": "INTERNATIONAL",
"employeeId": "43278",
"retail": {
"locationNumber": 334,
"cashierId": "C-123",
"registerId": "113",
"transactionId": "328942333412"
},
"orderSubtotal": 123.45,
"originalSubtotal": 113.45,
"orderDiscount": 1.23,
"originalDiscount": 1.45,
"feeTotal": 12.34,
"originalFeeTotal": 12.34,
"taxTotal": 12.34,
"appeasementTotal": 12.34,
"originalTaxTotal": 12.34,
"returnTotal": 12.34,
"cancelTotal": 12.34,
"invoiceTotal": 12.34,
"orderTotal": 146.9,
"originalOrderTotal": 146.9,
"currency": "USD",
"statusCode": "ORDER_CREATED",
"statusDescription": "Order Created",
"attributes": {
"loyaltyStatus": "N",
"fraudCheckStatus": "UPDATED"
},
"fees": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {},
"invoicedAmount": 34.56
}
],
"appeasements": [
{
"appeasementCounter": 1,
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping",
"amount": 34.56,
"invoicedAmount": 34.56,
"payments": [
{
"paymentCounter": 1,
"refundAmount": 34.56
}
],
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}
}
],
"discounts": [
{
"quantity": 1,
"amount": 2.99,
"unit": "AMOUNT_OFF",
"value": 10,
"promotionId": "HNY2022",
"promotionCode": "HNY2022",
"promotionName": "New Year",
"invoiceQuantity": 10
}
],
"customer": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94",
"accountId": "62272e917b12209e68751d94",
"employeeId": "62272e917b12209e68751d94",
"company": "Demo Inc",
"address": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
}
},
"payments": [
{
"paymentCounter": 1,
"paidAt": "2022-01-27T16:15:58-05:00",
"paymentIdentifier": {
"cardIdentifier": "3456",
"expirationYear": "2029",
"expirationMonth": "12",
"paymentId": "62272e917b12209e68751d94",
"fabricPaymentReference": "f886c96c-5f65-11ed-9b6a-0242ac120002"
},
"paymentProvider": "stripe",
"paymentToken": {
"token": "pi_34tr6787rt",
"paymentType": "VISA"
},
"paymentMethod": "CREDIT_CARD",
"authorizedAmount": 123.2,
"chargedAmount": 60,
"refundAmount": 21.5,
"currency": "USD",
"paymentStatus": "Paid",
"paymentLogs": [
{
"paymentId": "328942333412",
"id": "328942333412",
"status": "Authorized",
"data": {
"body": {
"transactionId": "328942333412",
"transactionTimestamp": "2022-04-10T23:00:45:12.111Z",
"responseCode": "OK",
"status": "Authorized",
"attributes": {
"key": "value"
},
"errors": [
{
"key": "value"
}
]
},
"paymentStatusCode": "200"
},
"type": "REFUND",
"amount": -12.4,
"paymentLogId": "328942333412",
"paymentLogRefId": "328942333412"
}
],
"billToAddress": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
},
"attributes": {
"referenceId": "4DY41894J2904533S",
"payerId": "M7AWTK3YK3B46",
"captureCurrencyCode": "USD"
},
"isPartialCapture": true,
"isFinalCapture": true
}
],
"returns": [
{
"totalRefundAmount": 11.29,
"invoicedAmount": 11.29,
"fees": [
{
"type": "FEE",
"name": "RETURN_FEE",
"reason": "Return fee",
"amount": 34.56
}
],
"refunds": [
{
"type": "FEE",
"name": "RETURN_FEE",
"reason": "Return fee",
"amount": 34.56
}
],
"paymentCounterRefundDetails": [
{
"paymentCounter": 1,
"amount": 34.56
}
],
"returnCounter": 1
}
],
"items": [
{
"lineItemId": "d538b1f1-0e45-43c6-bfc6-9666fc1188ca",
"lineItemNumber": 1,
"itemId": 1234,
"sku": "P1234",
"channelId": "WHBM",
"vendorId": "P1234",
"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"
}
],
"itemAdjustmentTotal": 123.45,
"itemName": "Item",
"type": "WEB_SHIP",
"itemSubtype": "Borderfree",
"orderedQuantity": 60,
"backOrderedQuantity": 10,
"orderedQuantityToShip": 10,
"pendingShippedBackOrderQuantity": 10,
"shippedQuantity": 10,
"deliveredQuantity": 10,
"invoicedQuantity": 10,
"cancelledQuantity": 10,
"pendingReturnQuantity": 10,
"processingReturnQuantity": 10,
"rejectedReturnQuantity": 10,
"returnedQuantity": 10,
"reshippedQuantity": 10,
"quantityInStatus": {
"created": 10,
"pendingShipped": 10,
"shipped": 10,
"returned": 10,
"cancelled": 10,
"hold": 10,
"delivered": 10
},
"uom": "EA",
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"itemUnitPrice": 10,
"itemSubtotal": 600,
"originalItemSubtotal": 800,
"itemFeeTotal": 200,
"originalFeeTotal": 300,
"itemShippingTotal": 10,
"originalShippingTotal": 80,
"appeasementTotal": 5.5,
"itemDiscountsTotal": 80,
"originalDiscounts": 50,
"itemTaxTotal": 80,
"originalTaxTotal": 90,
"itemTotal": 800,
"originalItemTotal": 500,
"invoiceTotal": 800,
"currency": "USD",
"employeeId": "5345HJH",
"fees": [
{
"name": "STATE",
"taxCode": "FR01",
"amount": 34.56,
"currency": "USD",
"attributes": {},
"invoiceQuantity": 10,
"refundAmount": 21.5,
"quantity": 12
}
],
"appeasements": [
{
"appeasementCounter": 1,
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping",
"amount": 34.56,
"invoicedAmount": 34.56,
"payments": [
{
"paymentCounter": 1,
"refundAmount": 34.56
}
],
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}
}
],
"returns": [
{
"returnRequestCounter": 1,
"shipmentId": "62b37697c67b204dd18a7465",
"shipmentLineItemId": "234",
"shipmentQuantity": 1,
"refundAmount": 11.29,
"invoicedAmount": 11.29,
"returnsReceivedAt": "2022-09-14T14:07:36.861Z",
"reasonCode": "Incorrect item",
"exchangeLineItemId": "62f3dfc438bcab1951be0a19",
"isExchangeItemReturned": true,
"fees": [
{
"type": "FEE",
"name": "RETURN_FEE",
"reason": "Return fee",
"amount": 34.56
}
],
"refunds": [
{
"type": "FEE",
"name": "RETURN_FEE",
"reason": "Return fee",
"amount": 34.56
}
]
}
],
"taxCode": "FR01",
"taxDetails": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {}
}
],
"discounts": [
{
"quantity": 1,
"amount": 2.99,
"unit": "AMOUNT_OFF",
"value": 10,
"promotionId": "HNY2022",
"promotionCode": "HNY2022",
"promotionName": "New Year",
"invoiceQuantity": 10
}
],
"attributes": {
"style": "570223020",
"colorCode": "001",
"isDonation": "false"
},
"parentLineItemNumber": 12,
"pendingExchangeQuantity": 12,
"exchangeQuantity": 13,
"refundAmount": 21.5,
"cancelledAmount": 12.4,
"lineOrderStatus": "VALID",
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"user": "62272e917b12209e68751d94",
"notes": "Fragile - handle with care"
}
],
"isBackorder": true,
"isPreorder": true,
"isExchangeItem": true,
"hasInfiniteConsent": true,
"isGifting": true,
"isDonation": true
}
],
"shipInfo": [
{
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"taxCode": "FR01",
"locationNumber": "123",
"pickups": [
{
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"pickupType": "PRIMARY"
}
],
"shipToAddress": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
},
"taxDetails": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {}
}
],
"shipMethod": "Parcel post delivery",
"shipToType": "SHIP_TO_ADDRESS",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"shipToPrice": 20,
"shipToDiscount": 12.6,
"discounts": [
{
"quantity": 1,
"amount": 2.99,
"unit": "AMOUNT_OFF",
"value": 10,
"promotionId": "SHIPFREE",
"promotionCode": "SHIPFREE",
"promotionName": "Free Shipping"
}
],
"shipToTaxTotal": 12.6,
"shipmentInstructions": "Handle with care",
"isInvoiced": true,
"attributes": {
"giftMessage": "[]"
}
}
],
"auditLogs": [
{
"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
"auditType": "CANCEL",
"employeeId": "6227",
"auditedAt": "2023-03-12T09:24:54.804Z",
"source": "POS",
"reasonCode": "Scratched item",
"subReasonCode": "Scratched item",
"policyCode": "POS",
"note": "Note",
"lineItemNumber": 1,
"sku": "SKU0023",
"quantity": 1,
"amount": 2.4,
"paymentToken": {
"token": "pi_34tr6787rt",
"paymentType": "VISA"
},
"updatedFields": [
{
"fieldName": "UOM",
"fieldOriginalValue": "PK"
}
],
"isSuccess": true,
"attributes": {
"key": "value"
}
}
],
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"user": "62272e917b12209e68751d94",
"notes": "Fragile - handle with care"
}
],
"orderReleasedAt": "2022-05-12T09:30:31.198Z",
"createdAt": "2022-05-12T09:30:31.198Z",
"updatedAt": "2022-05-12T09:30:31.198Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Merchant's 24-character tenant ID
Sales channel ID
Unique request ID
Body
Merchant-defined order identifier. If omitted, this is generated by fabric's sequence generator using Configuration service.
Merchant-defined order creation time (UTC). It is mandatory in the request body of Create Order endpoint - POST /orders.
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.
Sequential or incremental counter for price adjustment
Adjustment amount
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs.
Cancel quantity
Total quantity invoiced
Placeholder for additional info, if any.
Adjustment quantity
Reason code
Returned quantity of given item
Subreason code
Total price adjustments for all items of the order.
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.
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 Order subtype, for additional classification
IOS, ANDROID, INTERNATIONAL Employee (ID or name) who initiated the order creation request
Optionally used as reference, for orders created from Point-of-Sale systems
Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.
Merchant-defined cashier ID during order creation
Merchant-defined register ID during order creation
Transaction ID such as the Point-of-Sale system's version of the orderId.
Recalculated order subtotal = summationOfAll(itemSubTotal)
Order discount = summationOfAll(itemDiscountTotal)
Total item fee = orderedQuantity * Item Fee Total
Total tax on order = summationOfAll(itemTaxTotal)+summationOfAll(tax[].value)
Total amount to be charged for the order = orderSubTotal - orderDiscountTotal + orderFeeTotal + orderTaxTotal
Three-letter currency code as defined by ISO-4217
Status code. Primarily used for Point-of-Sale (POS) orders.
Description corresponding to statusCode
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Fees
Applied tax name
Tax code applied
Rate type
Rate
Tax amount
Three-letter currency code as defined by ISO-4217
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
System-generated amount from Invoice service based on requested amount
Discounts
Discounted quantity of given item
Discount amount for quantity
Discount offer - dollar value or percentage
Discount value in amount or percentage
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.
Promotion code used by shoppers to take advantage of an ongoing promotion and available.
Promotion name
Promotion type. There are no pre-defined values.
Invoice customer
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
MOBILE, HOME, BUSINESS Identifier of the logged in user who initiated the request. This could be from either fabric Identity service or an external Identity service.
Customer's loyalty account ID or external identifier that is used to track their loyalty program activity and rewards earned.
Employee (ID or name) who initiated an update request
Shopper's company name. This may be used for company discounts.
Address details
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
MOBILE, HOME, BUSINESS Address line 1
Address line 2
Address line 3
Address line 4
City name
Region or state
Postal or ZIP code
ISO 3166-1 alpha-2 based country code
Address type
Address latitude, used with longitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -90 and 90, both inclusive.
Address longitude, used with latitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -180 and 180, both inclusive.
Payments
A sequential or incremental counter associated with a payment for an order. Applicable in refund scenarios to identify the specific payment for refund.
System-generated time of payment capture at shipment. When payment is captured at checkout, this is a merchant-defined value during order creation.
Details of payment mode and payment identifiers
Last 4 digits of the card
Card expiration year
Card expiration month
Merchant provided unique identifier for a payment based on payment connector. When omitted, it is a fabric-generated UUID.
System-generated UUID referenced internally for Invoice and Orders services.
Payment provider
Order payment token details
Payment token provided by payment provider
Payment type, for example, credit card payment providers can be Visa, Mastercard, American express, etc.
Payment method
Amount authorized to be debited from the given paymentMethod
Charged amount
Three-letter currency code as defined by ISO-4217
Payment status. There are no pre-defined values; possible values are Paid, Partially Paid, Authorized, and Error.
Expiration time for authorization
Address details
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
MOBILE, HOME, BUSINESS Address line 1
Address line 2
Address line 3
Address line 4
City name
Region or state
Postal or ZIP code
ISO 3166-1 alpha-2 based country code
Address type
Address latitude, used with longitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -90 and 90, both inclusive.
Address longitude, used with latitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -180 and 180, both inclusive.
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Items
Merchant-defined unique identifier for each item in an order. When omitted, fabric auto-generates this value during order creation, in UUID format.
Merchant-defined line item number to identify each item in an order.
Unique identifier of item from Product Catalog
Stock keeping unit (SKU), unique identifier of item.
Segment
Vendor ID
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.
Sequential or incremental counter for price adjustment
Adjustment amount
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs.
Cancel quantity
Total quantity invoiced
Placeholder for additional info, if any.
Adjustment quantity
Reason code
Returned quantity of given item
Subreason code
Total price adjustment made to the item.
Item name
Identify order type whether it's a pickup, web ship, or international order.
Subtype of type, for another layer of classification.
Ordered quantity of given item
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.
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.
Item's unit price
Recalculated item's subtotal - Item unit price x (orderedQuantity - cancelledQuantity)
Recalculated item's fee = summationOfAll(fees[].amount). Refer to amount in itemFeeDetails
Item's total discount = summationOfAll(discounts[].amount)'. Refer to amountinorderDiscount`.
Recalculated total tax on item = summationOfAll(itemTaxTotal)
Recalculated item's total cost = itemSubTotal - itemDiscountTotal + itemTaxTotal + itemFeeTotal
Three-letter currency code as defined by ISO-4217
Employee (ID or name) who initiated the request
Applied tax name
Tax code applied
Rate type
Rate
Tax amount
Three-letter currency code as defined by ISO-4217
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Applicable tax code, varies from state to state
Applied tax name
Tax code applied
Rate type
Rate
Tax amount
Three-letter currency code as defined by ISO-4217
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Discounted quantity of given item
Discount amount for quantity
Discount offer - dollar value or percentage
Discount value in amount or percentage
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.
Promotion code used by shoppers to take advantage of an ongoing promotion and available.
Promotion name
Promotion type. There are no pre-defined values.
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs
Notes section to be used by customer service representative (CSR) only
Time note was created (UTC)
Customer Service Representative or Employee (ID or name) who created the note
Additional info about the order, if any
true: Backordered item <br /> false: Ordered item
true: Preordered item <br /> false: Ordered item
true: Item is a donation <br /> false: Item is not a donation
Shipping info
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.
Applicable tax code, varies from state to state
Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.
Order pickup details
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
MOBILE, HOME, BUSINESS Order pickup type
PRIMARY, ALTERNATE Address details
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
MOBILE, HOME, BUSINESS Address line 1
Address line 2
Address line 3
Address line 4
City name
Region or state
Postal or ZIP code
ISO 3166-1 alpha-2 based country code
Address type
Address latitude, used with longitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -90 and 90, both inclusive.
Address longitude, used with latitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -180 and 180, both inclusive.
Applied tax name
Tax code applied
Rate type
Rate
Tax amount
Three-letter currency code as defined by ISO-4217
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Shipping method
Type of shipping address. There are no pre-defined values; the possible values are SDD (Same Day Delivery), Point-of-Sale (POS), etc.
Estimated shipping time (UTC) provided by merchant
Estimated delivery time (UTC) provided by carrier
Merchant-defined shipping cost
Merchant-defined shipping discount amount
Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.
Discounted amount for the given quantity
Indicates whether the discount is in amount or percentage
Value corresponding to unit
Unique promotion ID either from fabric Offers service or external Offers serice. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of create promotion endpoint.
Promotion code used by shoppers to take advantage of an ongoing promotion.
Promotion name
Total shipping tax
Shipment instructions
true: At least one captured invoice is created by Invoice service <br /> false: Captured invoice is not created
User defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Additional info, if any. To be used by customer service representative (CSR) only
Time note was created (UTC)
Customer Service Representative or Employee (ID or name) who created the note
Additional info about the order, if any
Response
24-character system-generated order ID
Merchant-defined order identifier. If omitted, this is generated by fabric's sequence generator using Configuration service
Current version of order document. Indicates the number of times the order is updated by any operation.
Merchant-defined order creation time (UTC). It is mandatory in the request body of Create Order endpoint - POST /orders.
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.
System-generated order allocation time (UTC) once the order is allocated using Allocation service
Sales channel ID
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.
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 Order subtype, for further classification
IOS, ANDROID, INTERNATIONAL Employee (ID or name) who initiated the request
Optionally used as reference, for orders created from Point-of-Sale systems
Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.
Merchant-defined cashier ID during order creation
Merchant-defined register ID during order creation
Transaction ID such as the Point-of-Sale system's version of the orderId.
Recalculated orderSubtotal - summationOfAll(itemSubTotal)
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.
Recalculated order discount
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.
Recalculated total fee, calculated as orderedQuantity* itemFeeTotal
System-generated total fees, auto-filled by Orders service when the order is placed
Recalculated total tax on order summationOfAll(itemTaxTotal)+summationOf(tax[].value)
Final appeasement amount
System-generated total tax, auto-filled by Orders service when the order is placed
Return total of order, for return scenarios, calculated as summationOfAll(itemReturnTotal)
Amount to be returned after order cancellation, calculated as cancelledQuantity / orderedQuantity * itemTotal
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.
Total amount to be charged for the order = orderSubTotal - orderDiscountTotal + orderFeeTotal + orderTaxTotal
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.
Three-letter currency code as defined by ISO-4217
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.
Human-readable brief description based on statusCode
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Applied tax name
Tax code applied
Rate type
Rate
Tax amount
Three-letter currency code as defined by ISO-4217
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
System-generated amount from Invoice service based on requested amount
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.
Merchant-defined appeasement reason code; varies from merchant to merchant
Subreason code for appeasement, for another layer of classification
Merchant-defined appeasement amount, which should not exceed (charged amount - already refunded amount)
System-generated amount from Invoice service based on requested amount
Payment counter to identify which payment to refund
Refund amount for appeasement
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs
Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.
Discounted amount for the given quantity
Indicates whether the discount is in amount or percentage
Value corresponding to unit
Unique promotion ID either from fabric Offers service or external Offers serice. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of create promotion endpoint.
Promotion code used by shoppers to take advantage of an ongoing promotion.
Promotion name
Total quantity invoiced. If customer placed order for 10 quantity of an item and only 2 got shipped, then 2 is the invoiceQuantity.
Invoice customer
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
MOBILE, HOME, BUSINESS Identifier of the logged in user who initiated the request. This could be from either fabric Identity service or an external Identity service.
Customer's loyalty account ID or external identifier that is used to track their loyalty program activity and rewards earned.
Employee (ID or name) who initiated an update request
Shopper's company name. This may be used for company discounts.
Address details
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
MOBILE, HOME, BUSINESS Address line 1
Address line 2
Address line 3
Address line 4
City name
Region or state
Postal or ZIP code
ISO 3166-1 alpha-2 based country code
Address type
Address latitude, used with longitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -90 and 90, both inclusive.
Address longitude, used with latitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -180 and 180, both inclusive.
A sequential or incremental counter associated with a payment for an order. Applicable in refund scenarios to identify the specific payment for refund.
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.
Details of payment mode and payment identifiers
Last 4 digits of the card
Card expiration year
Card expiration month
Merchant provided unique identifier for a payment based on payment connector. When omitted, it is a fabric-generated UUID.
System-generated UUID referenced internally for Invoice and Orders services.
Payment provider
Order payment token details
Payment token provided by payment provider
Payment type, for example, credit card payment providers can be Visa, Mastercard, American express, etc.
Payment method such as PayPal or credit card
Amount authorized to be debited from the given paymentMethod
Amount charged to the given paymentMethod
Merchant-defined refund amount
Three-letter currency code as defined by ISO-4217
Payment status. There are no pre-defined values; possible values are Paid, Partially Paid, Authorized, and Error.
Payment details
Merchant-provided unique identifier for a payment based on payment connector. When omitted, this value will be generated by fabric in UUID format.
ID provided by payment gateway in response to payment operation
Payment status such as Authorized, Captured, etc.
Payment details
Payment info
Transaction ID such as the point-of-sale system's version of the orderId.
Transaction time (UTC) when the payment was successful
Response code such as success, OK, or failure
Payment status such as Authorized, Captured, etc.
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Error details
Status code for payment. There are no pre-defined values; possible values are 200, 400, 402, etc.
Transaction type such as VOID, CAPTURED, REDUND, etc.
Transaction amount for the payment operation
ID generated by fabric to uniquely identify the payment log
Payment reference log ID with which this record is associated
Address details
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
MOBILE, HOME, BUSINESS Address line 1
Address line 2
Address line 3
Address line 4
City name
Region or state
Postal or ZIP code
ISO 3166-1 alpha-2 based country code
Address type
Address latitude, used with longitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -90 and 90, both inclusive.
Address longitude, used with latitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -180 and 180, both inclusive.
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
true: Payment is partial capture <br /> false: Payment is full capture
true: Payment is final capture <br /> false: Payment is not a final capture
Merchant-defined total refund amount for the return request
System-generated invoiced amount for the return request
Return fee type
TAX, DISCOUNT, FEE, ITEM Fee name
Merchant-defined return reason
Merchant-defined return amount
Return fee type
TAX, DISCOUNT, FEE, ITEM Fee name
Merchant-defined return reason
Merchant-defined return amount
Unique incremented number for this payment object
Final refunded amount
Unique, sequential or incremental counter for return request
Item details
Merchant-defined unique identifier for each item in an order. When omitted, fabric will generate it (in UUID format) during order creation.
Merchant-defined line item number to identify each item in an order
System-generated unique identifier of item from Product Catalog.
Stock keeping unit (SKU), unique identifier of item
Sales channel ID
Vendor ID. Applicable in drop shipping to indicate vendor responsible for given item.
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.
Sequential or incremental counter for price adjustment
Adjustment amount
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs.
Cancel quantity
Total quantity invoiced
Placeholder for additional info, if any.
Adjustment quantity
Reason code
Returned quantity of given item
Subreason code
Total price adjustment made to the item.
Item name
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.
Subtype of type, for another layer of classification
Ordered quantity of given item
Backordered quantity of given item
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.
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.
Shipped quantity of an item
Delivered quantity of an item
Invoiced quantity of an item
Cancelled quantity of an item
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.
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
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
Returned quantity of given item
Reshipped quantity of given item (in case of lost shipment)
Item quantity for each status
Ordered quantity of given item
Pending quantity of given item
Shipped quantity of given item
Returned quantity of given item
Cancelled quantity of given item
Held quantity of given item
Delivered quantity of given item
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.
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.
Item's unit price
Recalculated item's subtotal = itemUnitPrice x (orderedQuantity - cancelledQuantity)
System-generated total discount, auto-filled by Orders service when the order is placed
Recalculated item's fee = summationOfAll(itemFeeTotal). Refer to amount in itemFeeDetails
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.
Merchant-defined item's shipping total
System-generated total shipping cost, auto-filled by Orders service when the order is placed
Appeasement total = summationOfAll(appeasements[].amount and items[].appeasements[].amount)
Item's total discount = summationOfAll(discounts[].amount)'. Refer to amountinorderDiscount`
System-generated total discount, auto-filled by Orders service when the order is placed
Recalculated total tax on item = summationOfAll(itemTaxTotal)
System-generated total tax, auto-filled by Orders service when the order is placed
Recalculated item's total cost = itemSubTotal - itemDiscountTotal + itemTaxTotal + itemFeeTotal
System-generated item total cost, auto-filled by Orders service when the order is placed
Invoice total is updated once invoice created
Three-letter currency code as defined by ISO-4217
Employee (ID or name) who initiated the request
Fee details
Applied tax name
Tax code applied
Tax amount
Three-letter currency code as defined by ISO-4217
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Total quantity invoiced. If customer placed order for 10 quantity of an item and only 2 got shipped then 2 is the invoiceQuantity
Total refund amount
Total number of items in the order
Appeasement info
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.
Merchant-defined appeasement reason code; varies from merchant to merchant
Subreason code for appeasement, for another layer of classification
Merchant-defined appeasement amount, which should not exceed (charged amount - already refunded amount)
System-generated amount from Invoice service based on requested amount
Payment counter to identify which payment to refund
Refund amount for appeasement
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs
Order return details
Unique, sequential, or incremental counter for return request
24-character system-generated shipment ID
Unique identifier for each item in the shipment
Shipped quantity of given item
Refund amount
System-generated amount from Invoice service based on requested amount
System-generated time of returned item that has come back to the facility (UTC)
Merchant-defined reason code for return
Exchange line item ID
true: Item received for exchange is returned<br />false: Item received for exchange is not returned
Return fee type
TAX, DISCOUNT, FEE, ITEM Fee name
Merchant-defined return reason
Merchant-defined return amount
Return fee type
TAX, DISCOUNT, FEE, ITEM Fee name
Merchant-defined return reason
Merchant-defined return amount
Applicable tax code, varies from state to state
Tax details
Applied tax name
Tax code applied
Rate type
Rate
Tax amount
Three-letter currency code as defined by ISO-4217
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Discount details
Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.
Discounted amount for the given quantity
Indicates whether the discount is in amount or percentage
Value corresponding to unit
Unique promotion ID either from fabric Offers service or external Offers serice. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of create promotion endpoint.
Promotion code used by shoppers to take advantage of an ongoing promotion.
Promotion name
Total quantity invoiced. If customer placed order for 10 quantity of an item and only 2 got shipped, then 2 is the invoiceQuantity.
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Applicable in exchange scenarios. Item being returned is the parentLineItemNumber.
System-generated item quantity pending for exchange
System-generated item quantity that are exchanged
Merchant-defined total refund amount
Cancelled amount is either voided (payment is only authorized but not captured at checkout) or refunded (amount is authorized and captured at checkout)
System-generated status for each item in the orders - SHIPPED, RETURNED, CANCELLED, EXHANGED, VALID, and so on
For additional information, to be used by Customer Service Representative (CSR) only
Time note was created (UTC)
Customer Service Representative or Employee (ID or name) who created the note
Additional info about the order, if any
Merchant-defined value. <br /> true: Backordered item <br /> false: Ordered item
Merchant-defined value. <br /> true: Pre-ordered item <br /> false: Ordered item
Merchant-defined value for exchange scenarios. <br /> true: Item is an exchange <br /> false: Item is not an exchange
Applicable for backorder and preorder scenarios where customer consents for further delay in delivery of preordered and backordered items than the initial estimate. <br /> true: Customer consents for delayed delivery <br /> false: Customer does not consent for delayed delivery
true: Item is a gift <br /> false: Item is not a gift
true: Item is a donation <br /> false: Item is not a donation
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.
Applicable tax code, varies from state to state
Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.
Order pickup details
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
MOBILE, HOME, BUSINESS Order pickup type
PRIMARY, ALTERNATE Address details
Contact person's name
Contact person's first name
Contact person's middle name or initial
Contact person's last name
Contact person's email
Contact person's phone details
Contact person's phone number
Contact number type
MOBILE, HOME, BUSINESS Address line 1
Address line 2
Address line 3
Address line 4
City name
Region or state
Postal or ZIP code
ISO 3166-1 alpha-2 based country code
Address type
Address latitude, used with longitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -90 and 90, both inclusive.
Address longitude, used with latitude to specify the address location. Decimal degrees format; negative is degrees South.<br />**Note:**Value must be between -180 and 180, both inclusive.
Applied tax name
Tax code applied
Rate type
Rate
Tax amount
Three-letter currency code as defined by ISO-4217
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Shipping method
Type of shipping address. There are no pre-defined values; the possible values are SDD (Same Day Delivery), Point-of-Sale (POS), etc.
Estimated shipping time (UTC) provided by merchant
Estimated delivery time (UTC) provided by carrier
Merchant-defined shipping cost
Merchant-defined shipping discount amount
Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.
Discounted amount for the given quantity
Indicates whether the discount is in amount or percentage
Value corresponding to unit
Unique promotion ID either from fabric Offers service or external Offers serice. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of create promotion endpoint.
Promotion code used by shoppers to take advantage of an ongoing promotion.
Promotion name
Total shipping tax
Shipment instructions
true: At least one captured invoice is created by Invoice service <br /> false: Captured invoice is not created
User defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Merchant-defined unique identifier for each item in an order. When omitted, fabric will generate it during order creation, in UUID format.
System-generated audit ID (UUID format)
Audit type such as cancel, return, etc.
Employee (ID or name) who made the last update
Audit time (UTC)
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.
Merchant-defined reason code, varies from merchant to merchant
Merchant-defined sub reason code; provides more clarity to audit reason
Configurable in Copilot as per requirement. If omitted, default policy is used.
Additional info, if any
Item identifier
Stock keeping unit (SKU), unique item identifier
Ordered quantity of given item
Amount for which audit is done
Order payment token details
Payment token provided by payment provider
Payment type, for example, credit card payment providers can be Visa, Mastercard, American express, etc.
Audit log for change history
Field or property name that was updated
Original value of fieldName before it was updated
true: Update operation (any update to the service) is successful <br /> false: Update operation has failed
Custom attributes
Time note was created (UTC)
Customer Service Representative or Employee (ID or name) who created the note
Additional info about the order, if any
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.
Order creation time (UTC)
Time of last update to order (UTC)
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 '{
"orderNumber": "309019176",
"orderedAt": "2022-05-12T09:30:31.198Z",
"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"
}
],
"adjustmentTotal": 123.45,
"cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"type": "WEB",
"subtype": "INTERNATIONAL",
"employeeId": "62272e917b12209e68751d94",
"retail": {
"locationNumber": 334,
"cashierId": "C-123",
"registerId": "113",
"transactionId": "328942333412"
},
"orderSubtotal": 123.45,
"orderDiscount": 1.23,
"feeTotal": 12.34,
"taxTotal": 12.34,
"orderTotal": 146.9,
"currency": "USD",
"statusCode": "ORDER_CREATED",
"statusDescription": "Order Created",
"attributes": {
"fraudStatus": "FRAUD_PASS",
"fraudCheckStatus": "UPDATED"
},
"fees": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {},
"invoicedAmount": 34.56
}
],
"discounts": [
{
"quantity": 2,
"amount": 2.4,
"unit": "AMOUNT_OFF",
"value": 2,
"promotionId": "HNY2022",
"promotionCode": "HNY2022",
"promotionName": "New Year",
"type": "promotion"
}
],
"customer": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94",
"accountId": "62272e917b12209e68751d94",
"employeeId": "62272e917b12209e68751d94",
"company": "Demo Inc",
"address": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
}
},
"payments": [
{
"paymentCounter": 1,
"paidAt": "2022-01-27T16:15:58-05:00",
"paymentIdentifier": {
"cardIdentifier": "3456",
"expirationYear": "2029",
"expirationMonth": "12",
"paymentId": "62272e917b12209e68751d94",
"fabricPaymentReference": "f886c96c-5f65-11ed-9b6a-0242ac120002"
},
"paymentProvider": "stripe",
"paymentToken": {
"token": "pi_34tr6787rt",
"paymentType": "VISA"
},
"paymentMethod": "CREDIT_CARD",
"authorizedAmount": 123.2,
"chargedAmount": 60,
"currency": "USD",
"paymentStatus": "Paid",
"authorizationExpirationDate": "2022-01-27T16:15:58-05:00",
"billToAddress": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
},
"attributes": {
"referenceId": "4DY41894J2904533S",
"payerId": "M7AWTK3YK3B46",
"captureCurrencyCode": "USD"
}
}
],
"items": [
{
"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"lineItemNumber": 1,
"itemId": 1234,
"sku": "P1234",
"segment": "P1234",
"vendorId": "P1234",
"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"
}
],
"itemAdjustmentTotal": 123.45,
"itemName": "Item",
"type": "WEB_SHIP",
"itemSubtype": "Borderfree",
"orderedQuantity": 60,
"uom": "EA",
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"itemUnitPrice": 10,
"itemSubtotal": 600,
"itemFeeTotal": 10,
"itemDiscountsTotal": 10,
"itemTaxTotal": 10,
"itemTotal": 10,
"currency": "USD",
"employeeId": "62272e917b12209e68751d94",
"fees": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {}
}
],
"taxCode": "FR01",
"taxDetails": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {}
}
],
"discounts": [
{
"quantity": 2,
"amount": 2.4,
"unit": "AMOUNT_OFF",
"value": 2,
"promotionId": "HNY2022",
"promotionCode": "HNY2022",
"promotionName": "New Year",
"type": "promotion"
}
],
"attributes": {
"style": "570223020",
"colorCode": "001",
"isDonation": "false"
},
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"user": "62272e917b12209e68751d94",
"notes": "Fragile - handle with care"
}
],
"isBackorder": true,
"isPreorder": true,
"isDonation": true
}
],
"shipInfo": [
{
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"taxCode": "FR01",
"locationNumber": "123",
"pickups": [
{
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"pickupType": "PRIMARY"
}
],
"shipToAddress": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
},
"taxDetails": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {}
}
],
"shipMethod": "Parcel post delivery",
"shipToType": "SHIP_TO_ADDRESS",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"shipToPrice": 20,
"shipToDiscount": 12.6,
"discounts": [
{
"quantity": 1,
"amount": 2.99,
"unit": "AMOUNT_OFF",
"value": 10,
"promotionId": "SHIPFREE",
"promotionCode": "SHIPFREE",
"promotionName": "Free Shipping"
}
],
"shipToTaxTotal": 12.6,
"shipmentInstructions": "Handle with care",
"isInvoiced": true,
"attributes": {
"giftMessage": "[]"
}
}
],
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"user": "62272e917b12209e68751d94",
"notes": "Fragile - handle with care"
}
]
}'{
"orderId": "5349b4ddd2781d08c09890f4",
"orderNumber": "309019176",
"version": 2,
"orderedAt": "2022-05-12T09:30:31.198Z",
"cancelledAt": "2022-05-12T09:30:31.198Z",
"allocatedAt": "2022-05-12T09:30:31.198Z",
"channelId": "12",
"cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"type": "WEB",
"subtype": "INTERNATIONAL",
"employeeId": "43278",
"retail": {
"locationNumber": 334,
"cashierId": "C-123",
"registerId": "113",
"transactionId": "328942333412"
},
"orderSubtotal": 123.45,
"originalSubtotal": 113.45,
"orderDiscount": 1.23,
"originalDiscount": 1.45,
"feeTotal": 12.34,
"originalFeeTotal": 12.34,
"taxTotal": 12.34,
"appeasementTotal": 12.34,
"originalTaxTotal": 12.34,
"returnTotal": 12.34,
"cancelTotal": 12.34,
"invoiceTotal": 12.34,
"orderTotal": 146.9,
"originalOrderTotal": 146.9,
"currency": "USD",
"statusCode": "ORDER_CREATED",
"statusDescription": "Order Created",
"attributes": {
"loyaltyStatus": "N",
"fraudCheckStatus": "UPDATED"
},
"fees": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {},
"invoicedAmount": 34.56
}
],
"appeasements": [
{
"appeasementCounter": 1,
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping",
"amount": 34.56,
"invoicedAmount": 34.56,
"payments": [
{
"paymentCounter": 1,
"refundAmount": 34.56
}
],
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}
}
],
"discounts": [
{
"quantity": 1,
"amount": 2.99,
"unit": "AMOUNT_OFF",
"value": 10,
"promotionId": "HNY2022",
"promotionCode": "HNY2022",
"promotionName": "New Year",
"invoiceQuantity": 10
}
],
"customer": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"userId": "62272e917b12209e68751d94",
"accountId": "62272e917b12209e68751d94",
"employeeId": "62272e917b12209e68751d94",
"company": "Demo Inc",
"address": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
}
},
"payments": [
{
"paymentCounter": 1,
"paidAt": "2022-01-27T16:15:58-05:00",
"paymentIdentifier": {
"cardIdentifier": "3456",
"expirationYear": "2029",
"expirationMonth": "12",
"paymentId": "62272e917b12209e68751d94",
"fabricPaymentReference": "f886c96c-5f65-11ed-9b6a-0242ac120002"
},
"paymentProvider": "stripe",
"paymentToken": {
"token": "pi_34tr6787rt",
"paymentType": "VISA"
},
"paymentMethod": "CREDIT_CARD",
"authorizedAmount": 123.2,
"chargedAmount": 60,
"refundAmount": 21.5,
"currency": "USD",
"paymentStatus": "Paid",
"paymentLogs": [
{
"paymentId": "328942333412",
"id": "328942333412",
"status": "Authorized",
"data": {
"body": {
"transactionId": "328942333412",
"transactionTimestamp": "2022-04-10T23:00:45:12.111Z",
"responseCode": "OK",
"status": "Authorized",
"attributes": {
"key": "value"
},
"errors": [
{
"key": "value"
}
]
},
"paymentStatusCode": "200"
},
"type": "REFUND",
"amount": -12.4,
"paymentLogId": "328942333412",
"paymentLogRefId": "328942333412"
}
],
"billToAddress": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
},
"attributes": {
"referenceId": "4DY41894J2904533S",
"payerId": "M7AWTK3YK3B46",
"captureCurrencyCode": "USD"
},
"isPartialCapture": true,
"isFinalCapture": true
}
],
"returns": [
{
"totalRefundAmount": 11.29,
"invoicedAmount": 11.29,
"fees": [
{
"type": "FEE",
"name": "RETURN_FEE",
"reason": "Return fee",
"amount": 34.56
}
],
"refunds": [
{
"type": "FEE",
"name": "RETURN_FEE",
"reason": "Return fee",
"amount": 34.56
}
],
"paymentCounterRefundDetails": [
{
"paymentCounter": 1,
"amount": 34.56
}
],
"returnCounter": 1
}
],
"items": [
{
"lineItemId": "d538b1f1-0e45-43c6-bfc6-9666fc1188ca",
"lineItemNumber": 1,
"itemId": 1234,
"sku": "P1234",
"channelId": "WHBM",
"vendorId": "P1234",
"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"
}
],
"itemAdjustmentTotal": 123.45,
"itemName": "Item",
"type": "WEB_SHIP",
"itemSubtype": "Borderfree",
"orderedQuantity": 60,
"backOrderedQuantity": 10,
"orderedQuantityToShip": 10,
"pendingShippedBackOrderQuantity": 10,
"shippedQuantity": 10,
"deliveredQuantity": 10,
"invoicedQuantity": 10,
"cancelledQuantity": 10,
"pendingReturnQuantity": 10,
"processingReturnQuantity": 10,
"rejectedReturnQuantity": 10,
"returnedQuantity": 10,
"reshippedQuantity": 10,
"quantityInStatus": {
"created": 10,
"pendingShipped": 10,
"shipped": 10,
"returned": 10,
"cancelled": 10,
"hold": 10,
"delivered": 10
},
"uom": "EA",
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"itemUnitPrice": 10,
"itemSubtotal": 600,
"originalItemSubtotal": 800,
"itemFeeTotal": 200,
"originalFeeTotal": 300,
"itemShippingTotal": 10,
"originalShippingTotal": 80,
"appeasementTotal": 5.5,
"itemDiscountsTotal": 80,
"originalDiscounts": 50,
"itemTaxTotal": 80,
"originalTaxTotal": 90,
"itemTotal": 800,
"originalItemTotal": 500,
"invoiceTotal": 800,
"currency": "USD",
"employeeId": "5345HJH",
"fees": [
{
"name": "STATE",
"taxCode": "FR01",
"amount": 34.56,
"currency": "USD",
"attributes": {},
"invoiceQuantity": 10,
"refundAmount": 21.5,
"quantity": 12
}
],
"appeasements": [
{
"appeasementCounter": 1,
"reasonCode": "Incorrect Item",
"subReasonCode": "Late shipping",
"amount": 34.56,
"invoicedAmount": 34.56,
"payments": [
{
"paymentCounter": 1,
"refundAmount": 34.56
}
],
"attributes": {
"number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}
}
],
"returns": [
{
"returnRequestCounter": 1,
"shipmentId": "62b37697c67b204dd18a7465",
"shipmentLineItemId": "234",
"shipmentQuantity": 1,
"refundAmount": 11.29,
"invoicedAmount": 11.29,
"returnsReceivedAt": "2022-09-14T14:07:36.861Z",
"reasonCode": "Incorrect item",
"exchangeLineItemId": "62f3dfc438bcab1951be0a19",
"isExchangeItemReturned": true,
"fees": [
{
"type": "FEE",
"name": "RETURN_FEE",
"reason": "Return fee",
"amount": 34.56
}
],
"refunds": [
{
"type": "FEE",
"name": "RETURN_FEE",
"reason": "Return fee",
"amount": 34.56
}
]
}
],
"taxCode": "FR01",
"taxDetails": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {}
}
],
"discounts": [
{
"quantity": 1,
"amount": 2.99,
"unit": "AMOUNT_OFF",
"value": 10,
"promotionId": "HNY2022",
"promotionCode": "HNY2022",
"promotionName": "New Year",
"invoiceQuantity": 10
}
],
"attributes": {
"style": "570223020",
"colorCode": "001",
"isDonation": "false"
},
"parentLineItemNumber": 12,
"pendingExchangeQuantity": 12,
"exchangeQuantity": 13,
"refundAmount": 21.5,
"cancelledAmount": 12.4,
"lineOrderStatus": "VALID",
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"user": "62272e917b12209e68751d94",
"notes": "Fragile - handle with care"
}
],
"isBackorder": true,
"isPreorder": true,
"isExchangeItem": true,
"hasInfiniteConsent": true,
"isGifting": true,
"isDonation": true
}
],
"shipInfo": [
{
"shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"taxCode": "FR01",
"locationNumber": "123",
"pickups": [
{
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"pickupType": "PRIMARY"
}
],
"shipToAddress": {
"name": {
"firstName": "Alex",
"middleName": "E",
"lastName": "Doe"
},
"email": "test@example.com",
"phone": {
"number": "123-456-7890",
"type": "MOBILE"
},
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"addressLine3": "Seventh floor",
"addressLine4": "Attention: Pat E. Kake",
"city": "Seattle",
"region": "WA",
"postalCode": "98121",
"countryCode": "US",
"type": "Home",
"latitude": 47.6205,
"longitude": -122.3493
},
"taxDetails": [
{
"name": "STATE",
"taxCode": "FR01",
"rateType": "PERCENTAGE",
"rate": 10,
"amount": 34.56,
"currency": "USD",
"attributes": {}
}
],
"shipMethod": "Parcel post delivery",
"shipToType": "SHIP_TO_ADDRESS",
"estimatedShipDate": "2022-05-12T09:30:31.198Z",
"estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
"shipToPrice": 20,
"shipToDiscount": 12.6,
"discounts": [
{
"quantity": 1,
"amount": 2.99,
"unit": "AMOUNT_OFF",
"value": 10,
"promotionId": "SHIPFREE",
"promotionCode": "SHIPFREE",
"promotionName": "Free Shipping"
}
],
"shipToTaxTotal": 12.6,
"shipmentInstructions": "Handle with care",
"isInvoiced": true,
"attributes": {
"giftMessage": "[]"
}
}
],
"auditLogs": [
{
"lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
"auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
"auditType": "CANCEL",
"employeeId": "6227",
"auditedAt": "2023-03-12T09:24:54.804Z",
"source": "POS",
"reasonCode": "Scratched item",
"subReasonCode": "Scratched item",
"policyCode": "POS",
"note": "Note",
"lineItemNumber": 1,
"sku": "SKU0023",
"quantity": 1,
"amount": 2.4,
"paymentToken": {
"token": "pi_34tr6787rt",
"paymentType": "VISA"
},
"updatedFields": [
{
"fieldName": "UOM",
"fieldOriginalValue": "PK"
}
],
"isSuccess": true,
"attributes": {
"key": "value"
}
}
],
"notes": [
{
"createdAt": "2022-05-12T09:30:31.198Z",
"user": "62272e917b12209e68751d94",
"notes": "Fragile - handle with care"
}
],
"orderReleasedAt": "2022-05-12T09:30:31.198Z",
"createdAt": "2022-05-12T09:30:31.198Z",
"updatedAt": "2022-05-12T09:30:31.198Z"
}