Get order by order number

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.

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

Appeasement info

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

Backordered quantity of given item

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

Cancelled quantity of an item

Sales channel ID

Three-letter currency code as defined by ISO-4217

Delivered quantity of an item

Discount details

Employee (ID or name) who initiated the request

System-generated item quantity that are exchanged

Fee details

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.

Invoice total is updated once invoice created

Invoiced quantity of an item

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

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

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

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

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

Total price adjustment made to the item.

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

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

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

Item name

Merchant-defined item's shipping total

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

Subtype of type, for another layer of classification

Recalculated total tax on item = summationOfAll(itemTaxTotal)

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

Item's unit price

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

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

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

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

Ordered quantity of given item

Quantity of given item that is yet to ship, out of the initially allocated quantity. For example, if a customer orders four units of an item, inventory will reserve four units of the item. If only two units are currently available and are shipped, the remaining two units will be considered as the pendingShippedQuantity.

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

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

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

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

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

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

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

System-generated item quantity pending for exchange

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.

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.

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

Item quantity for each status

Merchant-defined total refund amount

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

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

Returned quantity of given item

Order return details

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.

Shipped quantity of an item

Stock keeping unit (SKU), unique identifier of item

Applicable tax code, varies from state to state

Tax details

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.

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.

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

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

Estimated delivery time (UTC) provided by carrier

Estimated shipping time (UTC) provided by merchant

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

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

Order pickup details

Shipping method

Address details

Merchant-defined shipping discount amount

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.

Merchant-defined shipping cost

Total shipping tax

Type of shipping address. There are no pre-defined values; the possible values are SDD (Same Day Delivery), Point-of-Sale (POS), etc.

A number indicating the ship to unit price.

Shipment instructions

Applicable tax code, varies from state to state

Sequential or incremental counter for price adjustment

Adjustment amount

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

Cancel quantity

Total quantity invoiced

Placeholder for additional info, if any.

Adjustment quantity

Reason code

Returned quantity of given item

Subreason code

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

Sequential or incremental counter for appeasement. Used for keeping track of duplicates in the request. If omitted in the request, it is automatically generated and will not be used to check duplicates. Multiple appeasement calls for the same order can cause repetition of appeasement counter and may cause the request to be rejected completely.

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

System-generated amount from Invoice service based on requested amount

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

Subreason code for appeasement, for another layer of classification

Amount for which audit is done

Custom attributes

System-generated audit ID (UUID format)

Audit type such as cancel, return, etc.

Audit time (UTC)

Employee (ID or name) who made the last update

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

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

Item identifier

Additional info, if any

Order payment token details

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

Ordered quantity of given item

Merchant-defined reason code, varies from merchant to merchant

Stock keeping unit (SKU), unique item identifier

Merchant-defined source from where the update was initiated. There are no predefined values; possible values could be Customer Service Representative (CSR), Point-of-Sale (POS), etc.

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

Audit log for change history

Discounted amount for the given quantity

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

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

Unique promotion ID either from fabric Offers service or external Offers service. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of create promotion endpoint.

Promotion name

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

Indicates whether the discount is in amount or percentage

Value corresponding to unit

A boolean that signifies if the error has been amended.

The reason the error occurred.

The name of the field where the error occurred.

Tax amount

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

Three-letter currency code as defined by ISO-4217

System-generated amount from Invoice service based on requested amount

Applied tax name

Rate

Rate type

Tax code applied

Time note was created (UTC)

Additional info about the order, if any

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

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

An integer representing the number of payment authorization attempts.

Amount authorized to be debited from the given paymentMethod

Address details

Amount charged to the given paymentMethod

Three-letter currency code as defined by ISO-4217

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

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

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.

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

Details of payment mode and payment identifiers

Payment details

Payment method such as PayPal or credit card

Payment provider

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

Order payment token details

An integer representing the number of payment reauthorization attempts.

Merchant-defined refund amount

System-generated invoiced amount for the return request

Unique, sequential or incremental counter for return request

Merchant-defined total refund amount for the return request