Get invoice by ID

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

invoiceId

string

required

System-generated invoice ID

Response

The invoice response model.

channelId

string

required

This is the sales channel ID.

Example:

"10"

currency

string

required

This is the ISO 4217 currency code for invoiced amounts.

Example:

"USD"

invoiceId

string

required

This is the system-generated unique invoice ID.

Example:

"62ff5c0bec0aed3c86202c32"

invoiceTotal

number<double>

required

This is the total invoiced amount captured for the order.

Example:

245.7

shipmentId

string

required

This is the 24-character system-generated shipment ID. The invoice is created against this shipment.

Example:

"62ff5c0bec0aed3c86202c32"

statusCode

enum<string>

required

This field indicates the current invoice processing status. CREATED — The invoice was generated by fabric. POSTED — The Invoice service sent a notification to the webhook service. ACKNOWLEDGED — The merchant acknowledged the invoice successfully.

Available options:

CREATED,

POSTED,

ACKNOWLEDGED

Example:

"CREATED"

totalTaxAmount

number<double>

required

This is the total tax amount included in the invoice.

Example:

19.57

version

integer<int64>

required

This field indicates the current version of the invoice document. The number increases each time the invoice is updated.

Example:

2

acknowledgedAt

string<date-time>

This is the timestamp of when the merchant acknowledged the invoice in UTC.

Example:

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

auditLogs

object[]

This array contains audit logs that track invoice lifecycle events.

Show child attributes

auditLogs.amount

number<double>

Amount for which audit's done

Example:

2.4

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

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"

createdAt

string<date-time>

This is the timestamp of when the invoice was created in UTC.

Example:

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

customer

object

This object contains customer details.

Show child attributes

customer.accountId

string

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

Example:

"62272e917b12209e68751d94"

customer.address

object

Address details

Show child attributes

customer.address.addressLine1

string

required

Address line 1

Example:

"123 Main St."

customer.address.city

string

required

City name

Example:

"Seattle"

customer.address.countryCode

string

required

ISO 3166-1 alpha-2 based country code

Example:

"US"

customer.address.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

customer.address.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

customer.address.postalCode

string

required

Postal or ZIP code

Example:

"98121"

customer.address.region

string

required

Region or state

Example:

"WA"

customer.address.type

string

required

Address type

Example:

"Home"

customer.address.addressLine2

string

Address line 2

Example:

"Suite 100"

customer.address.addressLine3

string

Address line 3

Example:

"Seventh floor"

customer.address.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

customer.address.email

string

Contact person's email

Example:

"[email protected]"

customer.address.name

object

Contact person's name

Show child attributes

customer.address.name.firstName

string

Contact person's first name

Example:

"Alex"

customer.address.name.lastName

string

Contact person's last name

Example:

"Doe"

customer.address.name.middleName

string

Contact person's middle name or initial

Example:

"E"

customer.address.phone

object

Contact person's phone details

Show child attributes

customer.address.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

customer.address.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

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"

invoiceExternalId

string

This is an optional identifier assigned to the invoice by the merchant.

Example:

"191763090"

invoiceNumber

string

This is a merchant-defined unique invoice number. If omitted, fabric generates one using the Configuration service’s sequence generator.

Example:

"23940791"

invoiceStatus

enum<string>

This field shows the system-generated invoice status. CAPTURED — The authorizedAmount was successfully captured. SETTLED — The authorizedAmount was successfully settled with the customer. This may mean the amount was fully paid or refunded in case of returns. SETTLE_FAILED — The settlement of the authorizedAmount failed. PARTIAL_SETTLED — Only part of the authorizedAmount was settled.

Available options:

CAPTURED,

SETTLED,

SETTLE_FAILED,

PARTIAL_SETTLED

Example:

"CAPTURED"

invoiceTotalInCurrencies

object[]

The total invoiced amount represented in one or more currencies.
Each entry specifies the total value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

invoiceTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

invoiceTotalInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

invoiceTotalInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

invoiceType

enum<string>

This field specifies the system-updated invoice type. RETURN — Created for order returns. SHIPPING — Created when items are shipped. APPEASEMENT — Created for customer appeasements. ORDER_DONATION — Created when an order is donated. ORDER_CARRY — Created for Cash & Carry orders. EXCHANGE — Created for order exchanges.

Available options:

RETURN,

SHIPPING,

APPEASEMENT,

ORDER_DONATION,

ORDER_CARRY,

EXCHANGE

Example:

"SHIPPING"

invoicedAt

string<date-time>

This is the system-generated timestamp of when the invoice was created in UTC.

Example:

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

location

object

This object contains location details.

Show child attributes

location.address

object

Address with contact details

Show child attributes

location.address.addressLine1

string

required

Address line 1

Example:

"123 Main St."

location.address.city

string

required

City name

Example:

"Seattle"

location.address.countryCode

string

required

ISO 3166-1 alpha-2 based country code

Example:

"US"

location.address.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

location.address.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

location.address.postalCode

string

required

Postal or ZIP code

Example:

"98121"

location.address.region

string

required

Region or state

Example:

"WA"

location.address.type

string

required

Address type

Example:

"Home"

location.address.addressLine2

string

Address line 2

Example:

"Suite 100"

location.address.addressLine3

string

Address line 3

Example:

"Seventh floor"

location.address.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

location.address.contacts

object[]

Contacts

Show child attributes

location.address.contacts.email

string

Contact person's email

Example:

"[email protected]"

location.address.contacts.name

object

Contact person's name

Show child attributes

location.address.contacts.name.firstName

string

Contact person's first name

Example:

"Alex"

location.address.contacts.name.lastName

string

Contact person's last name

Example:

"Doe"

location.address.contacts.name.middleName

string

Contact person's middle name or initial

Example:

"E"

location.address.contacts.phone

object

Contact person's phone details

Show child attributes

location.address.contacts.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

location.address.contacts.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

location.address.email

string

Contact person's email

Example:

"[email protected]"

location.address.name

object

Contact person's name

Show child attributes

location.address.name.firstName

string

Contact person's first name

Example:

"Alex"

location.address.name.lastName

string

Contact person's last name

Example:

"Doe"

location.address.name.middleName

string

Contact person's middle name or initial

Example:

"E"

location.address.phone

object

Contact person's phone details

Show child attributes

location.address.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

location.address.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

location.locationNumber

string

If invoiceType= SHIPPING, location number refers to the inventory location from where the order is fulfilled.

Example:

"WH334"

locationNumber

string

This is the unique identifier of the ship-from location. The value must match the locationNumber stored in the fabric Location service.

Example:

"WH334"

orders

object[]

This array contains the invoice order details.

Show child attributes

orders.invoiceOrderTotal

number<double>

required

Total amount charged for the order

Example:

245.7

orders.orderId

string

required

24-character system-generated unique order ID (UUID) for which invoice is created

Example:

"62ff5c0bec0aed3c86202c32"

orders.adjustments

object[]

Show child attributes

orders.adjustments.adjustmentCounter

integer<int32>

Represents number of times adjustment has happened to the order

Example:

1

orders.adjustments.amount

number<double>

Amount

Example:

34.56

orders.adjustments.amountInCurrencies

object[]

The amount represented in one or more currencies.
Each item includes the value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.adjustments.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.adjustments.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.adjustments.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.adjustments.attributes

object

Custom attributes specific to tenant

Show child attributes

orders.adjustments.attributes.{key}

object

Custom attributes specific to tenant

orders.adjustments.notes

string

An optional free text field and is saved as a metadata

Example:

"Any additional info"

orders.adjustments.quantity

integer<int32>

Adjustment quantity

Example:

1

orders.adjustments.reasonCode

string

Merchant-defined reason code for order adjustment, varies from merchant to merchant

Example:

"Incorrect Item"

orders.adjustments.subReasonCode

string

Merchant-defined sub reason code

Example:

"Late shipping"

orders.adjustments.value

number<double>

Amount

Example:

34.56

orders.appeasements

object[]

Invoice appeasement details

Show child attributes

orders.appeasements.amount

number<double>

Merchant-defined appeasement amount, which shouldn't exceed (charged amount - already refunded amount)

Example:

34.56

orders.appeasements.amountInCurrencies

object[]

The merchant-defined appeasement amount represented in one or more currencies.
Each entry specifies the appeasement value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.appeasements.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.appeasements.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.appeasements.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.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's automatically generated and won't 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

orders.appeasements.invoicedAmount

number<double>

System-generated amount from Invoice service based on requested amount

Example:

34.56

orders.appeasements.invoicedAmountInCurrencies

object[]

The system-generated invoiced amount represented in one or more currencies.
Each entry includes the invoiced value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.appeasements.invoicedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.appeasements.invoicedAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.appeasements.invoicedAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.appeasements.payments

object[]

Show child attributes

orders.appeasements.payments.paymentCounter

integer<int32>

Payment counter to identify which payment to refund

Example:

1

orders.appeasements.payments.refundAmount

number<double>

Refund amount for appeasement

Example:

34.56

orders.appeasements.payments.refundAmountInCurrencies

object[]

The refund amount represented in one or more currencies.
Each entry specifies the refunded value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.appeasements.payments.refundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.appeasements.payments.refundAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.appeasements.payments.refundAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.appeasements.reasonCode

string

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

Example:

"Incorrect Item"

orders.appeasements.subReasonCode

string

Sub-reason code for appeasement, for another layer of classification

Example:

"Late shipping"

orders.discounts

object[]

Invoicing discount list

Show child attributes

orders.discounts.promotionId

string

required

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"

orders.discounts.amount

number<double>

Discounted amount for the given quantity

Example:

2

orders.discounts.amountInCurrencies

object[]

The discounted amount represented in one or more currencies.
Each entry specifies the value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.
This enables multi-currency support for the given quantity.

Show child attributes

orders.discounts.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.discounts.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.discounts.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.discounts.promotionCode

string

Promotion code used by shoppers to take advantage of an ongoing promotion and avail discounts

Example:

"HNY2022"

orders.discounts.promotionName

string

Promotion title or name

Example:

"Happy New Year"

orders.discounts.quantity

integer<int32>

Number of discounted items in an order; example- buy 2 get 2 free

Example:

2

orders.discounts.type

string

Promotion type

Example:

"promotion"

orders.fees

object[]

Invoice fee details

Show child attributes

orders.fees.amount

number<double>

Amount charged for an item in the invoice

Example:

34.56

orders.fees.amountInCurrencies

object[]

The amount charged for the item, represented in one or more currencies.
Each entry specifies the value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.fees.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.fees.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.fees.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.fees.quantity

integer<int32>

Quantity of items to which amount is charged

Example:

1

orders.fees.refundAmount

number<double>

Refund amount for the invoice

Example:

345.56

orders.fees.refundAmountInCurrencies

object[]

The refund amount represented in one or more currencies.
Each entry includes the refunded value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.fees.refundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.fees.refundAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.fees.refundAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.fees.type

string

Item fee type

Example:

"tax"

orders.items

object[]

Invoicing item list

Show child attributes

orders.items.invoiceLineNumber

integer<int32>

required

System-specified sequential number iterated for each item in the array of the invoice

Example:

3

orders.items.adjustmentTotal

number<double>

Total price adjustment amount for all items of the order

Example:

123.45

orders.items.adjustmentTotalInCurrencies

object[]

The total price adjustment amount for the order represented in one or more currencies.
Each entry includes the adjustment value and its currency code,
using the amountInCurrencyResource schema.

Show child attributes

orders.items.adjustmentTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.adjustmentTotalInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.adjustmentTotalInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.adjustments

object[]

Invoice adjustment details for this item

Show child attributes

orders.items.adjustments.adjustmentCounter

integer<int32>

Represents number of times adjustment has happened to the order

Example:

1

orders.items.adjustments.amount

number<double>

Amount

Example:

34.56

orders.items.adjustments.amountInCurrencies

object[]

The amount represented in one or more currencies.
Each item includes the value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.items.adjustments.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.adjustments.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.adjustments.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.adjustments.attributes

object

Custom attributes specific to tenant

Show child attributes

orders.items.adjustments.attributes.{key}

object

Custom attributes specific to tenant

orders.items.adjustments.notes

string

An optional free text field and is saved as a metadata

Example:

"Any additional info"

orders.items.adjustments.quantity

integer<int32>

Adjustment quantity

Example:

1

orders.items.adjustments.reasonCode

string

Merchant-defined reason code for order adjustment, varies from merchant to merchant

Example:

"Incorrect Item"

orders.items.adjustments.subReasonCode

string

Merchant-defined sub reason code

Example:

"Late shipping"

orders.items.adjustments.value

number<double>

Amount

Example:

34.56

orders.items.appeasements

object[]

Appeasements information, if invoiceType= APPEASEMENT

Show child attributes

orders.items.appeasements.amount

number<double>

Merchant-defined appeasement amount, which shouldn't exceed (charged amount - already refunded amount)

Example:

34.56

orders.items.appeasements.amountInCurrencies

object[]

Show child attributes

orders.items.appeasements.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.appeasements.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.appeasements.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.appeasements.appeasementCounter

integer<int32>

Example:

1

orders.items.appeasements.invoicedAmount

number<double>

System-generated amount from Invoice service based on requested amount

Example:

34.56

orders.items.appeasements.invoicedAmountInCurrencies

object[]

Show child attributes

orders.items.appeasements.invoicedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.appeasements.invoicedAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.appeasements.invoicedAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.appeasements.payments

object[]

Show child attributes

orders.items.appeasements.payments.paymentCounter

integer<int32>

Payment counter to identify which payment to refund

Example:

1

orders.items.appeasements.payments.refundAmount

number<double>

Refund amount for appeasement

Example:

34.56

orders.items.appeasements.payments.refundAmountInCurrencies

object[]

Show child attributes

orders.items.appeasements.payments.refundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.appeasements.payments.refundAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.appeasements.payments.refundAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.appeasements.reasonCode

string

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

Example:

"Incorrect Item"

orders.items.appeasements.subReasonCode

string

Sub-reason code for appeasement, for another layer of classification

Example:

"Late shipping"

orders.items.attributes

object

Customized attributes

Example:

{ "key": "value" }

orders.items.cancellations

object[]

If invoiceType= CANCELLATION, the details of the cancelled items will be included in the invoice.

Show child attributes

orders.items.cancellations.cancellationCounter

string

Cancellation Counter

Example:

1

orders.items.cancellations.source

string

Determine where the request is initialized

Example:

"CSR"

orders.items.cancellations.reasonCode

string

Reason code

Example:

"Order Line Cancel"

orders.items.cancellations.subReasonCode

string

Sub reason code

Example:

"Late shipping"

orders.items.cancellations.status

enum<string>

Cancellation Status

Available options:

PROCESSING,

COMPLETED,

REJECTED

Example:

"PROCESSING"

orders.items.cancellations.amount

number<double>

Amount

Example:

"-20."

orders.items.cancellations.amountInCurrencies

object[]

Show child attributes

orders.items.cancellations.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.cancellations.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.cancellations.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.cancellations.invoicedAmount

number<double>

Invoiced Amount

Example:

"-20."

orders.items.cancellations.invoicedAmountInCurrencies

object[]

Show child attributes

orders.items.cancellations.invoicedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.cancellations.invoicedAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.cancellations.invoicedAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.cancellations.payments

object[]

Show child attributes

orders.items.cancellations.payments.paymentCounter

string

Cancellation Counter

Example:

1

orders.items.cancellations.payments.amount

number<double>

Amount

Example:

"-20."

orders.items.cancellations.payments.amountInCurrencies

object[]

CurrencyList details

Show child attributes

orders.items.cancellations.payments.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.cancellations.payments.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.cancellations.payments.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.cancellations.refunds

object[]

Show child attributes

orders.items.cancellations.refunds.type

string

Type of refund

Example:

"ITEM"

orders.items.cancellations.refunds.name

string

Name

Example:

"Name"

orders.items.cancellations.refunds.amount

number<double>

Refund Amount

Example:

"-10."

orders.items.cancellations.refunds.amountInCurrencies

object[]

Show child attributes

orders.items.cancellations.refunds.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.cancellations.refunds.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.cancellations.refunds.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.cancellations.attributes

object

Custom attributes

Example:

{
  "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
}

orders.items.cancellations.quantity

integer<int32>

Total quantity cancelled

Example:

10

orders.items.currency

string

Invoiced amount currency

Example:

"USD"

orders.items.discounts

object[]

Discount applicable for Item

Show child attributes

orders.items.discounts.promotionId

string

required

Example:

"HNY2022"

orders.items.discounts.amount

number<double>

Discounted amount for the given quantity

Example:

2

orders.items.discounts.amountInCurrencies

object[]

Show child attributes

orders.items.discounts.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.discounts.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.discounts.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.discounts.promotionCode

string

Promotion code used by shoppers to take advantage of an ongoing promotion and avail discounts

Example:

"HNY2022"

orders.items.discounts.promotionName

string

Promotion title or name

Example:

"Happy New Year"

orders.items.discounts.quantity

integer<int32>

Number of discounted items in an order; example- buy 2 get 2 free

Example:

2

orders.items.discounts.type

string

Promotion type

Example:

"promotion"

orders.items.fees

object[]

Fees charged for individual items of an invoice

Show child attributes

orders.items.fees.amount

number<double>

Amount charged for an item in the invoice

Example:

34.56

orders.items.fees.amountInCurrencies

object[]

Show child attributes

orders.items.fees.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.fees.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.fees.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.fees.quantity

integer<int32>

Quantity of items to which amount is charged

Example:

1

orders.items.fees.refundAmount

number<double>

Refund amount for the invoice

Example:

345.56

orders.items.fees.refundAmountInCurrencies

object[]

Show child attributes

orders.items.fees.refundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.fees.refundAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.fees.refundAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.fees.type

string

Item fee type

Example:

"tax"

orders.items.invoiceLineTotal

number<double>

Total invoiced amount per line item

Example:

600

orders.items.invoiceLineTotalInCurrencies

object[]

The total invoiced amount per line item represented in one or more currencies.
Each entry includes the value and its corresponding currency code,
using the amountInCurrencyResource schema.

Show child attributes

orders.items.invoiceLineTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.invoiceLineTotalInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.invoiceLineTotalInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.invoiceQuantity

integer<int32>

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

Example:

10

orders.items.itemAppeasementTotal

number<double>

Total invoiced appeasement amount per line item

Example:

344.455

orders.items.itemAppeasementTotalInCurrencies

object[]

The total appeasement amount for the line item represented in one or more currencies.
Each entry includes the appeasement value and its currency code,
using the amountInCurrencyResource schema.

Show child attributes

orders.items.itemAppeasementTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.itemAppeasementTotalInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.itemAppeasementTotalInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.itemCancelTotal

number<double>

Total invoiced cancellation amount per line item

Example:

344.455

orders.items.itemCancelTotalInCurrencies

object[]

The total cancellation amount for the line item represented in one or more currencies.
Each entry includes the cancellation value and its currency code,
using the amountInCurrencyResource schema.

Show child attributes

orders.items.itemCancelTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.itemCancelTotalInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.itemCancelTotalInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.itemDiscountsTotal

number<double>

Total invoiced discount amount per line item

Example:

3.45

orders.items.itemDiscountsTotalInCurrencies

object[]

The total discount amount for the line item represented in one or more currencies.
Each entry includes the discounted value and its currency code,
using the amountInCurrencyResource schema.

Show child attributes

orders.items.itemDiscountsTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.itemDiscountsTotalInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.itemDiscountsTotalInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.itemFeeTotal

number<double>

Total invoiced fee per line item. For fee, refer to amount in invoiceFeeDetail.

Example:

33.4

orders.items.itemFeeTotalInCurrencies

object[]

The total fee for the line item represented in one or more currencies.
Each entry includes the fee value and its currency code,
using the amountInCurrencyResource schema.

Show child attributes

orders.items.itemFeeTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.itemFeeTotalInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.itemFeeTotalInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.itemId

integer<int32>

Unique identifier of item from fabric Products (previously called PIM) service

Example:

1234455322

orders.items.itemTaxTotal

number<double>

Total invoiced tax amount per line item

Example:

2.4

orders.items.itemTaxTotalInCurrencies

object[]

The total tax amount for the line item represented in one or more currencies.
Each entry includes the tax value and its currency code,
using the amountInCurrencyResource schema.

Show child attributes

orders.items.itemTaxTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.itemTaxTotalInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.itemTaxTotalInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.itemUnitPrice

number<double>

Item's unit price

Example:

33.4

orders.items.itemUnitPriceInCurrencies

object[]

The item’s unit price represented in one or more currencies.
Each entry specifies the value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.items.itemUnitPriceInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.itemUnitPriceInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.itemUnitPriceInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.lineItemCreatedAt

string<date-time>

Time order line item was created

Example:

"2022-11-22T10:26:38.000+00:00"

orders.items.lineItemId

string

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

Example:

"1adfrghhh2346aaaf"

orders.items.lineItemNumber

integer<int32>

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

Example:

1

orders.items.locationStoreId

string

ID of the store from where the item is picked for shipment

Example:

4512345

orders.items.orderId

string

24-character system-generated unique order ID (UUID) to which the item belongs

Example:

"33adfrghhh2346aaaffff"

orders.items.returnExpirationDays

string

Return expiration in days

Example:

21

orders.items.returns

object[]

If invoiceType= RETURN, the details of the returned items will be included in the invoice.

Show child attributes

orders.items.returns.exchangeLineItemId

string

Exchange line item ID

Example:

"62f3dfc438bcab1951be0a19"

orders.items.returns.fees

object[]

Show child attributes

orders.items.returns.fees.amount

number<double>

Merchant-defined return amount

Example:

34.56

orders.items.returns.fees.amountInCurrencies

object[]

The merchant-defined refund amount represented in one or more currencies.
Each entry specifies the appeasement value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.items.returns.fees.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.returns.fees.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.returns.fees.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.returns.fees.name

string

Fee name

Example:

"RETURN_FEE"

orders.items.returns.fees.reason

string

Merchant-defined return reason

Example:

"Return fee"

orders.items.returns.fees.type

enum<string>

Return fee type

Available options:

TAX,

DISCOUNT,

FEE,

ITEM,

ADJUSTMENT

Example:

"FEE"

orders.items.returns.invoicedAmount

number<double>

System-generated amount from Invoice service based on requested amount

Example:

11.29

orders.items.returns.invoicedAmountInCurrencies

object[]

Show child attributes

orders.items.returns.invoicedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.returns.invoicedAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.returns.invoicedAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.returns.isExchangeItemReturned

boolean

default:false

true: Item received for exchange is returned false: Item received for exchange isn't returned

Example:

true

orders.items.returns.reasonCode

string

Merchant-defined reason code for return

Example:

"Incorrect item"

orders.items.returns.refundAmount

number<double>

Refund amount

Example:

11.29

orders.items.returns.refundAmountInCurrencies

object[]

Show child attributes

orders.items.returns.refundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.returns.refundAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.returns.refundAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.returns.refunds

object[]

Show child attributes

orders.items.returns.refunds.amount

number<double>

Merchant-defined return amount

Example:

34.56

orders.items.returns.refunds.amountInCurrencies

object[]

Show child attributes

orders.items.returns.refunds.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.returns.refunds.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.returns.refunds.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.returns.refunds.name

string

Fee name

Example:

"RETURN_FEE"

orders.items.returns.refunds.reason

string

Merchant-defined return reason

Example:

"Return fee"

orders.items.returns.refunds.type

enum<string>

Return fee type

Available options:

TAX,

DISCOUNT,

FEE,

ITEM,

ADJUSTMENT

Example:

"FEE"

orders.items.returns.returnRequestCounter

integer<int32>

Unique, sequential, or incremental counter for return request

Example:

1

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

orders.items.returns.shipmentId

string

24-character system-generated shipment ID

Example:

"62b37697c67b204dd18a7465"

orders.items.returns.shipmentInvoice

object

The shipment invoice resource object.

Show child attributes

orders.items.returns.shipmentInvoice.invoiceId

string

required

The unique ID of the shipment invoice.

Example:

"62ff5c0bec0aed3c86202c32"

orders.items.returns.shipmentInvoice.invoiceNumber

string

The unique number of the shipment invoice.

Example:

"23940791"

orders.items.returns.shipmentInvoice.invoicedAt

string<date-time>

The date when the invoice was processed.

Example:

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

orders.items.returns.shipmentLineItemId

string

Unique identifier for each item in the shipment

Example:

"234"

orders.items.returns.shipmentQuantity

integer<int32>

default:0

Shipped quantity of given item

Example:

1

orders.items.shipToId

string

If invoiceType= SHIPPING, the Ship-to ID corresponds to the shipment for which the invoice was generated.

Example:

"5349b4ddd2781d08c09890f4"

orders.items.shipmentLineItemId

string

Unique identifier for shipment of the line item. This attribute is inherited from fabric shipment service.

Example:

"2adfrghhh2346aaaffff"

orders.items.sku

string

Stock Keeping Unit (SKU), unique identifier of item

Example:

"P1234"

orders.items.taxDetails

object[]

Item tax details

Show child attributes

orders.items.taxDetails.amount

number<double>

Amount for type

Example:

34.56

orders.items.taxDetails.amountInCurrencies

object[]

Show child attributes

orders.items.taxDetails.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.items.taxDetails.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.items.taxDetails.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.items.taxDetails.type

string

Item fee type

Example:

"tax"

orders.items.type

string

Order item type

Example:

"WEB_PICKUP"

orders.items.uom

string

Item's unit of measurement. For example, for each quantity (EA), or GAL (Gallon), DZ (Dozens), etc.

Example:

"EA"

orders.orderNumber

string

Merchant-specified order number for which invoice is created. Note: Order number can either be merchant-defined during Order creation request or it can be generated by fabric’s sequence generator feature in the Configuration service.

Example:

"217088603"

orders.orderExternalId

string

An optional identifier assigned to the order by the merchant.

Example:

217088603

orders.orderSubtype

enum<string>

Order subtype for further order classification

Available options:

IOS,

ANDROID,

INTERNATIONAL

Example:

"INTERNATIONAL"

orders.orderType

enum<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 a Call Center order. fabric Orders service offers default configurations for Storefront, Call Center, Point of Sale, iOS, Android, and International

Available options:

WEB,

CSC,

MOBILE_APP,

POS

Example:

"WEB"

orders.orderedAt

string<date-time>

System-generated order creation time

Example:

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

orders.payments

object[]

Invoicing payment list

Show child attributes

orders.payments.attributes

object

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

Show child attributes

orders.payments.attributes.{key}

object

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

orders.payments.authorizedAmount

number<double>

Amount authorized to be debited from the given paymentMethod

Example:

256.1

orders.payments.authorizedAmountInCurrencies

object[]

The authorized amount represented in one or more currencies.
Each entry specifies the authorized value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.payments.authorizedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.payments.authorizedAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.payments.authorizedAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.payments.billToAddress

object

Address details

Show child attributes

orders.payments.billToAddress.addressLine1

string

required

Address line 1

Example:

"123 Main St."

orders.payments.billToAddress.city

string

required

City name

Example:

"Seattle"

orders.payments.billToAddress.countryCode

string

required

ISO 3166-1 alpha-2 based country code

Example:

"US"

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

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

orders.payments.billToAddress.postalCode

string

required

Postal or ZIP code

Example:

"98121"

orders.payments.billToAddress.region

string

required

Region or state

Example:

"WA"

orders.payments.billToAddress.type

string

required

Address type

Example:

"Home"

orders.payments.billToAddress.addressLine2

string

Address line 2

Example:

"Suite 100"

orders.payments.billToAddress.addressLine3

string

Address line 3

Example:

"Seventh floor"

orders.payments.billToAddress.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

orders.payments.billToAddress.email

string

Contact person's email

Example:

"[email protected]"

orders.payments.billToAddress.name

object

Contact person's name

Show child attributes

orders.payments.billToAddress.name.firstName

string

Contact person's first name

Example:

"Alex"

orders.payments.billToAddress.name.lastName

string

Contact person's last name

Example:

"Doe"

orders.payments.billToAddress.name.middleName

string

Contact person's middle name or initial

Example:

"E"

orders.payments.billToAddress.phone

object

Contact person's phone details

Show child attributes

orders.payments.billToAddress.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

orders.payments.billToAddress.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

orders.payments.conversion

number<double>

Conversion required for currency

Example:

1

orders.payments.currency

string

Three-letter currency code as defined by ISO-4217

Example:

"USD"

orders.payments.paidAt

string

System-generated time (UTC) when payment was captured. In case of payment captured at checkout, this is a merchant-defined value given during order creation (UTC).

Example:

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

orders.payments.paymentCounter

integer<int32>

Unique incremented number for this payment object

Example:

1

orders.payments.paymentIdentifier

object

Invoice payment identifier

Show child attributes

orders.payments.paymentIdentifier.cardIdentifier

string

Card number

Example:

"***********3456"

orders.payments.paymentMethod

string

Payment method such as PayPal or Credit Card

Example:

"CREDIT_CARD"

orders.payments.paymentProvider

string

Name of the payment provider

Example:

"stripe"

orders.payments.paymentStatus

string

Payment status. There are no predefined values; possible values are Paid, Partially Paid, Authorized, and Error.

Example:

"PAID"

orders.payments.paymentToken

object

Invoice payment token

Show child attributes

orders.payments.paymentToken.token

string

Payment token number

Example:

"pi_34tr6787rt"

orders.payments.paymentType

string

Payment type such as VISA or Mastercard

Example:

"VISA"

orders.payments.settlement

object

Invoice settlement details

Show child attributes

orders.payments.settlement.settledAt

string<date-time>

System-generated invoice settlement time

Example:

"2022-01-27T21:15:58Z"

orders.payments.settlement.settlementAmount

number<double>

Amount that needs to be collected from or refunded to the shopper. It's invoicedAmount - chargedAmount.

Example:

10.3

orders.payments.settlement.settlementAmountInCurrencies

object[]

The settlement amount represented in one or more currencies.
Each entry specifies the settlement value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.payments.settlement.settlementAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.payments.settlement.settlementAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.payments.settlement.settlementAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.payments.settlement.settlementStatusCode

enum<string>

Invoice settlement status code SETTLED: Amount is captured successfully from the payment service PARTIAL_SETTLED: Amount is partially captured from the payment service SETTLEMENT_FAILED: Amount isn't captured from the payment service

Available options:

SETTLED,

PARTIAL_SETTLED,

SETTLEMENT_FAILED

Example:

"SETTLED"

orders.returns

object[]

Show child attributes

orders.returns.attributes

object

Attributes

Show child attributes

orders.returns.attributes.{key}

object

Attributes

Example:

{ "transactionId": "0R12TQ46" }

Example:

{ "transactionId": "0R12TQ46" }

orders.returns.fees

object[]

Fee details for the return request

Show child attributes

orders.returns.fees.amount

number<double>

Merchant-defined return amount

Example:

34.56

orders.returns.fees.amountInCurrencies

object[]

Show child attributes

orders.returns.fees.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.returns.fees.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.returns.fees.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.returns.fees.name

string

Fee name

Example:

"RETURN_FEE"

orders.returns.fees.reason

string

Merchant-defined return reason

Example:

"Return fee"

orders.returns.fees.type

enum<string>

Return fee type

Available options:

TAX,

DISCOUNT,

FEE,

ITEM,

ADJUSTMENT

Example:

"FEE"

orders.returns.invoicedAmount

number<double>

System-generated invoiced amount for the return request

Example:

11.29

orders.returns.invoicedAmountInCurrencies

object[]

Show child attributes

orders.returns.invoicedAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.returns.invoicedAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.returns.invoicedAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.returns.paymentCounterRefundDetails

object[]

Refund details associated with payment counters for the return request

Show child attributes

orders.returns.paymentCounterRefundDetails.amount

number<double>

Final refunded amount

Example:

34.56

orders.returns.paymentCounterRefundDetails.amountInCurrencies

object[]

CurrencyList details

Show child attributes

orders.returns.paymentCounterRefundDetails.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.returns.paymentCounterRefundDetails.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.returns.paymentCounterRefundDetails.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.returns.paymentCounterRefundDetails.paymentCounter

integer<int32>

Unique incremented number for this payment object

Example:

1

orders.returns.refunds

object[]

Refund details for the return request

Show child attributes

orders.returns.refunds.amount

number<double>

Merchant-defined return amount

Example:

34.56

orders.returns.refunds.amountInCurrencies

object[]

Show child attributes

orders.returns.refunds.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.returns.refunds.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.returns.refunds.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.returns.refunds.name

string

Fee name

Example:

"RETURN_FEE"

orders.returns.refunds.reason

string

Merchant-defined return reason

Example:

"Return fee"

orders.returns.refunds.type

enum<string>

Return fee type

Available options:

TAX,

DISCOUNT,

FEE,

ITEM,

ADJUSTMENT

Example:

"FEE"

orders.returns.returnCounter

integer<int32>

Unique, sequential or incremental counter for return request

Example:

1

orders.returns.totalRefundAmount

number<double>

Merchant-defined total refund amount for the return request

Example:

11.29

orders.returns.totalRefundAmountInCurrencies

object[]

The total refund amount represented in one or more currencies.
Each entry specifies the refunded value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

orders.returns.totalRefundAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.returns.totalRefundAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.returns.totalRefundAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.taxDetails

object[]

Invoicing tax details

Show child attributes

orders.taxDetails.amount

number<double>

Amount for type

Example:

34.56

orders.taxDetails.amountInCurrencies

object[]

Show child attributes

orders.taxDetails.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

orders.taxDetails.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

orders.taxDetails.amountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

orders.taxDetails.type

string

Item fee type

Example:

"tax"

postedAt

string<date-time>

This is the timestamp of when the invoice was sent to a third-party system for financial processing in UTC.

Example:

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

retail

object

This object contains optional retail details.

Show child attributes

retail.cashierId

string

Merchant-specified cashier ID during invoice creation

Example:

"CE-321"

retail.locationNumber

string

Unique value to identify ship-from location. This must be the locationNumber stored in the fabric Location service.

Example:

"WH334"

shipInfo

object

This object contains shipment information.

Show child attributes

shipInfo.shipToId

string

required

System-generated UUID associated with shipInfo, generated from CnC service. An order can have multiple ship-to (delivery) locations and items going to the same location share one shipToId.

Example:

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

shipInfo.attributes

object

User-defined custom attributes (key–value pairs) for additional information.

Example:

{ "giftMessage": "[]" }

shipInfo.discounts

object[]

Shipping discount details

Show child attributes

shipInfo.discounts.amount

number<double>

Discounted amount for the given quantity

Example:

2.99

shipInfo.discounts.amountInCurrencies

object[]

The merchant-defined shipping discount amount represented in one or more currencies.
Each entry specifies the appeasement value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

shipInfo.discounts.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.discounts.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

shipInfo.discounts.amountInCurrencies.amount

number<double>

Amount in 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

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

string

The fulfillment zone name used to determine fulfillment location and network.

Example:

"US_LOCATIONS"

shipInfo.isInvoiced

boolean

default:false

true: At least one captured invoice is created by the Invoice service;
false: A 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[]

The shipping discount amount represented in one or more currencies. Each entry specifies the discount value and its corresponding currency code, following the structure defined in the amountInCurrencyResource schema.

Show child attributes

shipInfo.shipToDiscountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.shipToDiscountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

shipInfo.shipToDiscountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

shipInfo.shipToPrice

number<double>

Net shipping cost, including discounts

Example:

20

shipInfo.shipToPriceInCurrencies

object[]

The net shipping cost (inclusive of discounts) represented in one or more currencies. Each entry specifies the value and its corresponding currency code, following the structure defined in the amountInCurrencyResource schema.

Show child attributes

shipInfo.shipToPriceInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.shipToPriceInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

shipInfo.shipToPriceInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

shipInfo.shipToTaxTotal

number<double>

Total shipping tax

Example:

12.6

shipInfo.shipToTaxTotalInCurrencies

object[]

The total shipping tax represented in one or more currencies. Each entry specifies the tax value and its corresponding currency code, following the structure defined in the amountInCurrencyResource schema.

Show child attributes

shipInfo.shipToTaxTotalInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.shipToTaxTotalInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

shipInfo.shipToTaxTotalInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

shipInfo.shipToType

string

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

Example:

"SHIP_TO_ADDRESS"

shipInfo.shipToUnitPrice

number<double>

Merchant-defined shipping cost (unit price before discounts)

Example:

20

shipInfo.shipToUnitPriceInCurrencies

object[]

The merchant-defined shipping unit price (before discounts) represented in one or more currencies. Each entry specifies the value and its corresponding currency code, following the structure defined in the amountInCurrencyResource schema.

Show child attributes

shipInfo.shipToUnitPriceInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.shipToUnitPriceInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

shipInfo.shipToUnitPriceInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

shipInfo.shipmentInstructions

string

Shipment instructions

Example:

"Handle with care"

shipInfo.taxCode

string

Applicable tax code; varies by state or region

Example:

"FR01"

shipInfo.taxDetails

object[]

Shipping tax details

Show child attributes

shipInfo.taxDetails.amount

number<double>

Tax amount

Example:

34.56

shipInfo.taxDetails.amountInCurrencies

object[]

The merchant-defined tax amount represented in one or more currencies.
Each entry specifies the appeasement value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

shipInfo.taxDetails.amountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

shipInfo.taxDetails.amountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

shipInfo.taxDetails.amountInCurrencies.amount

number<double>

Amount in 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"

shipmentNumber

string

This is the merchant-specified shipment number. The invoice is created against this shipment.

Example:

"217088603"

shippedAt

string<date-time>

This is the timestamp of when the order was shipped in UTC.

Example:

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

totalTaxAmountInCurrencies

object[]

The total tax amount invoiced represented in one or more currencies.
Each entry includes the tax value and its corresponding currency code,
following the structure defined in the amountInCurrencyResource schema.

Show child attributes

totalTaxAmountInCurrencies.currency

string

required

Currency in ISO-4217

Example:

"USD"

totalTaxAmountInCurrencies.group

string

required

Customer-defined function name which uses this currency.

Example:

"SHOPPER"

totalTaxAmountInCurrencies.amount

number<double>

Amount in currency

Example:

123.45

updatedAt

string<date-time>

This is the timestamp of when the invoice was last updated in UTC.

Example:

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

Orders & Inventory

Order User Guides

Inventory User Guides

Orders API Endpoints

Inventory API Endpoints

Get invoice by ID

Authorizations

Headers

Path Parameters

Response