Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.
1001
The unique invoice ID. This ID is automatically generated when an invoice is created.
5005
Response
Invoice details
Invoice number
1 - 32
"RC123456"
Invoice ID
1
Connection ID
2
Types of invoice terms
End of Month (EOM)
, No Charge
, Consignment
, 10 Days After End of Month (10 EOM)
, Cash Discount Terms Apply
, Basic
, Fixed Date, Late Payment Penalty Applies
, Extended
, Discount Not Applicable
, Fixed Date
, Previously agreed upon
"Previously agreed upon"
Description of invoice terms
"Previously agreed upon terms will apply"
Number of days to pay invoice
-2147483648 <= x <= 2147483647
35
Payment expected date
null
Discount percentage on selected term
null
Order ID related to invoice
"O-654"
Customer order number (for enduser)
64
"CO-435"
Purchase order number (for retailer)
64
"PO-546"
Invoice status
closed
, open
"closed"
Name of shipping carrier
32
"ALZ carrier"
Code of shipping carrier
32
"230F"
Shipping account number
32
"SH879"
Name of shipping method
32
"Next day delivery"
Code of shipping method
32
"ND"
Shipping tracking number
32
"1Z9999999999999988"
Shipping weight
"7.00"
Additional info adding to shipping
"Signature required"
Time when the invoice was created (UTC format).
"2022-05-10T15:24:56Z"
Time of order finalization (UTC format)
"2022-05-10T15:24:56Z"
Time of shipping (UTC format)
"2022-05-10T15:24:56Z"
Time of retailer acknowledgement (UTC format)
"2022-06-10T15:24:56Z"
Time of payment (UTC format)
"2022-06-10T15:24:56Z"
Time of complete invoice payment (UTC format)
null
Time of order cancellation (UTC format)
null
Total invoice amount (excluding taxes)
"12.89"
Pending amount
"2.89"
Expected due amount (excluding allowances and charges)
"2.89"
Sub-total
"10.89"
Total tax on the invoice
"2.00"