Getting Started
Authentication v3
- Concepts
- System Apps
- User Apps
- Authentication Endpoints
Product Catalog
- Product Catalog API - Overview
- Developer Guide
- Data Ingestion Best Practices
- Attributes & Attribute Mapping
- Categories
- Products
- Collections
- Background Jobs
- Bulk Import & Export
- Published Products
Orders
- Orders (3.0.0)
- Developer Guide
- Orders FAQ
- Shopping Lists
- Shipping Methods
- Imports
- Exports
- Orders
- Frauds
- Notifications
- Backorders Preorders
- Cancellations
- Allocations
- Shipments
- Inventory Transfers
- Tracking
- Invoices
- Payments
- Credits
- Appeasements
- Returns
Inventory
- Inventory (3.0.0)
- Inventory FAQ
- Imports
- Counters
- Inventory
- Locations
- Networks
Integrations
Offers
- Offers (3.0.0)
- Developer Guide
- Real-time Pricing Engine
- Price Lists
- Prices
- Price Types
- Price Controls
- Price Methods
- Priced Products
- Add-ons
- Promotions
- Coupons
- Coupon Codes
- Redemptions
- Product Exclusion Lists
- Segments
- Imports
- Exports
- Attributes
- Webhook Events
Carts
- Overview
- Developer Guides
- Carts
- Order Draft
- Items
- Addresses
- Payments
- Fulfillment
- Customer
- Coupons
- Validations
- Cart Orchestrator
Customers
- Customer Profile
- Customer Address
- Customer Self
Search for invoices
Search for invoices by matching filter criteria.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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 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.
Unique request ID
Number of records to skip before returning all records. Default is 0 if no value is specified.
Maximum number of records returned per page. Default is 10 if no value is specified.
Sort and filter criteria for invoice search
Property by which data is sorted. Note: - refers to descending and + refers to ascending order
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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 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.
Unique request ID
Query Parameters
Number of records to skip before returning all records. Default is 0 if no value is specified.
Maximum number of records returned per page. Default is 10 if no value is specified.
1 < x < 100Body
Sort and filter criteria for invoice search
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.
EQ, NEQ, IN, NIN, LT, GT, LTE, GTE Field name
The group name.
A single value for field using which data is searched
Property by which data is sorted. Note: - refers to descending and + refers to ascending order
Response
Invoice search response
Invoice acknowledgement time by merchant
Audit log
Amount for which audit's done
System-generated audit ID (UUID format)
Audit type such as cancel, return, etc.
Audit time (UTC)
Employee (ID or name) who made the last update
true: Update operation (any update to the service) is successful false: Update operation has failed
Merchant-defined unique identifier for each item in an order. When omitted, fabric will generate it during order creation, in UUID format.
Item identifier
Additional info, if any
Configurable in Copilot as per requirement. If omitted, default policy is used.
Ordered quantity of given item
Merchant-defined reason code, varies from merchant to merchant
Stock keeping unit (SKU), unique item identifier
Merchant-defined source from where the update was initiated. There are no predefined values; possible values could be Customer Service Representative (CSR), Point-of-Sale (POS), etc.
Merchant-defined sub reason code; provides more clarity to audit reason
Sales channel ID
Time invoice was created
Currency type in which amount is invoiced
Customer details for the generated invoice
Customer's loyalty account ID or external identifier that's used to track their loyalty program activity and rewards earned.
Address details
Address line 1
City name
ISO 3166-1 alpha-2 based country code
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.
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.
Postal or ZIP code
Region or state
Address type
Address line 2
Address line 3
Address line 4
Contact person's email
Shopper's company name. This may be used for company discounts.
Contact person's email
Employee (ID or name) who initiated an update request
Identifier of the logged in user who initiated the request. This could be from either fabric Identity service or an external Identity service.
System-generated unique invoice ID
Merchant-defined unique invoice number. If omitted, this is generated by fabric’s sequence generator using Configuration service.
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.
CAPTURED, SETTLED, SETTLE_FAILED, PARTIAL_SETTLED Total invoiced amount captured for the order
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.
RETURN, SHIPPING, APPEASEMENT, ORDER_DONATION, ORDER_CARRY, EXCHANGE System-generated invoice creation time (UTC)
Contains location details regarding shipment if invoiceType= SHIPPING
Address with contact details
Address line 1
City name
ISO 3166-1 alpha-2 based country code
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.
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.
Postal or ZIP code
Region or state
Address type
Address line 2
Address line 3
Address line 4
Contact person's email
If invoiceType= SHIPPING, location number refers to the inventory location from where the order is fulfilled.
Unique value to identify ship-from location. This must be the locationNumber stored in the fabric Location service.
Invoice order details
Represents number of times adjustment has happened to the order
Custom attributes specific to tenant
Custom attributes specific to tenant
An optional free text field and is saved as a metadata
Adjustment quantity
Merchant-defined reason code for order adjustment, varies from merchant to merchant
Merchant-defined sub reason code
Amount
Invoice appeasement details
Merchant-defined appeasement amount, which shouldn't exceed (charged amount - already refunded amount)
Sequential or incremental counter for appeasement. Used for keeping track of duplicates in the request. If omitted in the request, it'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.
System-generated amount from Invoice service based on requested amount
Merchant-defined appeasement reason code; varies from merchant to merchant
Subreason code for appeasement, for another layer of classification
Invoicing discount list
Discounted amount for the given quantity
Promotion code used by shoppers to take advantage of an ongoing promotion and avail discounts
Unique promotion ID either from fabric Offers service or external Offers service. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of Create promotion endpoint.
Promotion title or name
Number of discounted items in an order; example- buy 2 get 2 free
Promotion type
Total amount charged for the order
Invoicing item list
The total number of price adjustments made for all items in this order.
Represents number of times adjustment has happened to the order
Custom attributes specific to tenant
An optional free text field and is saved as a metadata
Adjustment quantity
Merchant-defined reason code for order adjustment, varies from merchant to merchant
Merchant-defined sub reason code
Amount
Appeasements information, if invoiceType= APPEASEMENT
Merchant-defined appeasement amount, which shouldn't exceed (charged amount - already refunded amount)
Sequential or incremental counter for appeasement. Used for keeping track of duplicates in the request. If omitted in the request, it'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.
System-generated amount from Invoice service based on requested amount
Merchant-defined appeasement reason code; varies from merchant to merchant
Subreason code for appeasement, for another layer of classification
Invoiced amount currency
Discount applicable for Item
Discounted amount for the given quantity
Promotion code used by shoppers to take advantage of an ongoing promotion and avail discounts
Unique promotion ID either from fabric Offers service or external Offers service. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of Create promotion endpoint.
Promotion title or name
Number of discounted items in an order; example- buy 2 get 2 free
Promotion type
Fees charged for individual items of an invoice
System-specified sequential number iterated for each item in the array of the invoice
Total invoiced amount per line item
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.
Total invoiced appeasement amount per line item
Total invoiced discount amount per line item
Total invoiced fee per line item. For fee, refer to amount in invoiceFeeDetail.
Unique identifier of item from fabric Products (previously called PIM) service
Total invoiced tax amount per line item
Item's unit price
Time order line item was created
Merchant-defined unique identifier for each item. When omitted, fabric will generate it during order creation, in UUID format.
Merchant-defined line item number to identify each item in an order
ID of the store from where the item is picked for shipment
24-character system-generated unique order ID (UUID) to which the item belongs
Return expiration in days
If invoiceType= RETURN, the details of the returned items will be included in the invoice.
Exchange line item ID
System-generated amount from Invoice service based on requested amount
true: Item received for exchange is returned false: Item received for exchange isn't returned
Merchant-defined reason code for return
Refund amount
Unique, sequential, or incremental counter for return request
System-generated time of returned item that has come back to the facility (UTC)
24-character system-generated shipment ID
The shipment invoice resource object.
Unique identifier for each item in the shipment
Shipped quantity of given item
If invoiceType= SHIPPING, the Ship-to ID corresponds to the shipment for which the invoice was generated.
Unique identifier for shipment of the line item. This attribute is inherited from fabric shipment service.
Stock Keeping Unit (SKU), unique identifier of item
Order item type
Item's unit of measurement. For example, for each quantity (EA), or GAL (Gallon), DZ (Dozens), etc.
24-character system-generated unique order ID (UUID) for which invoice is created
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.
Order subtype for further order classification
IOS, ANDROID, INTERNATIONAL 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
WEB, CSC, MOBILE_APP, POS System-generated order creation time
Invoicing payment list
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs)
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs)
Amount authorized to be debited from the given paymentMethod
Address details
Address line 1
City name
ISO 3166-1 alpha-2 based country code
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.
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.
Postal or ZIP code
Region or state
Address type
Address line 2
Address line 3
Address line 4
Contact person's email
Contact person's name
Contact person's phone details
Conversion required for currency
Three-letter currency code as defined by ISO-4217
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).
Unique incremented number for this payment object
Invoice payment identifier
Card number
Payment method such as PayPal or Credit Card
Name of the payment provider
Payment status. There are no predefined values; possible values are Paid, Partially Paid, Authorized, and Error.
Invoice payment token
Payment token number
Payment type such as VISA or Mastercard
Invoice settlement details
System-generated invoice settlement time
Amount that needs to be collected from or refunded to the shopper. It's invoicedAmount - chargedAmount.
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
SETTLED, PARTIAL_SETTLED, SETTLEMENT_FAILED System-generated invoiced amount for the return request
Merchant-defined return amount
Fee name
Merchant-defined return reason
Return fee type
TAX, DISCOUNT, FEE, ITEM, ADJUSTMENT Unique, sequential or incremental counter for return request
Merchant-defined total refund amount for the return request
Time invoice was emitted to third-party system for financial processing
Order shipment details
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.
Discounted amount for the given quantity
Promotion code used by shoppers to take advantage of an ongoing promotion.
Unique promotion ID either from fabric Offers service or external Offers service. When fabric Offers service is used, this is the 24-character system-generated promotion ID returned in the response of create promotion endpoint.
Promotion name
Number of discounted items in an order such as buy 2 get 1 free. In this case 1 is the discounted quantity.
Indicates whether the discount is in amount or percentage
Value corresponding to unit
Estimated delivery time (UTC) provided by carrier
Estimated shipping time (UTC) provided by merchant
true: At least one captured invoice is created by Invoice service false: Captured invoice isn't created
Unique value to identify ship-from or Buy Online Pickup from Store location. This must be the locationNumber stored in the fabric Location service.
Order pickup details
Contact person's email
Order pickup type
PRIMARY, ALTERNATE Shipping method
Address details
Address line 1
City name
ISO 3166-1 alpha-2 based country code
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.
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.
Postal or ZIP code
Region or state
Address type
Address line 2
Address line 3
Address line 4
Contact person's email
Merchant-defined shipping discount amount
Merchant-defined shipping cost
Total shipping tax
Type of shipping address. There are no pre-defined values; the possible values are SDD (Same Day Delivery), Point-of-Sale (POS), etc.
Merchant-defined shipping cost
Shipment instructions
Applicable tax code, varies from state to state
Tax amount
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Three-letter currency code as defined by ISO-4217
Applied tax name
Rate
Rate type
Tax code applied
24-character system-generated shipment ID for which invoice is generated
Merchant-specified shipment number for which invoice is generated
Order shipment time (UTC)
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.
CREATED, POSTED, ACKNOWLEDGED Total tax amount invoiced
Time invoice was updated
The current version of invoice document. The integer indicates the number of times the invoice has been updated by any operation.
Pagination response
Total number of search results
Maximum number of records per page
1 < x < 100Number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.
x > 0Was this page helpful?