Vendor Direct Fulfillment Payments API v1 Reference

The Selling Partner API for Direct Fulfillment Payments provides programmatic access to a direct fulfillment vendor's invoice data.

Version information

Version : v1

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

application/json

Produces

application/json

Operations

submitInvoice

Paths

POST /vendor/directFulfillment/payments/v1/invoices

Operation: submitInvoice

Description

Submits one or more invoices for a vendor's direct fulfillment orders.

Usage Plan:

Rate (requests per second)	Burst
10	10

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

Type	Name	Description	Schema
Body	body required	The request body containing one or more invoices for vendor orders.	SubmitInvoiceRequest

Responses

HTTP Code	Description	Schema
202	Success. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : Unique request reference identifier.	SubmitInvoiceResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP Code	Description	Schema
400	Request has missing or invalid parameters and cannot be parsed. Headers: `x-amzn-RateLimit-Limit` (string):Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string):Unique request reference identifier.	SubmitInvoiceResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	SubmitInvoiceResponse
404	The resource specified does not exist. Headers: `x-amzn-RateLimit-Limit` (string):Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string):Unique request reference identifier.	SubmitInvoiceResponse
413	The request size exceeded the maximum accepted size. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	SubmitInvoiceResponse
415	The request payload is in an unsupported format. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	SubmitInvoiceResponse
429	The frequency of requests was greater than allowed. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	SubmitInvoiceResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	SubmitInvoiceResponse
503	Temporary overloading or maintenance of the server. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	SubmitInvoiceResponse

Definitions

SubmitInvoiceRequest

The request schema for the submitInvoice operation.

Name	Description	Schema
invoices optional	An array of invoice details to be submitted.	< InvoiceDetail > array

InvoiceDetail

Represents the details of an invoice, including invoice number, date, parties involved, payment terms, totals, taxes, charges, and line items.

Name	Description	Schema
invoiceNumber required	The unique invoice number.	string
invoiceDate required	Invoice date.	string (date-time)
referenceNumber optional	An additional unique reference number used for regulatory or other purposes.	string
remitToParty required	Name, address and tax details of the party receiving the payment of this invoice.	PartyIdentification
shipFromParty required	Warehouse code of the vendor as in the order.	PartyIdentification
billToParty optional	Name, address and tax details of the party to whom this invoice is issued.	PartyIdentification
shipToCountryCode optional	Ship-to country code.	string
paymentTermsCode optional	The payment terms for the invoice.	string
invoiceTotal required	Total amount details of the invoice.	Money
taxTotals optional	Individual tax details per line item.	< TaxDetail > array
additionalDetails optional	Additional details provided by the selling party, for tax-related or other purposes.	< AdditionalDetails > array
chargeDetails optional	Total charge amount details for all line items.	< ChargeDetails > array
items required	Provides the details of the items in this invoice.	< InvoiceItem > array

InvoiceItem

Provides the details of the items in this invoice.

Name	Description	Schema
itemSequenceNumber required	Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.	string
buyerProductIdentifier optional	Buyer's standard identification number (ASIN) of an item.	string
vendorProductIdentifier optional	The vendor selected product identification of the item.	string
invoicedQuantity required	Item quantity invoiced.	ItemQuantity
netCost required	Net price (before tax) to vendor with currency details.	Money
purchaseOrderNumber required	The purchase order number for this order. Formatting Notes: 8-character alpha-numeric code.	string
vendorOrderNumber optional	The vendor's order number for this order.	string
hsnCode optional	Harmonized System of Nomenclature (HSN) tax code. The HSN number cannot contain alphabets.	string
taxDetails optional	Individual tax details per line item.	< TaxDetail > array
chargeDetails optional	Individual charge details per line item.	< ChargeDetails > array

PartyIdentification

Name, address and tax details of a party.

Name	Description	Schema
partyId required	Assigned Identification for the party.	string
address optional	Identification of the party by address.	Address
taxRegistrationDetails optional	Tax registration details of the entity.	< TaxRegistrationDetail > array

TaxRegistrationDetail

Tax registration details of the entity.

Name	Description	Schema
taxRegistrationType optional	Tax registration type for the entity.	enum (TaxRegistrationType)
taxRegistrationNumber required	Tax registration number for the entity. For example, VAT ID, Consumption Tax ID.	string
taxRegistrationAddress optional	Address associated with the tax registration number.	Address
taxRegistrationMessage optional	Tax registration message that can be used for additional tax related details.	string

Address

Address of the party.

Name	Description	Schema
name required	The name of the person, business or institution at that address.	string
addressLine1 required	First line of the address.	string
addressLine2 optional	Additional street address information, if required.	string
addressLine3 optional	Additional street address information, if required.	string
city required	The city where the person, business or institution is located.	string
county optional	The county where person, business or institution is located.	string
district optional	The district where person, business or institution is located.	string
stateOrRegion required	The state or region where person, business or institution is located.	string
postalCode required	The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.	string
countryCode required	The two digit country code in ISO 3166-1 alpha-2 format.	string
phone optional	The phone number of the person, business or institution located at that address.	string

Money

An amount of money, including units in the form of currency.

Name	Description	Schema
currencyCode required	Three digit currency code in ISO 4217 format.	string
amount required	A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. Pattern : `^-?(0\|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`.	Decimal

Decimal

A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
Pattern : ^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$.

Type : string

TaxDetail

Details of tax amount applied.

Name	Description	Schema
taxType required	Type of the tax applied.	enum (TaxType)
taxRate optional	Tax percentage applied. Percentage must be expressed in decimal.	Decimal
taxAmount required	Total tax amount applied on invoice total or an item total.	Money
taxableAmount optional	This field will contain the invoice amount that is taxable at the rate specified in the tax rate field.	Money

ChargeDetails

Monetary and tax details of the charge.

Name	Description	Schema
type required	Type of charge applied.	enum (Type)
chargeAmount required	An amount of money, including units in the form of currency.	Money
taxDetails optional	Individual tax details per line item.	< TaxDetail > array

AdditionalDetails

A field where the selling party can provide additional information for tax-related or any other purposes.

Name	Description	Schema
type required	The type of the additional information provided by the selling party.	enum (Type)
detail required	The detail of the additional information provided by the selling party.	string
languageCode optional	The language code of the additional information detail.	string

ItemQuantity

Details of item quantity.

Name	Description	Schema
amount required	Quantity of units available for a specific item.	integer
unitOfMeasure required	Unit of measure for the available quantity.	string

SubmitInvoiceResponse

The response schema for the submitInvoice operation.

Name	Description	Schema
payload optional	The response payload for the submitInvoice operation.	TransactionReference
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

TransactionReference

Response containing the transaction ID.

Name	Description	Schema
transactionId optional	GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.	string

ErrorList

A list of error responses returned when a request is unsuccessful.

Type : < Error > array

Error

Error response returned when the request is unsuccessful.

Name	Description	Schema
code required	An error code that identifies the type of error that occurred.	string
message required	A message that describes the error condition.	string
details optional	Additional details that can help the caller understand or fix the issue.	string

TaxType

Type of the tax applied.

Type : enum

Value	Description
CGST	Central Goods and Services Tax (CGST) is levied by the Indian government for intrastate movement of goods and services.
SGST	State Goods and Services Tax (SGST) is an indirect tax levied and collected by a State Government in India on the intra-state supplies.
CESS	A cess is a form of tax levied by the government on tax with specific purposes till the time the government gets enough money for that purpose.
UTGST	Union Territory Goods and Services Tax in India.
IGST	Integrated Goods and Services Tax (IGST) is a tax levied on all Inter-State supplies of goods and/or services in India.
MwSt.	Mehrwertsteuer, MwSt, is the German for value-added tax.
PST	A provincial sales tax (PST) is imposed on consumers of goods and particular services in many Canadian provinces.
TVA	Taxe sur la Valeur Ajoutée (TVA) is French for Value-added tax.
VAT	Value-added tax.
GST	Tax levied on most goods and services sold for domestic consumption.
ST	Sales tax.
Consumption	Tax levied on consumption spending on goods and services.
MutuallyDefined	Tax component that was mutually agreed upon between Amazon and vendor.
DomesticVAT	Domestic Value-added tax.

TaxRegistrationType

Tax registration type for the entity.

Type : enum

Value	Description
VAT	Value-added tax.
GST	Goods and Services tax.

Type

Type : enum

For use with the definition(s): AdditionalDetails
The type of the additional information provided by the selling party.

Value	Description
SUR	An additional tax on something already taxed, such as a higher rate of tax on incomes above a certain level.
OCR	OCR.

For use with the definition(s): ChargeDetails
Type of charge applied.

Value	Description
GIFTWRAP	Additional charge applied for giftwrap order.
FULFILLMENT	Fulfillment fees are the costs associated with receiving and storing products along with processing orders from handling to shipping.
MARKETINGINSERT	Charge to insert ads on orders.
PACKAGING	Additional charge for packaging orders.
LOADING	Additional charge for loading orders.
FREIGHTOUT	Freight-out refers to the costs for which the seller is responsible when shipping to a buyer, such as delivery and insurance expenses.
TAX_COLLECTED_AT_SOURCE	Tax collected at source (TCS) is the tax payable by a seller which he collects from the buyer at the time of sale.