GET
/
invoices
/
{invoiceId}

Authorizations

Authorization
string
headerrequired

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

200 - application/json

Invoice response

channelId
string
required

Sales channel ID

currency
string
required

Currency type in which amount is invoiced

invoiceId
string
required

System-generated unique invoice ID

invoiceTotal
number
required

Total invoiced amount captured for the order

shipmentId
string
required

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

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
totalTaxAmount
number
required

Total tax amount invoiced

version
integer
required

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

acknowledgedAt
string

Invoice acknowledgement time by merchant

auditLogs
object[]

Audit log

createdAt
string

Time invoice was created

customer
object

Customer details for the generated invoice

invoiceNumber
string

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

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
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
invoicedAt
string

System-generated invoice creation time (UTC)

location
object

Contains location details regarding shipment if invoiceType= SHIPPING

locationNumber
string

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

orders
object[]

Invoice order details

postedAt
string

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

retail
object

Invoice retail sample

shipInfo
object

Order shipment details

shipmentNumber
string

Merchant-specified shipment number for which invoice is generated

shippedAt
string

Order shipment time (UTC)

updatedAt
string

Time invoice was updated

Was this page helpful?

Acknowledge financial transactionSearch for invoices