Update Order Attributes

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id

string

required

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

string

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.

x-fabric-request-id

string

Unique request ID

Path Parameters

orderId

string

required

The merchant-defined order identifier provided during the Create Order - POST /orders endpoint.

Body

application/json

An object containing order attributes update request details.

attributes

object

required

An object containing your custom attributes.

Show child attributes

attributes.{key}

object

An object containing your custom attributes.

Example:

{
  "fraudCheckStatus": "UPDATED",
  "loyaltyStatus": "N"
}

Example:

{
  "fraudCheckStatus": "UPDATED",
  "loyaltyStatus": "N"
}

keysToRemove

string[]

A list of keys to be removed.

Response

An object containing order details.

channelId

string

required

Sales channel ID

Example:

"12"

items

object[]

required

Item details

Required array length: 1 - 2147483647 elements

Show child attributes

items.itemId

integer<int32>

required

System-generated unique identifier of item from fabric Products (PIM) service

Example:

1234

items.lineItemId

string

required

Merchant-defined unique identifier for each item in an order. When omitted, fabric will generate it (in UUID format) during order creation.

Example:

"d538b1f1-0e45-43c6-bfc6-9666fc1188ca"

items.lineItemNumber

integer<int32>

required

Merchant-defined line item number to identify each item in an order

Example:

1

items.shipToId

string

required

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.

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

items.sku

string

required

Stock keeping unit (SKU), unique identifier of item

Example:

"P1234"

items.adjustments

object[]

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.

Show child attributes

items.adjustments.adjustmentCounter

integer<int32>

Sequential or incremental counter for price adjustment

Example:

1

items.adjustments.amount

number<double>

Adjustment amount

Example:

2.4

items.adjustments.amountInCurrencies

object[]

The adjustment amount, itemized by each currency used within the order.

Show child attributes

items.adjustments.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.adjustments.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.adjustments.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.adjustments.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info in key-value pairs.

Example:

{
  "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}

items.adjustments.cancelQuantity

integer<int32>

Cancel quantity

Example:

2

items.adjustments.invoiceQuantity

integer<int32>

Total quantity invoiced

Example:

10

items.adjustments.notes

string

Placeholder for additional info, if any.

Example:

"Any additional info"

items.adjustments.quantity

integer<int32>

Adjustment quantity

Example:

2

items.adjustments.reasonCode

string

Reason code

Example:

"RFC"

items.adjustments.returnQuantity

integer<int32>

default:0

Returned quantity of given item

Example:

1

items.adjustments.subReasonCode

string

Subreason code

Example:

"Late shipping"

items.appeasementTotal

number<double>

Appeasement total = summationOfAll(appeasements[].amount and items[].appeasements[].amount)

Example:

5.5

items.appeasementTotalInCurrencies

object[]

Show child attributes

items.appeasementTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.appeasementTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.appeasementTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.appeasements

object[]

Appeasement info

Show child attributes

items.appeasements.amount

number<double>

Merchant-defined appeasement amount, which should not exceed (charged amount - already refunded amount).

Example:

34.56

items.appeasements.amountInCurrencies

object[]

Show child attributes

items.appeasements.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.appeasements.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.appeasements.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.appeasements.appeasementCounter

integer<int32>

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.

Example:

1

items.appeasements.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs

Example:

{
  "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}

items.appeasements.invoicedAmount

number<double>

System-generated amount from Invoice service based on requested amount

Example:

34.56

items.appeasements.invoicedAmountInCurrencies

object[]

Show child attributes

items.appeasements.invoicedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.appeasements.invoicedAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.appeasements.invoicedAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.appeasements.payments

object[]

Show child attributes

items.appeasements.payments.paymentCounter

integer<int32>

Payment counter to identify which payment to refund.

Example:

1

items.appeasements.payments.refundAmount

number<double>

Refund amount for appeasements.

Example:

34.56

items.appeasements.payments.refundAmountInCurrencies

object[]

Show child attributes

items.appeasements.payments.refundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.appeasements.payments.refundAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.appeasements.payments.refundAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.appeasements.reasonCode

string

Merchant-defined appeasement reason code; varies from merchant to merchant.

Example:

"Incorrect Item"

items.appeasements.refunds

object[]

Show child attributes

items.appeasements.refunds.amount

number<double>

Refund Amount

Example:

"-10."

items.appeasements.refunds.amountInCurrencies

object[]

Show child attributes

items.appeasements.refunds.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.appeasements.refunds.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.appeasements.refunds.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.appeasements.refunds.name

string

The name of the fee or tax.

Example:

"Name"

items.appeasements.refunds.type

string

Type of refund

Example:

"ITEM"

items.appeasements.source

string

An optional field used to determine the source that initiated the API request.

Example:

"CSR"

items.appeasements.subReasonCode

string

Subreason code for appeasement, for another layer of classification

Example:

"Late shipping"

items.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

Example:

{
  "colorCode": "001",
  "isDonation": "false",
  "style": "570223020"
}

items.backOrderedQuantity

integer<int32>

Backordered quantity of given item

Example:

10

items.cancellations

object[]

Show child attributes

items.cancellations.amount

number<double>

Amount

Example:

"-20."

items.cancellations.amountInCurrencies

object[]

The amount associated with the cancellation, itemized by each currency used within the original order.

Show child attributes

items.cancellations.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.cancellations.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.cancellations.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.cancellations.attributes

object

Custom attributes

items.cancellations.cancellationCounter

string

An identifier used for cancellations.

Example:

1

items.cancellations.invoicedAmount

number<double>

Invoiced amount

Example:

"-20."

items.cancellations.invoicedAmountInCurrencies

object[]

Show child attributes

items.cancellations.invoicedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.cancellations.invoicedAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.cancellations.invoicedAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.cancellations.payments

object[]

Show child attributes

items.cancellations.payments.paymentCounter

integer<int32>

A sequential or incremental counter associated with a payment for an order. Applicable in refund scenarios to identify the specific payment for refund.

Example:

1

items.cancellations.payments.amount

number<double>

Payment refund amount

Example:

60

items.cancellations.payments.amountInCurrencies

object[]

Show child attributes

items.cancellations.payments.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.cancellations.payments.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.cancellations.payments.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.cancellations.quantity

integer<int32>

The total quantity of an item for this cancellation request.

Example:

10

items.cancellations.reasonCode

string

Reason code

Example:

"Order line cancel"

items.cancellations.refunds

object[]

Show child attributes

items.cancellations.refunds.amount

number<double>

Refund Amount

Example:

"-10."

items.cancellations.refunds.amountInCurrencies

object[]

Show child attributes

items.cancellations.refunds.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.cancellations.refunds.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.cancellations.refunds.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.cancellations.refunds.name

string

The name of the fee or tax.

Example:

"Name"

items.cancellations.refunds.type

string

Type of refund

Example:

"ITEM"

items.cancellations.source

string

An optional field used to determine the source that initiated the API request.

Example:

"CSR"

items.cancellations.status

enum<string>

Cancellation status

Available options:

PROCESSING,

COMPLETED,

REJECTED

Example:

"PROCESSING"

items.cancellations.subReasonCode

string

Sub reason code

Example:

"Late shipping"

items.cancelledAmount

number<double>

Cancelled amount is either voided (payment is only authorized but not captured at checkout) or refunded (amount is authorized and captured at checkout).

Example:

12.4

items.cancelledAmountInCurrencies

object[]

Show child attributes

items.cancelledAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.cancelledAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.cancelledAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.cancelledQuantity

integer<int32>

Cancelled quantity of an item

Example:

10

items.channelId

string

Sales channel ID

Example:

"WHBM"

items.currency

string

Three-letter currency code as defined by ISO-4217

Example:

"USD"

items.deliveredQuantity

integer<int32>

Delivered quantity of an item

Example:

10

items.discounts

object[]

Discount details

Show child attributes

items.discounts.amount

number<double>

Discounted amount for the given quantity within an order.

Example:

2.99

items.discounts.amountInCurrencies

object[]

Show child attributes

items.discounts.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.discounts.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.discounts.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.discounts.invoiceQuantity

integer<int32>

Total quantity invoiced. If customer placed order for 10 quantity of an item and only 2 got shipped, then 2 is the invoiceQuantity.

Example:

10

items.discounts.promotionCode

string

Promotion code used by shoppers to take advantage of an ongoing promotion.

Example:

"HNY2022"

items.discounts.promotionId

string

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.

Example:

"HNY2022"

items.discounts.promotionName

string

Promotion name

Example:

"New Year"

items.discounts.quantity

integer<int32>

Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.

Example:

1

items.discounts.unit

string

Indicates whether the discount is in amount or percentage

Example:

"AMOUNT_OFF"

items.discounts.value

integer<int32>

Value corresponding to unit

Example:

10

items.employeeId

string

Employee (ID or name) who initiated the request

Example:

"5345HJH"

items.exchangeQuantity

integer<int32>

System-generated item quantity that are exchanged

Example:

13

items.fees

object[]

Fee details

Show child attributes

items.fees.amount

number<double>

Tax amount

Example:

34.56

items.fees.amountInCurrencies

object[]

Show child attributes

items.fees.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.fees.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.fees.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.fees.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

Show child attributes

items.fees.attributes.{key}

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

items.fees.currency

string

default:USD

Three-letter currency code as defined by ISO-4217

Example:

"USD"

items.fees.invoiceQuantity

integer<int32>

Total quantity invoiced. If customer placed order for 10 quantity of an item and only 2 got shipped then 2 is the invoiceQuantity

Example:

10

items.fees.name

string

Applied tax name

Example:

"STATE"

items.fees.quantity

integer<int32>

Total number of items in the order

Example:

12

items.fees.refundAmount

number<double>

Total refund amount

Example:

21.5

items.fees.refundAmountInCurrencies

object[]

Show child attributes

items.fees.refundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.fees.refundAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.fees.refundAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.fees.taxCode

string

Tax code applied

Example:

"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.

Example:

true

items.invoiceTotal

number<double>

Invoice total is updated once invoice created

Example:

800

items.invoiceTotalInCurrencies

object[]

Show child attributes

items.invoiceTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.invoiceTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.invoiceTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.invoicedQuantity

integer<int32>

Invoiced quantity of an item

Example:

10

items.isBackorder

boolean

Merchant-defined value. true: Backordered item. false: Ordered item.

Example:

true

items.isDonation

boolean

true: Item is a donation. false: Item is not a donation.

Example:

true

items.isExchangeItem

boolean

Merchant-defined value for exchange scenarios. true: Item is an exchange. false: Item is not an exchange.

Example:

true

items.isGifting

boolean

true: Item is a gift. false: Item is not a gift.

Example:

true

items.isPreorder

boolean

Merchant-defined value. true: Pre-ordered item. false: Ordered item.

Example:

true

items.isFulfillable

boolean

default:true

Determines whether an Allocation document must be created before fulfillment.

If false, the allocation step is skipped and the process continues directly to Invoice & Payment Capture.
If omitted, the system defaults to true.

Example:

true

items.isInventoryManaged

boolean

default:true

Indicates whether the On-Hand / Available to Purchase quantity is managed in fabric OMS.

If false, inventory management is bypassed and no inventory document is created in OMS.
If omitted, the system defaults to true.

Example:

true

items.itemAdjustmentTotal

number<double>

Total price adjustment made to the item.

Example:

123.45

items.itemAdjustmentTotalInCurrencies

object[]

Show child attributes

items.itemAdjustmentTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.itemAdjustmentTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.itemAdjustmentTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.itemDiscountsTotal

number<double>

Item's total discount = summationOfAll(discounts[].amount)'. Refer toamountinorderDiscount`.

Example:

80

items.itemDiscountsTotalInCurrencies

object[]

Show child attributes

items.itemDiscountsTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.itemDiscountsTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.itemDiscountsTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.itemFeeTotal

number<double>

Recalculated item's fee = summationOfAll(itemFeeTotal). Refer to amount in itemFeeDetails

Example:

200

items.itemFeeTotalInCurrencies

object[]

Show child attributes

items.itemFeeTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.itemFeeTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.itemFeeTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.itemName

string

Item name

Example:

"Item"

items.itemShippingTotal

number<double>

Merchant-defined item's shipping total

Example:

10

items.itemShippingTotalInCurrencies

object[]

Show child attributes

items.itemShippingTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.itemShippingTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.itemShippingTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.itemSubtotal

number<double>

Recalculated item's subtotal = itemUnitPrice x (orderedQuantity - cancelledQuantity)

Example:

600

items.itemSubtotalInCurrencies

object[]

Show child attributes

items.itemSubtotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.itemSubtotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.itemSubtotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.itemSubtype

string

Subtype of type, for another layer of classification.

Example:

"Borderfree"

items.itemTaxTotal

number<double>

Recalculated total tax on item = summationOfAll(itemTaxTotal)

Example:

80

items.itemTaxTotalInCurrencies

object[]

Show child attributes

items.itemTaxTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.itemTaxTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.itemTaxTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.itemTotal

number<double>

Recalculated item's total cost = itemSubTotal - itemDiscountTotal + itemTaxTotal + itemFeeTotal.

Example:

800

items.itemTotalInCurrencies

object[]

Show child attributes

items.itemTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.itemTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.itemTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.itemUnitPrice

number<double>

Item's unit price

Example:

10

items.itemUnitPriceInCurrencies

object[]

Show child attributes

items.itemUnitPriceInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.itemUnitPriceInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.itemUnitPriceInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.lineOrderStatus

string

System-generated status for each item in the orders - SHIPPED, RETURNED, CANCELLED, EXCHANGED, VALID, and the like

Example:

"VALID"

items.notes

object[]

For additional information, to be used by Customer Service Representative (CSR) only

Show child attributes

items.notes.createdAt

string

Time note was created (UTC)

Example:

"2022-05-12T09:30:31.198Z"

items.notes.notes

string

Additional info about the order, if any

Example:

"Fragile - handle with care"

items.notes.user

string

Customer Service Representative or Employee (ID or name) who created the note

Example:

"62272e917b12209e68751d94"

items.orderedQuantity

integer<int32>

Ordered quantity of given item

Example:

60

items.orderedQuantityToShip

integer<int32>

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.

Example:

10

items.originalDiscounts

number<double>

System-generated total discount, auto-filled by Orders service when the order is placed.

Example:

50

items.originalDiscountsInCurrencies

object[]

Show child attributes

items.originalDiscountsInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.originalDiscountsInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.originalDiscountsInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.originalFeeTotal

number<double>

System-generated fee total, auto-filled by fabric Orders when the order is placed. This is saved for reference in case the value changes later.

Example:

300

items.originalFeeTotalInCurrencies

object[]

Show child attributes

items.originalFeeTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.originalFeeTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.originalFeeTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.originalItemAdjustmentTotalInCurrencies

object[]

Show child attributes

items.originalItemAdjustmentTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.originalItemAdjustmentTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.originalItemAdjustmentTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.originalItemSubtotal

number<double>

System-generated total discount, auto-filled by Orders service when the order is placed.

Example:

800

items.originalItemSubtotalInCurrencies

object[]

Show child attributes

items.originalItemSubtotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.originalItemSubtotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.originalItemSubtotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.originalItemTotal

number<double>

System-generated item total cost, auto-filled by Orders service when the order is placed

Example:

500

items.originalItemTotalInCurrencies

object[]

Show child attributes

items.originalItemTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.originalItemTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.originalItemTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.originalOutstandingItemTotalInCurrencies

object[]

Show child attributes

items.originalOutstandingItemTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.originalOutstandingItemTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.originalOutstandingItemTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.originalShippingTotal

number<double>

System-generated total shipping cost, auto-filled by Orders service when the order is placed.

Example:

80

items.originalShippingTotalInCurrencies

object[]

Show child attributes

items.originalShippingTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.originalShippingTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.originalShippingTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.originalTaxTotal

number<double>

System-generated total tax, auto-filled by Orders service when the order is placed.

Example:

90

items.originalTaxTotalInCurrencies

object[]

Show child attributes

items.originalTaxTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.originalTaxTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.originalTaxTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.outstandingItemTotalInCurrencies

object[]

Show child attributes

items.outstandingItemTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.outstandingItemTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.outstandingItemTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.parentLineItemNumber

integer<int32>

Applicable in exchange scenarios. Item being returned is the parentLineItemNumber.

Example:

12

items.pendingExchangeQuantity

integer<int32>

System-generated item quantity pending for exchange

Example:

12

items.pendingReturnQuantity

integer<int32>

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.

Example:

10

items.pendingShippedBackOrderQuantity

integer<int32>

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.

Example:

10

items.processingReturnQuantity

integer<int32>

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

Example:

10

items.quantityInStatus

object

Item quantity for each status

Show child attributes

items.quantityInStatus.cancelled

integer<int32>

Cancelled quantity of given item

Example:

10

items.quantityInStatus.created

integer<int32>

Ordered quantity of given item

Example:

10

items.quantityInStatus.delivered

integer<int32>

Delivered quantity of given item

Example:

10

items.quantityInStatus.hold

integer<int32>

Held quantity of given item

Example:

10

items.quantityInStatus.pendingShipped

integer<int32>

Pending quantity of given item

Example:

10

items.quantityInStatus.returned

integer<int32>

Returned quantity of given item

Example:

10

items.quantityInStatus.shipped

integer<int32>

Shipped quantity of given item

Example:

10

items.refundAmount

number<double>

Merchant-defined total refund amount

Example:

21.5

items.refundAmountInCurrencies

object[]

Show child attributes

items.refundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.refundAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.refundAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.rejectedReturnQuantity

integer<int32>

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.

Example:

10

items.reshippedQuantity

integer<int32>

Reshipped quantity of given item (in case of lost shipment)

Example:

10

items.returnedQuantity

integer<int32>

Returned quantity of given item

Example:

10

items.returns

object[]

Order return details

Show child attributes

items.returns.attributes

object

Attributes

Show child attributes

items.returns.attributes.{key}

object

Attributes

Example:

{ "transactionId": "0R12TQ46" }

Example:

{ "transactionId": "0R12TQ46" }

items.returns.exchangeLineItemId

string

Exchange line item ID

Example:

"62f3dfc438bcab1951be0a19"

items.returns.fees

object[]

Show child attributes

items.returns.fees.amount

number<double>

Merchant-defined return amount

Example:

34.56

items.returns.fees.amountInCurrencies

object[]

Show child attributes

items.returns.fees.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.returns.fees.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.returns.fees.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.returns.fees.name

string

Fee name

Example:

"RETURN_FEE"

items.returns.fees.reason

string

Merchant-defined return reason

Example:

"Return fee"

items.returns.fees.type

enum<string>

Return fee type

Available options:

TAX,

DISCOUNT,

FEE,

ITEM,

ADJUSTMENT

Example:

"FEE"

items.returns.invoicedAmount

number<double>

System-generated amount from Invoice service based on requested amount

Example:

11.29

items.returns.isExchangeItemReturned

boolean

default:false

true: Item received for exchange is returned. false: Item received for exchange is not returned.

Example:

true

items.returns.reasonCode

string

Merchant-defined reason code for return

Example:

"Incorrect item"

items.returns.refundAmount

number<double>

Refund amount

Example:

11.29

items.returns.refunds

object[]

Show child attributes

items.returns.refunds.amount

number<double>

Merchant-defined return amount

Example:

34.56

items.returns.refunds.amountInCurrencies

object[]

Show child attributes

items.returns.refunds.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.returns.refunds.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.returns.refunds.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.returns.refunds.name

string

Fee name

Example:

"RETURN_FEE"

items.returns.refunds.reason

string

Merchant-defined return reason

Example:

"Return fee"

items.returns.refunds.type

enum<string>

Return fee type

Available options:

TAX,

DISCOUNT,

FEE,

ITEM,

ADJUSTMENT

Example:

"FEE"

items.returns.returnRequestCounter

integer<int32>

Unique, sequential, or incremental counter for return request

Example:

1

items.returns.returnsReceivedAt

string<date-time>

System-generated time of returned item that has come back to the facility (UTC)

Example:

"2022-09-14T14:07:36.861Z"

items.returns.shipmentId

string

24-character system-generated shipment ID

Example:

"62b37697c67b204dd18a7465"

items.returns.shipmentInvoice

object

Shipment Invoice resource

Show child attributes

items.returns.shipmentInvoice.invoiceId

string

required

Unique Id of the invoice

Example:

"62ff5c0bec0aed3c86202c32"

items.returns.shipmentInvoice.invoiceNumber

string

Unique number of the invoice

Example:

"23940791"

items.returns.shipmentInvoice.invoicedAt

string<date-time>

Date when order invoiced

Example:

"2022-08-01T20:03:28.483971941Z"

items.returns.shipmentLineItemId

string

Unique identifier for each item in the shipment

Example:

"234"

items.returns.shipmentQuantity

integer<int32>

default:0

Shipped quantity of given item

Example:

1

items.returns.source

string

An optional field used to determine the source that initiated the API request.

Example:

"CSR"

items.shippedQuantity

integer<int32>

Shipped quantity of an item

Example:

10

items.taxCode

string

Applicable tax code, varies from state to state

Example:

"FR01"

items.taxDetails

object[]

Tax details

Show child attributes

items.taxDetails.amount

number<double>

Tax amount

Example:

34.56

items.taxDetails.amountInCurrencies

object[]

Show child attributes

items.taxDetails.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

items.taxDetails.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

items.taxDetails.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

items.taxDetails.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

Show child attributes

items.taxDetails.attributes.{key}

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

items.taxDetails.currency

string

default:USD

Three-letter currency code as defined by ISO-4217

Example:

"USD"

items.taxDetails.name

string

Applied tax name

Example:

"STATE"

items.taxDetails.rate

number<double>

Rate

Example:

10

items.taxDetails.rateType

string

Rate type

Example:

"PERCENTAGE"

items.taxDetails.taxCode

string

Tax code applied

Example:

"FR01"

items.type

string

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.

Example:

"WEB_SHIP"

items.uom

string

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.

Example:

"EA"

items.vendorId

string

Vendor ID. Applicable in drop shipping to indicate vendor responsible for given item.

Example:

"P1234"

orderNumber

string

required

Merchant-defined order identifier. If omitted, this is generated by fabric's sequence generator using Configuration service

Example:

"309019176"

shipInfo

object[]

required

Required array length: 1 - 2147483647 elements

Show child attributes

shipInfo.shipToId

string

required

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.

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

shipInfo.attributes

object

User defined custom attributes. This is a placeholder for additional info (in key-value pairs).

Example:

{ "giftMessage": "[]" }

shipInfo.discounts

object[]

Show child attributes

shipInfo.discounts.amount

number<double>

Discounted amount for the given quantity

Example:

2.99

shipInfo.discounts.amountInCurrencies

object[]

Show child attributes

shipInfo.discounts.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.discounts.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

shipInfo.discounts.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

shipInfo.discounts.promotionCode

string

Promotion code used by shoppers to take advantage of an ongoing promotion.

Example:

"SHIPFREE"

shipInfo.discounts.promotionId

string

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.

Example:

"SHIPFREE"

shipInfo.discounts.promotionName

string

Promotion name

Example:

"Free Shipping"

shipInfo.discounts.quantity

integer<int32>

Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.

Example:

1

shipInfo.discounts.unit

string

Indicates whether the discount is in amount or percentage

Example:

"AMOUNT_OFF"

shipInfo.discounts.value

integer<int32>

Value corresponding to unit

Example:

10

shipInfo.estimatedDeliveryDate

string<date-time>

Estimated delivery time (UTC) provided by carrier

Example:

"2022-05-12T09:30:31.198Z"

shipInfo.estimatedShipDate

string<date-time>

Estimated shipping time (UTC) provided by merchant

Example:

"2022-05-12T09:30:31.198Z"

shipInfo.isInvoiced

boolean

default:false

true: At least one captured invoice is created by Invoice service. false: Captured invoice is not created.

Example:

true

shipInfo.locationNumber

string

Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.

Example:

"WH334"

shipInfo.pickups

object[]

Order pickup details

Show child attributes

shipInfo.pickups.email

string

Contact person's email

Example:

"[email protected]"

shipInfo.pickups.name

object

Contact person's name

Show child attributes

shipInfo.pickups.name.firstName

string

Contact person's first name

Example:

"Alex"

shipInfo.pickups.name.lastName

string

Contact person's last name

Example:

"Doe"

shipInfo.pickups.name.middleName

string

Contact person's middle name or initial

Example:

"E"

shipInfo.pickups.phone

object

Contact person's phone details.

Show child attributes

shipInfo.pickups.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

shipInfo.pickups.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.pickups.pickupType

enum<string>

Order pickup type

Available options:

PRIMARY,

ALTERNATE

Example:

"PRIMARY"

shipInfo.shipMethod

string

Shipping method

Example:

"Parcel post delivery"

shipInfo.shipToAddress

object

Address details

Show child attributes

shipInfo.shipToAddress.addressLine1

string

required

Address line 1

Example:

"123 Main St."

shipInfo.shipToAddress.city

string

required

City name

Example:

"Seattle"

shipInfo.shipToAddress.countryCode

string

required

ISO 3166-1 alpha-2 based country code

Example:

"US"

shipInfo.shipToAddress.latitude

number<double>

required

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.

Example:

47.6205

shipInfo.shipToAddress.longitude

number<double>

required

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.

Example:

-122.3493

shipInfo.shipToAddress.postalCode

string

required

Postal or ZIP code

Example:

"98121"

shipInfo.shipToAddress.region

string

required

Region or state

Example:

"WA"

shipInfo.shipToAddress.type

string

required

Address type

Example:

"Home"

shipInfo.shipToAddress.addressLine2

string

Address line 2

Example:

"Suite 100"

shipInfo.shipToAddress.addressLine3

string

Address line 3

Example:

"Seventh floor"

shipInfo.shipToAddress.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

shipInfo.shipToAddress.email

string

Contact person's email

Example:

"[email protected]"

shipInfo.shipToAddress.name

object

Contact person's name

Show child attributes

shipInfo.shipToAddress.name.firstName

string

Contact person's first name

Example:

"Alex"

shipInfo.shipToAddress.name.lastName

string

Contact person's last name

Example:

"Doe"

shipInfo.shipToAddress.name.middleName

string

Contact person's middle name or initial

Example:

"E"

shipInfo.shipToAddress.phone

object

Contact person's phone details.

Show child attributes

shipInfo.shipToAddress.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

shipInfo.shipToAddress.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.shipToDiscount

number<double>

Merchant-defined shipping discount amount

Example:

12.6

shipInfo.shipToDiscountInCurrencies

object[]

Show child attributes

shipInfo.shipToDiscountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.shipToDiscountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

shipInfo.shipToDiscountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

shipInfo.shipToPrice

number<double>

Merchant-defined shipping cost

Example:

20

shipInfo.shipToPriceInCurrencies

object[]

Show child attributes

shipInfo.shipToPriceInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.shipToPriceInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

shipInfo.shipToPriceInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

shipInfo.shipToTaxTotal

number<double>

Total shipping tax

Example:

12.6

shipInfo.shipToTaxTotalInCurrencies

object[]

Show child attributes

shipInfo.shipToTaxTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.shipToTaxTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

shipInfo.shipToTaxTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

shipInfo.shipToType

string

Type of shipping address. There are no pre-defined values; the possible values are SDD (same day delivery), point-of-sale (POS), etc.

Example:

"SHIP_TO_ADDRESS"

shipInfo.shipToUnitPrice

number<double>

A number indicating the ship to unit price.

Example:

20

shipInfo.shipToUnitPriceInCurrencies

object[]

Show child attributes

shipInfo.shipToUnitPriceInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.shipToUnitPriceInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

shipInfo.shipToUnitPriceInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

shipInfo.shipmentInstructions

string

Shipment instructions

Example:

"Handle with care"

shipInfo.taxCode

string

Applicable tax code, varies from state to state

Example:

"FR01"

shipInfo.taxDetails

object[]

Show child attributes

shipInfo.taxDetails.amount

number<double>

Tax amount

Example:

34.56

shipInfo.taxDetails.amountInCurrencies

object[]

Show child attributes

shipInfo.taxDetails.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.taxDetails.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

shipInfo.taxDetails.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

shipInfo.taxDetails.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

Show child attributes

shipInfo.taxDetails.attributes.{key}

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

shipInfo.taxDetails.currency

string

default:USD

Three-letter currency code as defined by ISO-4217

Example:

"USD"

shipInfo.taxDetails.name

string

Applied tax name

Example:

"STATE"

shipInfo.taxDetails.rate

number<double>

Rate

Example:

10

shipInfo.taxDetails.rateType

string

Rate type

Example:

"PERCENTAGE"

shipInfo.taxDetails.taxCode

string

Tax code applied

Example:

"FR01"

statusCode

string

required

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.

Example:

"ORDER_CREATED"

version

integer<int64>

required

Current version of order document. Indicates the number of times the order is updated by any operation.

Example:

2

adjustmentTotal

number<double>

The total amount of price adjustments for all items of the order.

Example:

123.45

adjustmentTotalInCurrencies

object[]

Show child attributes

adjustmentTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

adjustmentTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

adjustmentTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

adjustments

object[]

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.

Show child attributes

adjustments.adjustmentCounter

integer<int32>

Sequential or incremental counter for price adjustment

Example:

1

adjustments.amount

number<double>

Adjustment amount

Example:

2.4

adjustments.amountInCurrencies

object[]

The adjustment amount, itemized by each currency used within the order.

Show child attributes

adjustments.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

adjustments.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

adjustments.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

adjustments.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info in key-value pairs.

Example:

{
  "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}

adjustments.cancelQuantity

integer<int32>

Cancel quantity

Example:

2

adjustments.invoiceQuantity

integer<int32>

Total quantity invoiced

Example:

10

adjustments.notes

string

Placeholder for additional info, if any.

Example:

"Any additional info"

adjustments.quantity

integer<int32>

Adjustment quantity

Example:

2

adjustments.reasonCode

string

Reason code

Example:

"RFC"

adjustments.returnQuantity

integer<int32>

default:0

Returned quantity of given item

Example:

1

adjustments.subReasonCode

string

Subreason code

Example:

"Late shipping"

allocatedAt

string<date-time>

System-generated order allocation time (UTC) once the order is allocated using Allocation service

Example:

"2022-05-12T09:30:31.198Z"

appeasementTotal

number<double>

Final appeasement amount

Example:

12.34

appeasementTotalInCurrencies

object[]

Show child attributes

appeasementTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

appeasementTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

appeasementTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

appeasements

object[]

Show child attributes

appeasements.amount

number<double>

Merchant-defined appeasement amount, which should not exceed (charged amount - already refunded amount).

Example:

34.56

appeasements.amountInCurrencies

object[]

Show child attributes

appeasements.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

appeasements.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

appeasements.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

appeasements.appeasementCounter

integer<int32>

Example:

1

appeasements.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs

Example:

{
  "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}

appeasements.invoicedAmount

number<double>

System-generated amount from Invoice service based on requested amount

Example:

34.56

appeasements.invoicedAmountInCurrencies

object[]

Show child attributes

appeasements.invoicedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

appeasements.invoicedAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

appeasements.invoicedAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

appeasements.payments

object[]

Show child attributes

appeasements.payments.paymentCounter

integer<int32>

Payment counter to identify which payment to refund.

Example:

1

appeasements.payments.refundAmount

number<double>

Refund amount for appeasements.

Example:

34.56

appeasements.payments.refundAmountInCurrencies

object[]

Show child attributes

appeasements.payments.refundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

appeasements.payments.refundAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

appeasements.payments.refundAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

appeasements.reasonCode

string

Merchant-defined appeasement reason code; varies from merchant to merchant.

Example:

"Incorrect Item"

appeasements.refunds

object[]

Show child attributes

appeasements.refunds.amount

number<double>

Refund Amount

Example:

"-10."

appeasements.refunds.amountInCurrencies

object[]

Show child attributes

appeasements.refunds.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

appeasements.refunds.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

appeasements.refunds.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

appeasements.refunds.name

string

The name of the fee or tax.

Example:

"Name"

appeasements.refunds.type

string

Type of refund

Example:

"ITEM"

appeasements.source

string

An optional field used to determine the source that initiated the API request.

Example:

"CSR"

appeasements.subReasonCode

string

Subreason code for appeasement, for another layer of classification

Example:

"Late shipping"

attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

Example:

{
  "fraudCheckStatus": "UPDATED",
  "loyaltyStatus": "N"
}

auditLogs

object[]

Show child attributes

auditLogs.amount

number<double>

Amount for which audit is done

Example:

2.4

auditLogs.attributes

object

Custom attributes

Example:

{ "key": "value" }

auditLogs.auditId

string

System-generated audit ID (UUID format)

Example:

"a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111"

auditLogs.auditType

string

Audit type such as cancel, return, etc.

Example:

"CANCEL"

auditLogs.auditedAt

string<date-time>

Audit time (UTC)

Example:

"2023-03-12T09:24:54.804Z"

auditLogs.employeeId

string

Employee (ID or name) who made the last update

Example:

"6227"

auditLogs.isSuccess

boolean

default:false

true: Update operation (any update to the service) is successful false: Update operation has failed

Example:

true

auditLogs.lineItemId

string

Merchant-defined unique identifier for each item in an order. When omitted, fabric will generate it during order creation, in UUID format.

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

auditLogs.lineItemNumber

integer<int32>

Item identifier

Example:

1

auditLogs.note

string

Additional info, if any

Example:

"Note"

auditLogs.paymentToken

object

An object containing the order payment token details.

Show child attributes

auditLogs.paymentToken.paymentType

string

Payment type, for example, credit card payment providers can be Visa, Mastercard, American express, etc.

Example:

"VISA"

auditLogs.paymentToken.token

string

Payment token provided by payment provider

Example:

"pi_34tr6787rt"

auditLogs.policyCode

string

Configurable in Copilot as per requirement. If omitted, default policy is used.

Example:

"POS"

auditLogs.quantity

integer<int32>

Ordered quantity of given item

Example:

1

auditLogs.reasonCode

string

Merchant-defined reason code, varies from merchant to merchant

Example:

"Scratched item"

auditLogs.sku

string

Stock keeping unit (SKU), unique item identifier

Example:

"SKU0023"

auditLogs.source

string

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.

Example:

"POS"

auditLogs.subReasonCode

string

Merchant-defined sub reason code; provides more clarity to audit reason

Example:

"Scratched item"

auditLogs.updatedFields

object[]

Audit log for change history

Show child attributes

auditLogs.updatedFields.fieldName

string

Field or property name that was updated

Example:

"UOM"

auditLogs.updatedFields.fieldOriginalValue

string

Original value of fieldName before it was updated

Example:

"PK"

cancelTotal

number<double>

Amount to be returned after order cancellation, calculated as cancelledQuantity / orderedQuantity * itemTotal

Example:

12.34

cancelTotalInCurrencies

object[]

Show child attributes

cancelTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

cancelTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

cancelTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

cancellations

object[]

Show child attributes

cancellations.amount

number<double>

Amount

Example:

"-20."

cancellations.amountInCurrencies

object[]

Show child attributes

cancellations.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

cancellations.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

cancellations.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

cancellations.attributes

object

Custom attributes

Example:

{
  "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}

cancellations.cancellationCounter

string

An identifier used for cancellations.

Example:

1

cancellations.invoicedAmount

number<double>

Invoiced amount

Example:

"-20."

cancellations.invoicedAmountInCurrencies

object[]

Show child attributes

cancellations.invoicedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

cancellations.invoicedAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

cancellations.invoicedAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

cancellations.payments

object[]

Show child attributes

cancellations.payments.paymentCounter

integer<int32>

A sequential or incremental counter associated with a payment for an order. Applicable in refund scenarios to identify the specific payment for refund.

Example:

1

cancellations.payments.amount

number<double>

Payment refund amount

Example:

60

cancellations.payments.amountInCurrencies

object[]

Show child attributes

cancellations.payments.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

cancellations.payments.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

cancellations.payments.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

cancellations.reasonCode

string

Reason code

Example:

"Order Line Cancel"

cancellations.refunds

object[]

Show child attributes

cancellations.refunds.amount

number<double>

Refund Amount

Example:

"-10."

cancellations.refunds.amountInCurrencies

object[]

Show child attributes

cancellations.refunds.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

cancellations.refunds.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

cancellations.refunds.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

cancellations.refunds.name

string

The name of the fee or tax.

Example:

"Name"

cancellations.refunds.type

string

Type of refund

Example:

"ITEM"

cancellations.source

string

An optional field used to determine the source that initiated the API request.

Example:

"CSR"

cancellations.status

enum<string>

Cancellation Status

Available options:

PROCESSING,

COMPLETED,

REJECTED

Example:

"PROCESSING"

cancellations.subReasonCode

string

Sub reason code

Example:

"Late shipping"

cancelledAt

string<date-time>

System-generated order cancellation time in 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.

Example:

"2022-05-12T09:30:31.198Z"

cartId

string

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.

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

createdAt

string<date-time>

Order creation time (UTC)

Example:

"2022-05-12T09:30:31.198Z"

currencies

object

The supported currency groups you defined.

Show child attributes

currencies.groups

object[]

Show child attributes

currencies.groups.currency

string

required

Currency in ISO-4217

Example:

"USD"

currencies.groups.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

currencies.groups.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

Example:

{ "fxId": "ID123" }

currencies.groups.conversionRate

number<double>

conversion rate

Example:

1

currencies.primaryCurrency

string

Primary currency for order

Example:

"SHOPPER"

currency

string

Three-letter currency code as defined by ISO-4217

Example:

"USD"

customer

object

Invoice customer

Show child attributes

customer.accountId

string

Customer's loyalty account ID or external identifier that is used to track their loyalty program activity and rewards earned.

Example:

"62272e917b12209e68751d94"

customer.company

string

Shopper's company name. This may be used for company discounts.

Example:

"Demo Inc"

customer.email

string

Contact person's email

Example:

"[email protected]"

customer.employeeId

string

Employee (ID or name) who initiated an update request

Example:

"62272e917b12209e68751d94"

customer.name

object

Contact person's name

Show child attributes

customer.name.firstName

string

Contact person's first name

Example:

"Alex"

customer.name.lastName

string

Contact person's last name

Example:

"Doe"

customer.name.middleName

string

Contact person's middle name or initial

Example:

"E"

customer.phone

object

Contact person's phone details.

Show child attributes

customer.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

customer.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

customer.userId

string

Identifier of the logged in user who initiated the request. This could be from either fabric Identity service or an external Identity service.

Example:

"62272e917b12209e68751d94"

discounts

object[]

Show child attributes

discounts.amount

number<double>

Discounted amount for the given quantity within an order.

Example:

2.99

discounts.amountInCurrencies

object[]

Show child attributes

discounts.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

discounts.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

discounts.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

discounts.invoiceQuantity

integer<int32>

Total quantity invoiced. If customer placed order for 10 quantity of an item and only 2 got shipped, then 2 is the invoiceQuantity.

Example:

10

discounts.promotionCode

string

Promotion code used by shoppers to take advantage of an ongoing promotion.

Example:

"HNY2022"

discounts.promotionId

string

Example:

"HNY2022"

discounts.promotionName

string

Promotion name

Example:

"New Year"

discounts.quantity

integer<int32>

Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.

Example:

1

discounts.unit

string

Indicates whether the discount is in amount or percentage

Example:

"AMOUNT_OFF"

discounts.value

integer<int32>

Value corresponding to unit

Example:

10

employeeId

string

Employee (ID or name) who initiated the request

Example:

"43278"

erroredFields

object[]

Show child attributes

erroredFields.amended

boolean

required

A boolean that signifies if the error has been amended.

Example:

false

erroredFields.errorMessage

string

required

The reason the error occurred.

Example:

"Invalid email address"

erroredFields.fieldName

string

required

The name of the field where the error occurred.

Example:

"shipInfo.shipToAddress.email"

feeTotal

number<double>

Recalculated total fee, calculated as orderedQuantity* itemFeeTotal

Example:

12.34

feeTotalInCurrencies

object[]

Show child attributes

feeTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

feeTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

feeTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

fees

object[]

Show child attributes

fees.amount

number<double>

Tax amount

Example:

34.56

fees.amountInCurrencies

object[]

Show child attributes

fees.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

fees.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

fees.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

fees.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

Show child attributes

fees.attributes.{key}

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

fees.currency

string

default:USD

Three-letter currency code as defined by ISO-4217

Example:

"USD"

fees.invoicedAmount

number<double>

System-generated amount from Invoice service based on requested amount

Example:

34.56

fees.invoicedAmountInCurrencies

object[]

Show child attributes

fees.invoicedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

fees.invoicedAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

fees.invoicedAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

fees.name

string

Applied tax name

Example:

"STATE"

fees.rate

number<double>

Rate

Example:

10

fees.rateType

string

Rate type

Example:

"PERCENTAGE"

fees.taxCode

string

Tax code applied

Example:

"FR01"

invoiceTotal

number<double>

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.

Example:

12.34

invoiceTotalInCurrencies

object[]

Show child attributes

invoiceTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

invoiceTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

invoiceTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

notes

object[]

Show child attributes

notes.createdAt

string

Time note was created (UTC)

Example:

"2022-05-12T09:30:31.198Z"

notes.notes

string

Additional info about the order, if any

Example:

"Fragile - handle with care"

notes.user

string

Customer Service Representative or Employee (ID or name) who created the note

Example:

"62272e917b12209e68751d94"

orderDiscount

number<double>

Recalculated order discount

Example:

1.23

orderDiscountInCurrencies

object[]

Show child attributes

orderDiscountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orderDiscountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

orderDiscountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

orderId

string

24-character system-generated order ID

Example:

"5349b4ddd2781d08c09890f4"

orderExternalId

string

A merchant-defined external order identifier.
This field is optional and can be used to reference the order in external systems such as an ERP, OMS, or CRM.

Example:

"191763090_O1231"

orderReleasedAt

string<date-time>

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.

Example:

"2022-05-12T09:30:31.198Z"

orderSubtotal

number<double>

Recalculated orderSubtotal - summationOfAll(itemSubTotal)

Example:

123.45

orderSubtotalInCurrencies

object[]

Show child attributes

orderSubtotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orderSubtotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

orderSubtotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

orderTotal

number<double>

Total amount to be charged for the order = orderSubTotal - orderDiscountTotal + orderFeeTotal + orderTaxTotal

Example:

146.9

orderTotalInCurrencies

object[]

Show child attributes

orderTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orderTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

orderTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

orderedAt

string<date-time>

Merchant-defined order creation time in UTC. It is mandatory in the request body of Create Order endpoint - POST /orders.

Example:

"2022-05-12T09:30:31.198Z"

originalAdjustmentTotal

number<double>

Original adjustment total

Example:

123.45

originalAdjustmentTotalInCurrencies

object[]

Show child attributes

originalAdjustmentTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

originalAdjustmentTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

originalAdjustmentTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

originalDiscount

number<double>

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.

Example:

1.45

originalDiscountInCurrencies

object[]

Show child attributes

originalDiscountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

originalDiscountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

originalDiscountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

originalFeeTotal

number<double>

System-generated total fees, auto-filled by Orders service when the order is placed.

Example:

12.34

originalFeeTotalInCurrencies

object[]

Show child attributes

originalFeeTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

originalFeeTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

originalFeeTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

originalOrderTotal

number<double>

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.

Example:

146.9

originalOrderTotalInCurrencies

object[]

Show child attributes

originalOrderTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

originalOrderTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

originalOrderTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

originalSubtotal

number<double>

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.

Example:

113.45

originalSubtotalInCurrencies

object[]

Show child attributes

originalSubtotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

originalSubtotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

originalSubtotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

originalTaxTotal

number<double>

System-generated total tax, auto-filled by Orders service when the order is placed.

Example:

12.34

originalTaxTotalInCurrencies

object[]

Show child attributes

originalTaxTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

originalTaxTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

originalTaxTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

payments

object[]

Show child attributes

payments.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

Example:

{
  "captureCurrencyCode": "USD",
  "payerId": "M7AWTK3YK3B46",
  "referenceId": "4DY41894J2904533S"
}

payments.authorizationAttempts

integer<int64>

An integer representing the number of payment authorization attempts.

Example:

0

payments.authorizedAmount

number<double>

Amount authorized to be debited from the given paymentMethod

Example:

123.2

payments.authorizedAmountInCurrencies

object[]

Show child attributes

payments.authorizedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

payments.authorizedAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

payments.authorizedAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

payments.billToAddress

object

Address details

Show child attributes

payments.billToAddress.addressLine1

string

required

Address line 1

Example:

"123 Main St."

payments.billToAddress.city

string

required

City name

Example:

"Seattle"

payments.billToAddress.countryCode

string

required

ISO 3166-1 alpha-2 based country code

Example:

"US"

payments.billToAddress.latitude

number<double>

required

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.

Example:

47.6205

payments.billToAddress.longitude

number<double>

required

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.

Example:

-122.3493

payments.billToAddress.postalCode

string

required

Postal or ZIP code

Example:

"98121"

payments.billToAddress.region

string

required

Region or state

Example:

"WA"

payments.billToAddress.type

string

required

Address type

Example:

"Home"

payments.billToAddress.addressLine2

string

Address line 2

Example:

"Suite 100"

payments.billToAddress.addressLine3

string

Address line 3

Example:

"Seventh floor"

payments.billToAddress.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

payments.billToAddress.email

string

Contact person's email

Example:

"[email protected]"

payments.billToAddress.name

object

Contact person's name

Show child attributes

payments.billToAddress.name.firstName

string

Contact person's first name

Example:

"Alex"

payments.billToAddress.name.lastName

string

Contact person's last name

Example:

"Doe"

payments.billToAddress.name.middleName

string

Contact person's middle name or initial

Example:

"E"

payments.billToAddress.phone

object

Contact person's phone details.

Show child attributes

payments.billToAddress.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

payments.billToAddress.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

payments.chargedAmount

number<double>

Amount charged to the given paymentMethod

Example:

60

payments.chargedAmountInCurrencies

object[]

Show child attributes

payments.chargedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

payments.chargedAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

payments.chargedAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

payments.currency

string

Three-letter currency code as defined by ISO-4217

Example:

"USD"

payments.isFinalCapture

boolean

true: Payment is final capture. false: Payment is not a final capture.

Example:

false

payments.isPartialCapture

boolean

true: Payment is partial capture. false: Payment is full capture.

Example:

false

payments.paidAt

string<date-time>

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.

Example:

"2022-01-27T16:15:58-05:00"

payments.paymentCounter

integer<int32>

A sequential or incremental counter associated with a payment for an order. Applicable in refund scenarios to identify the specific payment for refund.

Example:

1

payments.paymentIdentifier

object

An object containing the details of payment modes and payment identifiers.

Show child attributes

payments.paymentIdentifier.cardIdentifier

string

Last 4 digits of the card

Example:

"3456"

payments.paymentIdentifier.expirationMonth

string

Card expiration month

Example:

"12"

payments.paymentIdentifier.expirationYear

string

Card expiration year

Example:

"2029"

payments.paymentIdentifier.fabricPaymentReference

string

System-generated UUID referenced internally for Invoice and Orders services.

Example:

"f886c96c-5f65-11ed-9b6a-0242ac120002"

payments.paymentIdentifier.paymentId

string

Merchant provided unique identifier for a payment based on payment connector. When omitted, it is a fabric-generated UUID.

Example:

"62272e917b12209e68751d94"

payments.paymentLogs

object[]

Payment details

Show child attributes

payments.paymentLogs.amount

number

Transaction amount for the payment operation

Example:

-12.4

payments.paymentLogs.amountInCurrencies

object[]

The details of the CurrencyList, itemized by each currency used within the order.

Show child attributes

payments.paymentLogs.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

payments.paymentLogs.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

payments.paymentLogs.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

payments.paymentLogs.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

Example:

{ "key": "value" }

payments.paymentLogs.data

object

An object containing payment details.

Show child attributes

payments.paymentLogs.data.body

object

Payment info

Show child attributes

payments.paymentLogs.data.body.attributes

object

Merchant-defined custom attributes. This is a placeholder for additional info (in key-value pairs).

Example:

{ "key": "value" }

payments.paymentLogs.data.body.errors

object[]

Error details

Show child attributes

payments.paymentLogs.data.body.errors.{key}

object

Error map

Example:

{ "key": "value" }

payments.paymentLogs.data.body.responseCode

string

Response code such as success, OK, or failure

Example:

"OK"

payments.paymentLogs.data.body.status

string

Payment status such as Authorized, Captured, etc.

Example:

"Authorized"

payments.paymentLogs.data.body.transactionId

string

Transaction ID such as the point-of-sale system's version of the orderId.

Example:

"328942333412"

payments.paymentLogs.data.body.transactionTimestamp

string

Transaction time (UTC) when the payment was successful

Example:

"2022-04-10T23:00:45:12.111Z"

payments.paymentLogs.data.paymentStatusCode

string

Status code for payment. There are no pre-defined values; possible values are 200, 400, 402, etc.

Example:

"200"

payments.paymentLogs.id

string

ID provided by payment gateway in response to payment operation

Example:

"328942333412"

payments.paymentLogs.paymentId

string

Merchant-provided unique identifier for a payment based on payment connector. When omitted, this value will be generated by fabric in UUID format.

Example:

"328942333412"

payments.paymentLogs.paymentLogId

string

ID generated by fabric to uniquely identify the payment log

Example:

"328942333412"

payments.paymentLogs.paymentLogRefId

string

Payment reference log ID with which this record is associated

Example:

"328942333412"

payments.paymentLogs.status

string

Payment status such as Authorized, Captured, etc.

Example:

"Authorized"

payments.paymentLogs.type

string

Transaction type such as VOID, CAPTURED, REDUND, etc.

Example:

"REFUND"

payments.paymentMethod

string

Payment method such as PayPal or credit card

Example:

"CREDIT_CARD"

payments.paymentProvider

string

Payment provider

Example:

"stripe"

payments.paymentStatus

string

Payment status. There are no pre-defined values; possible values are Paid, Partially Paid, Authorized, and Error.

Example:

"Paid"

payments.paymentToken

object

An object containing the order payment token details.

Show child attributes

payments.paymentToken.paymentType

string

Payment type, for example, credit card payment providers can be Visa, Mastercard, American express, etc.

Example:

"VISA"

payments.paymentToken.token

string

Payment token provided by payment provider

Example:

"pi_34tr6787rt"

payments.reauthorizationAttempts

integer<int64>

An integer representing the number of payment reauthorization attempts.

Example:

0

payments.refundAmount

number<double>

Merchant-defined refund amount

Example:

21.5

payments.refundAmountInCurrencies

object[]

Show child attributes

payments.refundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

payments.refundAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

payments.refundAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

retail

object

Optionally used as reference, for orders created from Point-of-Sale systems

Show child attributes

retail.cashierId

string

Merchant-defined cashier ID during order creation

Example:

"C-123"

retail.locationNumber

string

Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.

Example:

"WH334"

retail.registerId

string

Merchant-defined register ID during order creation

Example:

"113"

retail.transactionId

string

Transaction ID such as the Point-of-Sale system's version of the orderId.

Example:

"328942333412"

returnTotal

number<double>

Return total of order, for return scenarios, calculated as summationOfAll(itemReturnTotal)

Example:

12.34

returnTotalInCurrencies

object[]

Show child attributes

returnTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

returnTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

returnTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

returns

object[]

Show child attributes

returns.attributes

object

Attributes

Show child attributes

returns.attributes.{key}

object

Attributes

Example:

{ "transactionId": "0R12TQ46" }

Example:

{ "transactionId": "0R12TQ46" }

returns.fees

object[]

Show child attributes

returns.fees.amount

number<double>

Merchant-defined return amount

Example:

34.56

returns.fees.amountInCurrencies

object[]

Show child attributes

returns.fees.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

returns.fees.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

returns.fees.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

returns.fees.name

string

Fee name

Example:

"RETURN_FEE"

returns.fees.reason

string

Merchant-defined return reason

Example:

"Return fee"

returns.fees.type

enum<string>

Return fee type

Available options:

TAX,

DISCOUNT,

FEE,

ITEM,

ADJUSTMENT

Example:

"FEE"

returns.invoicedAmount

number<double>

System-generated invoiced amount for the return request

Example:

11.29

returns.invoicedAmountInCurrencies

object[]

Show child attributes

returns.invoicedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

returns.invoicedAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

returns.invoicedAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

returns.paymentCounterRefundDetails

object[]

Show child attributes

returns.paymentCounterRefundDetails.amount

number<double>

Final refunded amount

Example:

34.56

returns.paymentCounterRefundDetails.amountInCurrencies

object[]

Show child attributes

returns.paymentCounterRefundDetails.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

returns.paymentCounterRefundDetails.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

returns.paymentCounterRefundDetails.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

returns.paymentCounterRefundDetails.paymentCounter

integer<int32>

Unique incremented number for this payment object.

Example:

1

returns.refunds

object[]

Show child attributes

returns.refunds.amount

number<double>

Merchant-defined return amount

Example:

34.56

returns.refunds.amountInCurrencies

object[]

Show child attributes

returns.refunds.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

returns.refunds.amountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

returns.refunds.amountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

returns.refunds.name

string

Fee name

Example:

"RETURN_FEE"

returns.refunds.reason

string

Merchant-defined return reason

Example:

"Return fee"

returns.refunds.type

enum<string>

Return fee type

Available options:

TAX,

DISCOUNT,

FEE,

ITEM,

ADJUSTMENT

Example:

"FEE"

returns.returnCounter

integer<int32>

Unique, sequential or incremental counter for return request

Example:

1

returns.totalRefundAmount

number<double>

Merchant-defined total refund amount for the return request

Example:

11.29

returns.totalRefundAmountInCurrencies

object[]

Show child attributes

returns.totalRefundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

returns.totalRefundAmountInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

returns.totalRefundAmountInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

statusDescription

string

Human-readable brief description based on statusCode

Example:

"Order Created"

subtype

enum<string>

Order subtype, for further classification

Available options:

IOS,

ANDROID,

INTERNATIONAL

Example:

"INTERNATIONAL"

taxTotal

number<double>

Recalculated total tax on order summationOfAll(itemTaxTotal)+summationOf(tax[].value)

Example:

12.34

taxTotalInCurrencies

object[]

Show child attributes

taxTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

taxTotalInCurrencies.group

string

required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

taxTotalInCurrencies.amount

number<double>

The amount displayed in the primary currency.

Example:

123.45

type

enum<string>

Order type is critical for the order life cycle as it indicates the workflow. 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.

Available options:

WEB,

CSC,

MOBILE_APP,

POS

Example:

"WEB"

updatedAt

string<date-time>

Time of last update to order (UTC)

Example:

"2022-05-12T09:30:31.198Z"

Orders & Inventory

Order User Guides

Inventory User Guides

Orders API Endpoints

Inventory API Endpoints

Update Order Attributes

Authorizations

Headers

Path Parameters

Body

Response