Search for invoices

Search for invoices by matching filter criteria.

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

Query Parameters

fetchOnlyIds

boolean

default:

false

offset

integer

default:

0

Number of records to skip before returning all records. Default is 0 if no value is specified.

Example:

0

limit

integer

default:

10

Maximum number of records returned per page. Default is 10 if no value is specified.

Required range: 1 <= x <= 100

Example:

10

Body

application/json

Sort and filter criteria for invoice search

filters

object[]

required

• Option 1
• Option 2

Criteria to find invoice by a single value. Condition between field and value is anything except IN and NIN when valueSearchFilter is used.

Show child attributes

filters.condition

enum<string>

default:

EQ

required

Filter conditions. EQ (Equal to): Searches for exact match. NEQ (Not equal to): Searches by excluding the specified value. IN: Search for multiple values. NIN (Not IN): Excludes the specified values in the search. LT (Less than): Searches for values that are less than the specified value. GT (Greater than): Search for values that are greater than the specified value. LTE (Less than or equal to): Searches for values that are less than or equal to the specified value. GTE (Greater than or equal to): Searches for values that are greater than or equal to the specified value.

Available options:

EQ,

NEQ,

IN,

NIN,

LT,

GT,

LTE,

GTE

Example:

"EQ"

filters.field

string

required

Field name

Example:

"invoice.invoiceType"

filters.group

string

default:

Default

The group name.

Example:

"GroupA"

filters.value

A single value for field using which data is searched

Example:

"ORDER_CREATE"

sort

string

default:

-invoice.invoicedAt

Property by which data is sorted. Note: - refers to descending and + refers to ascending order

Example:

"+invoice.invoicedAt"

Response

200

application/json

OK

Invoice search response

data

object[]

Invoice response

Show child attributes

data.channelId

string

required

Sales channel ID

Example:

"10"

data.currency

string

required

Currency type in which amount is invoiced

Example:

"USD"

data.invoiceId

string

required

System-generated unique invoice ID

Example:

"62ff5c0bec0aed3c86202c32"

data.invoiceTotal

number

required

Total invoiced amount captured for the order

Example:

245.7

data.shipmentId

string

required

24-character system-generated shipment ID for which invoice is generated

Example:

"62ff5c0bec0aed3c86202c32"

data.statusCode

enum<string>

required

Current invoice status. CREATED: Initially, the status is set as CREATED when invoice is generated automatically by fabric POSTED: When Invoice service sends an event notification to webhook service, status gets updated to POSTED. ACKNOWLEDGED: When retailers successfully acknowledge an invoice, status is changed to ACKNOWLEDGED.

Available options:

CREATED,

POSTED,

ACKNOWLEDGED

Example:

"CREATED"

data.totalTaxAmount

number

required

Total tax amount invoiced

Example:

245.7

data.version

integer

required

The current version of invoice document. The integer indicates the number of times the invoice has been updated by any operation.

Example:

2

data.acknowledgedAt

string

Invoice acknowledgement time by merchant

Example:

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

data.auditLogs

object[]

Audit log

Audit log to capture change history

Show child attributes

data.auditLogs.amount

number

Amount for which audit's done

Example:

2.4

data.auditLogs.auditId

string

System-generated audit ID (UUID format)

Example:

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

data.auditLogs.auditType

string

Audit type such as cancel, return, etc.

Example:

"CANCEL"

data.auditLogs.auditedAt

string

Audit time (UTC)

Example:

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

data.auditLogs.employeeId

string

Employee (ID or name) who made the last update

Example:

"6227"

data.auditLogs.isSuccess

boolean

default:

false

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

Example:

true

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

data.auditLogs.lineItemNumber

integer

Item identifier

Example:

1

data.auditLogs.note

string

Additional info, if any

Example:

"Note"

data.auditLogs.paymentToken

object

Order payment token details

Show child attributes

data.auditLogs.paymentToken.paymentType

string

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

Example:

"VISA"

data.auditLogs.paymentToken.token

string

Payment token provided by payment provider

Example:

"pi_34tr6787rt"

data.auditLogs.policyCode

string

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

Example:

"POS"

data.auditLogs.quantity

integer

Ordered quantity of given item

Example:

1

data.auditLogs.reasonCode

string

Merchant-defined reason code, varies from merchant to merchant

Example:

"Scratched item"

data.auditLogs.sku

string

Stock keeping unit (SKU), unique item identifier

Example:

"SKU0023"

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

data.auditLogs.subReasonCode

string

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

Example:

"Scratched item"

data.auditLogs.updatedFields

object[]

Audit log for change history

Audit log for change history

Show child attributes

data.auditLogs.updatedFields.fieldName

string

Field or property name that was updated

Example:

"UOM"

data.auditLogs.updatedFields.fieldOriginalValue

string

Original value of fieldName before it was updated

Example:

"PK"

data.createdAt

string

Time invoice was created

Example:

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

data.customer

object

Customer details for the generated invoice

Show child attributes

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

data.customer.address

object

Address details

Show child attributes

data.customer.address.addressLine1

string

required

Address line 1

Example:

"123 Main St."

data.customer.address.city

string

required

City name

Example:

"Seattle"

data.customer.address.countryCode

string

required

ISO 3166-1 alpha-2 based country code

Example:

"US"

data.customer.address.latitude

number

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

data.customer.address.longitude

number

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

data.customer.address.postalCode

string

required

Postal or ZIP code

Example:

"98121"

data.customer.address.region

string

required

Region or state

Example:

"WA"

data.customer.address.type

string

required

Address type

Example:

"Home"

data.customer.address.addressLine2

string

Address line 2

Example:

"Suite 100"

data.customer.address.addressLine3

string

Address line 3

Example:

"Seventh floor"

data.customer.address.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

data.customer.address.email

string

Contact person's email

Example:

"[e-mail]"

data.customer.address.name

object

Contact person's name

Show child attributes

data.customer.address.name.firstName

string

Contact person's first name

Example:

"Alex"

data.customer.address.name.lastName

string

Contact person's last name

Example:

"Doe"

data.customer.address.name.middleName

string

Contact person's middle name or initial

Example:

"E"

data.customer.address.phone

object

Contact person's phone details

Show child attributes

data.customer.address.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

data.customer.address.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

data.customer.company

string

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

Example:

"Demo Inc"

data.customer.email

string

Contact person's email

Example:

"[e-mail]"

data.customer.employeeId

string

Employee (ID or name) who initiated an update request

Example:

"62272e917b12209e68751d94"

data.customer.name

object

Contact person's name

Show child attributes

data.customer.name.firstName

string

Contact person's first name

Example:

"Alex"

data.customer.name.lastName

string

Contact person's last name

Example:

"Doe"

data.customer.name.middleName

string

Contact person's middle name or initial

Example:

"E"

data.customer.phone

object

Contact person's phone details

Show child attributes

data.customer.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

data.customer.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

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

data.invoiceNumber

string

Merchant-defined unique invoice number. If omitted, this is generated by fabric’s sequence generator using Configuration service.

Example:

"23940791"

data.invoiceStatus

enum<string>

System-generated invoice status. CAPTURED: authorizedAmount is successfully captured. SETTLED: authorizedAmount is successfully settled with the customer, meaning the authorized amount is fully paid by the shopper or is returned to the shopper in case of return of the item. SETTLED_FAILED: Settlement for the authorizedAmount fails for a reason. PARTIAL_SETTLED: authorizedAmount is partially settled. For example, the shopper might have paid some amount of the total authorized amount.

Available options:

CAPTURED,

SETTLED,

SETTLE_FAILED,

PARTIAL_SETTLED

Example:

"CAPTURED"

data.invoiceType

enum<string>

System-updated invoice type. RETURN: Return invoices are generated in the event of order returns. SHIPPING: Shipping invoices are generated during standard invoice creation when an item is shipped. APPEASEMENT: These invoices are created when customers are provided appeasements to fulfill their needs. ORDER_DONATION: These invoices are created when order isn't purchased by customer, but is donated. ORDER_CARRY: These invoices are generated when it's a Cash N Carry order. EXCHANGE: Exchange invoices are generated in the event of order exchanges.

Available options:

RETURN,

SHIPPING,

APPEASEMENT,

ORDER_DONATION,

ORDER_CARRY,

EXCHANGE

Example:

"SHIPPING"

data.invoicedAt

string

System-generated invoice creation time (UTC)

Example:

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

data.location

object

Contains location details regarding shipment if invoiceType= SHIPPING

Show child attributes

data.location.address

object

Address with contact details

Show child attributes

data.location.address.addressLine1

string

required

Address line 1

Example:

"123 Main St."

data.location.address.city

string

required

City name

Example:

"Seattle"

data.location.address.countryCode

string

required

ISO 3166-1 alpha-2 based country code

Example:

"US"

data.location.address.latitude

number

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

data.location.address.longitude

number

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

data.location.address.postalCode

string

required

Postal or ZIP code

Example:

"98121"

data.location.address.region

string

required

Region or state

Example:

"WA"

data.location.address.type

string

required

Address type

Example:

"Home"

data.location.address.addressLine2

string

Address line 2

Example:

"Suite 100"

data.location.address.addressLine3

string

Address line 3

Example:

"Seventh floor"

data.location.address.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

data.location.address.contacts

object[]

Contacts

Contact person's details

Show child attributes

data.location.address.contacts.email

string

Contact person's email

Example:

"[e-mail]"

data.location.address.contacts.name

object

Contact person's name

Show child attributes

data.location.address.contacts.phone

object

Contact person's phone details

Show child attributes

data.location.address.email

string

Contact person's email

Example:

"[e-mail]"

data.location.address.name

object

Contact person's name

Show child attributes

data.location.address.name.firstName

string

Contact person's first name

Example:

"Alex"

data.location.address.name.lastName

string

Contact person's last name

Example:

"Doe"

data.location.address.name.middleName

string

Contact person's middle name or initial

Example:

"E"

data.location.address.phone

object

Contact person's phone details

Show child attributes

data.location.address.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

data.location.address.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

data.location.locationNumber

string

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

Example:

"3235"

data.locationNumber

string

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

Example:

"3235"

data.orders

object[]

Invoice order details

Invoice order details

Show child attributes

data.orders.invoiceOrderTotal

number

required

Total amount charged for the order

Example:

245.7

data.orders.orderId

string

required

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

Example:

"62ff5c0bec0aed3c86202c32"

data.orders.adjustments

object[]

Invoice adjustment details

Show child attributes

data.orders.adjustments.adjustmentCounter

integer

Represents number of times adjustment has happened to the order

Example:

1

data.orders.adjustments.attributes

object

Custom attributes specific to tenant

Show child attributes

data.orders.adjustments.attributes.{key}

object

Custom attributes specific to tenant

data.orders.adjustments.notes

string

An optional free text field and is saved as a metadata

Example:

"Any additional info"

data.orders.adjustments.quantity

integer

Adjustment quantity

Example:

1

data.orders.adjustments.reasonCode

string

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

Example:

"Incorrect Item"

data.orders.adjustments.subReasonCode

string

Merchant-defined sub reason code

Example:

"Late shipping"

data.orders.adjustments.value

number

Amount

Example:

34.56

data.orders.appeasements

object[]

Invoice appeasement details

Appeasement details

Show child attributes

data.orders.appeasements.amount

number

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

Example:

34.56

data.orders.appeasements.appeasementCounter

integer

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

data.orders.appeasements.invoicedAmount

number

System-generated amount from Invoice service based on requested amount

Example:

34.56

data.orders.appeasements.payments

object[]

Order appeasement payment info

Show child attributes

data.orders.appeasements.payments.paymentCounter

integer

Payment counter to identify which payment to refund

Example:

1

data.orders.appeasements.payments.refundAmount

number

Refund amount for appeasement

Example:

34.56

data.orders.appeasements.reasonCode

string

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

Example:

"Incorrect Item"

data.orders.appeasements.subReasonCode

string

Subreason code for appeasement, for another layer of classification

Example:

"Late shipping"

data.orders.discounts

object[]

Invoicing discount list

Invoice discount details

Show child attributes

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

data.orders.discounts.amount

number

Discounted amount for the given quantity

Example:

2

data.orders.discounts.promotionCode

string

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

Example:

"HNY2022"

data.orders.discounts.promotionName

string

Promotion title or name

Example:

"Happy New Year"

data.orders.discounts.quantity

integer

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

Example:

2

data.orders.discounts.type

string

Promotion type

Example:

"promotion"

data.orders.fees

object[]

Invoice fee details

Invoice fee details

Show child attributes

data.orders.fees.amount

number

Amount charged for an item in the invoice

Example:

34.56

data.orders.fees.quantity

integer

Quantity of items to which amount is charged

Example:

1

data.orders.fees.refundAmount

number

Refund amount for the invoice

Example:

345.56

data.orders.fees.type

string

Item fee type

Example:

"tax"

data.orders.items

object[]

Invoicing item list

Invoice item sample

Show child attributes

data.orders.items.invoiceLineNumber

integer

required

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

Example:

3

data.orders.items.adjustmentTotal

number

The total number of price adjustments made for all items in this order.

Example:

123.45

data.orders.items.adjustments

object[]

Invoice adjustment details

Show child attributes

data.orders.items.adjustments.adjustmentCounter

integer

Represents number of times adjustment has happened to the order

Example:

1

data.orders.items.adjustments.attributes

object

Custom attributes specific to tenant

Show child attributes

data.orders.items.adjustments.notes

string

An optional free text field and is saved as a metadata

Example:

"Any additional info"

data.orders.items.adjustments.quantity

integer

Adjustment quantity

Example:

1

data.orders.items.adjustments.reasonCode

string

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

Example:

"Incorrect Item"

data.orders.items.adjustments.subReasonCode

string

Merchant-defined sub reason code

Example:

"Late shipping"

data.orders.items.adjustments.value

number

Amount

Example:

34.56

data.orders.items.appeasements

object[]

Appeasements information, if invoiceType= APPEASEMENT

Appeasement details

Show child attributes

data.orders.items.appeasements.amount

number

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

Example:

34.56

data.orders.items.appeasements.appeasementCounter

integer

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

data.orders.items.appeasements.invoicedAmount

number

System-generated amount from Invoice service based on requested amount

Example:

34.56

data.orders.items.appeasements.payments

object[]

Order appeasement payment info

Show child attributes

data.orders.items.appeasements.reasonCode

string

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

Example:

"Incorrect Item"

data.orders.items.appeasements.subReasonCode

string

Subreason code for appeasement, for another layer of classification

Example:

"Late shipping"

data.orders.items.currency

string

Invoiced amount currency

Example:

"USD"

data.orders.items.discounts

object[]

Discount applicable for Item

Invoice discount details

Show child attributes

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

data.orders.items.discounts.amount

number

Discounted amount for the given quantity

Example:

2

data.orders.items.discounts.promotionCode

string

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

Example:

"HNY2022"

data.orders.items.discounts.promotionName

string

Promotion title or name

Example:

"Happy New Year"

data.orders.items.discounts.quantity

integer

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

Example:

2

data.orders.items.discounts.type

string

Promotion type

Example:

"promotion"

data.orders.items.fees

object[]

Fees charged for individual items of an invoice

Invoice fee details

Show child attributes

data.orders.items.fees.amount

number

Amount charged for an item in the invoice

Example:

34.56

data.orders.items.fees.quantity

integer

Quantity of items to which amount is charged

Example:

1

data.orders.items.fees.refundAmount

number

Refund amount for the invoice

Example:

345.56

data.orders.items.fees.type

string

Item fee type

Example:

"tax"

data.orders.items.invoiceLineTotal

number

Total invoiced amount per line item

Example:

600

data.orders.items.invoiceQuantity

integer

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

data.orders.items.itemAppeasementTotal

number

Total invoiced appeasement amount per line item

Example:

344.455

data.orders.items.itemDiscountsTotal

number

Total invoiced discount amount per line item

Example:

3.45

data.orders.items.itemFeeTotal

number

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

Example:

33.4

data.orders.items.itemId

integer

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

Example:

1234455322

data.orders.items.itemTaxTotal

number

Total invoiced tax amount per line item

Example:

2.4

data.orders.items.itemUnitPrice

number

Item's unit price

Example:

33.4

data.orders.items.lineItemCreatedAt

string

Time order line item was created

Example:

"2022-11-22T10:26:38Z"

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

data.orders.items.lineItemNumber

integer

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

Example:

1

data.orders.items.locationStoreId

string

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

Example:

"4512345"

data.orders.items.orderId

string

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

Example:

"33adfrghhh2346aaaffff"

data.orders.items.returnExpirationDays

string

Return expiration in days

Example:

"21"

data.orders.items.returns

object[]

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

Order return details

Show child attributes

data.orders.items.returns.exchangeLineItemId

string

Exchange line item ID

Example:

"62f3dfc438bcab1951be0a19"

data.orders.items.returns.fees

object[]

Return fee details

Show child attributes

data.orders.items.returns.invoicedAmount

number

System-generated amount from Invoice service based on requested amount

Example:

11.29

data.orders.items.returns.isExchangeItemReturned

boolean

default:

false

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

Example:

true

data.orders.items.returns.reasonCode

string

Merchant-defined reason code for return

Example:

"Incorrect item"

data.orders.items.returns.refundAmount

number

Refund amount

Example:

11.29

data.orders.items.returns.refunds

object[]

Return fee details

Show child attributes

data.orders.items.returns.returnRequestCounter

integer

Unique, sequential, or incremental counter for return request

Example:

1

data.orders.items.returns.returnsReceivedAt

string

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

Example:

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

data.orders.items.returns.shipmentId

string

24-character system-generated shipment ID

Example:

"62b37697c67b204dd18a7465"

data.orders.items.returns.shipmentInvoice

object

The shipment invoice resource object.

Show child attributes

data.orders.items.returns.shipmentLineItemId

string

Unique identifier for each item in the shipment

Example:

"234"

data.orders.items.returns.shipmentQuantity

integer

default:

0

Shipped quantity of given item

Example:

1

data.orders.items.shipToId

string

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

Example:

"5349b4ddd2781d08c09890f4"

data.orders.items.shipmentLineItemId

string

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

Example:

"2adfrghhh2346aaaffff"

data.orders.items.sku

string

Stock Keeping Unit (SKU), unique identifier of item

Example:

"P1234"

data.orders.items.taxDetails

object[]

Item tax details

Tax details for the invoice

Show child attributes

data.orders.items.taxDetails.amount

number

Amount for type

Example:

34.56

data.orders.items.taxDetails.type

string

Item fee type

Example:

"tax"

data.orders.items.type

string

Order item type

Example:

"WEB_PICKUP"

data.orders.items.uom

string

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

Example:

"EA"

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

data.orders.orderSubtype

enum<string>

Order subtype for further order classification

Available options:

IOS,

ANDROID,

INTERNATIONAL

Example:

"INTERNATIONAL"

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

data.orders.orderedAt

string

System-generated order creation time

Example:

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

data.orders.payments

object[]

Invoicing payment list

Payment resource details for the invoice

Show child attributes

data.orders.payments.attributes

object

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

Show child attributes

data.orders.payments.attributes.{key}

object

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

data.orders.payments.authorizedAmount

number

Amount authorized to be debited from the given paymentMethod

Example:

256.1

data.orders.payments.billToAddress

object

Address details

Show child attributes

data.orders.payments.billToAddress.addressLine1

string

required

Address line 1

Example:

"123 Main St."

data.orders.payments.billToAddress.city

string

required

City name

Example:

"Seattle"

data.orders.payments.billToAddress.countryCode

string

required

ISO 3166-1 alpha-2 based country code

Example:

"US"

data.orders.payments.billToAddress.latitude

number

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

data.orders.payments.billToAddress.longitude

number

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

data.orders.payments.billToAddress.postalCode

string

required

Postal or ZIP code

Example:

"98121"

data.orders.payments.billToAddress.region

string

required

Region or state

Example:

"WA"

data.orders.payments.billToAddress.type

string

required

Address type

Example:

"Home"

data.orders.payments.billToAddress.addressLine2

string

Address line 2

Example:

"Suite 100"

data.orders.payments.billToAddress.addressLine3

string

Address line 3

Example:

"Seventh floor"

data.orders.payments.billToAddress.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

data.orders.payments.billToAddress.email

string

Contact person's email

Example:

"[e-mail]"

data.orders.payments.billToAddress.name

object

Contact person's name

Show child attributes

data.orders.payments.billToAddress.phone

object

Contact person's phone details

Show child attributes

data.orders.payments.conversion

number

Conversion required for currency

Example:

1

data.orders.payments.currency

string

Three-letter currency code as defined by ISO-4217

Example:

"USD"

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

data.orders.payments.paymentCounter

integer

Unique incremented number for this payment object

Example:

1

data.orders.payments.paymentIdentifier

object

Invoice payment identifier

Show child attributes

data.orders.payments.paymentIdentifier.cardIdentifier

string

Card number

Example:

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

data.orders.payments.paymentMethod

string

Payment method such as PayPal or Credit Card

Example:

"CREDIT_CARD"

data.orders.payments.paymentProvider

string

Name of the payment provider

Example:

"stripe"

data.orders.payments.paymentStatus

string

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

Example:

"PAID"

data.orders.payments.paymentToken

object

Invoice payment token

Show child attributes

data.orders.payments.paymentToken.token

string

Payment token number

Example:

"pi_34tr6787rt"

data.orders.payments.paymentType

string

Payment type such as VISA or Mastercard

Example:

"VISA"

data.orders.payments.settlement

object

Invoice settlement details

Show child attributes

data.orders.payments.settlement.settledAt

string

System-generated invoice settlement time

Example:

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

data.orders.payments.settlement.settlementAmount

number

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

Example:

10.3

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

data.orders.returns

object[]

Order returns info

Show child attributes

data.orders.returns.fees

object[]

Return fee details

Show child attributes

data.orders.returns.fees.amount

number

Merchant-defined return amount

Example:

34.56

data.orders.returns.fees.name

string

Fee name

Example:

"RETURN_FEE"

data.orders.returns.fees.reason

string

Merchant-defined return reason

Example:

"Return fee"

data.orders.returns.fees.type

enum<string>

Return fee type

Available options:

TAX,

DISCOUNT,

FEE,

ITEM,

ADJUSTMENT

Example:

"FEE"

data.orders.returns.invoicedAmount

number

System-generated invoiced amount for the return request

Example:

11.29

data.orders.returns.paymentCounterRefundDetails

object[]

Payment counter refund details

Show child attributes

data.orders.returns.paymentCounterRefundDetails.amount

number

Final refunded amount

Example:

34.56

data.orders.returns.paymentCounterRefundDetails.paymentCounter

integer

Unique incremented number for this payment object

Example:

1

data.orders.returns.refunds

object[]

Return fee details

Show child attributes

data.orders.returns.refunds.amount

number

Merchant-defined return amount

Example:

34.56

data.orders.returns.refunds.name

string

Fee name

Example:

"RETURN_FEE"

data.orders.returns.refunds.reason

string

Merchant-defined return reason

Example:

"Return fee"

data.orders.returns.refunds.type

enum<string>

Return fee type

Available options:

TAX,

DISCOUNT,

FEE,

ITEM,

ADJUSTMENT

Example:

"FEE"

data.orders.returns.returnCounter

integer

Unique, sequential or incremental counter for return request

Example:

1

data.orders.returns.totalRefundAmount

number

Merchant-defined total refund amount for the return request

Example:

11.29

data.orders.taxDetails

object[]

Invoicing tax details

Tax details for the invoice

Show child attributes

data.orders.taxDetails.amount

number

Amount for type

Example:

34.56

data.orders.taxDetails.type

string

Item fee type

Example:

"tax"

data.postedAt

string

Time invoice was emitted to third-party system for financial processing

Example:

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

data.retail

object

Invoice retail sample

Show child attributes

data.retail.cashierId

string

Merchant-specified cashier ID during invoice creation

Example:

"CE-321"

data.retail.locationNumber

integer

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

Example:

334

data.shipInfo

object

Order shipment details

Show child attributes

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

data.shipInfo.discounts

object[]

Details of shipping discount

Show child attributes

data.shipInfo.discounts.amount

number

Discounted amount for the given quantity

Example:

2.99

data.shipInfo.discounts.promotionCode

string

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

Example:

"SHIPFREE"

data.shipInfo.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:

"SHIPFREE"

data.shipInfo.discounts.promotionName

string

Promotion name

Example:

"Free Shipping"

data.shipInfo.discounts.quantity

integer

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

Example:

1

data.shipInfo.discounts.unit

string

Indicates whether the discount is in amount or percentage

Example:

"AMOUNT_OFF"

data.shipInfo.discounts.value

integer

Value corresponding to unit

Example:

10

data.shipInfo.estimatedDeliveryDate

string

Estimated delivery time (UTC) provided by carrier

Example:

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

data.shipInfo.estimatedShipDate

string

Estimated shipping time (UTC) provided by merchant

Example:

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

data.shipInfo.isInvoiced

boolean

default:

false

true: At least one captured invoice is created by Invoice service false: Captured invoice isn't created

Example:

true

data.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:

"123"

data.shipInfo.pickups

object[]

Order pickup details

Order pickup details

Show child attributes

data.shipInfo.pickups.email

string

Contact person's email

Example:

"[e-mail]"

data.shipInfo.pickups.name

object

Contact person's name

Show child attributes

data.shipInfo.pickups.name.firstName

string

Contact person's first name

Example:

"Alex"

data.shipInfo.pickups.name.lastName

string

Contact person's last name

Example:

"Doe"

data.shipInfo.pickups.name.middleName

string

Contact person's middle name or initial

Example:

"E"

data.shipInfo.pickups.phone

object

Contact person's phone details

Show child attributes

data.shipInfo.pickups.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

data.shipInfo.pickups.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

data.shipInfo.pickups.pickupType

enum<string>

Order pickup type

Available options:

PRIMARY,

ALTERNATE

Example:

"PRIMARY"

data.shipInfo.shipMethod

string

Shipping method

Example:

"Parcel post delivery"

data.shipInfo.shipToAddress

object

Address details

Show child attributes

data.shipInfo.shipToAddress.addressLine1

string

required

Address line 1

Example:

"123 Main St."

data.shipInfo.shipToAddress.city

string

required

City name

Example:

"Seattle"

data.shipInfo.shipToAddress.countryCode

string

required

ISO 3166-1 alpha-2 based country code

Example:

"US"

data.shipInfo.shipToAddress.latitude

number

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

data.shipInfo.shipToAddress.longitude

number

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

data.shipInfo.shipToAddress.postalCode

string

required

Postal or ZIP code

Example:

"98121"

data.shipInfo.shipToAddress.region

string

required

Region or state

Example:

"WA"

data.shipInfo.shipToAddress.type

string

required

Address type

Example:

"Home"

data.shipInfo.shipToAddress.addressLine2

string

Address line 2

Example:

"Suite 100"

data.shipInfo.shipToAddress.addressLine3

string

Address line 3

Example:

"Seventh floor"

data.shipInfo.shipToAddress.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

data.shipInfo.shipToAddress.email

string

Contact person's email

Example:

"[e-mail]"

data.shipInfo.shipToAddress.name

object

Contact person's name

Show child attributes

data.shipInfo.shipToAddress.name.firstName

string

Contact person's first name

Example:

"Alex"

data.shipInfo.shipToAddress.name.lastName

string

Contact person's last name

Example:

"Doe"

data.shipInfo.shipToAddress.name.middleName

string

Contact person's middle name or initial

Example:

"E"

data.shipInfo.shipToAddress.phone

object

Contact person's phone details

Show child attributes

data.shipInfo.shipToAddress.phone.number

string

Contact person's phone number

Example:

"123-456-7890"

data.shipInfo.shipToAddress.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

data.shipInfo.shipToDiscount

number

Merchant-defined shipping discount amount

Example:

12.6

data.shipInfo.shipToPrice

number

Merchant-defined shipping cost

Example:

20

data.shipInfo.shipToTaxTotal

number

Total shipping tax

Example:

12.6

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

data.shipInfo.shipToUnitPrice

number

Merchant-defined shipping cost

Example:

20

data.shipInfo.shipmentInstructions

string

Shipment instructions

Example:

"Handle with care"

data.shipInfo.taxCode

string

Applicable tax code, varies from state to state

Example:

"FR01"

data.shipInfo.taxDetails

object[]

Tax details

Show child attributes

data.shipInfo.taxDetails.amount

number

Tax amount

Example:

34.56

data.shipInfo.taxDetails.attributes

object

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

Show child attributes

data.shipInfo.taxDetails.attributes.{key}

object

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

data.shipInfo.taxDetails.currency

string

default:

USD

Three-letter currency code as defined by ISO-4217

Example:

"USD"

data.shipInfo.taxDetails.name

string

Applied tax name

Example:

"STATE"

data.shipInfo.taxDetails.rate

number

Rate

Example:

10

data.shipInfo.taxDetails.rateType

string

Rate type

Example:

"PERCENTAGE"

data.shipInfo.taxDetails.taxCode

string

Tax code applied

Example:

"FR01"

data.shipmentNumber

string

Merchant-specified shipment number for which invoice is generated

Example:

"217088603"

data.shippedAt

string

Order shipment time (UTC)

Example:

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

data.updatedAt

string

Time invoice was updated

Example:

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

pagination

object

Pagination response

Show child attributes

pagination.count

integer

Total number of search results

Example:

1000

pagination.limit

integer

default:

10

Maximum number of records per page

Required range: 1 <= x <= 100

Example:

10

pagination.offset

integer

default:

0

Number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.

Required range: x >= 0

Example:

1