Release Notes 2024

Amazon Business API new features, bug fixes, and change log.

Get updates. Subscribe to our RSS feed.

December 2024

What’s new: Consolidated invoice support
Supported regions: EU, FE
Document API now supports programmatic download of consolidated invoice documents in EU and FE regions. For instructions on retrieving consolidated invoices, see How to download invoices.

{ "reportOptions": { "invoiceId":DE412022XXXX, "documentType": "Invoice" }, "reportType": "GET_AB_INVOICE_PDF", "marketplaceIds": ["A1PA6795UKMFR9"] }
{ "reportId": "ID323" }

What’s new: consolidatedInvoiceDetails
Supported regions: EU, FE
The getInvoiceDetailsByOrderLineItems operation now returns a consolidatedInvoiceDetails object. This object contains the invoiceNumber associated with a consolidated invoice. invoiceNumber is present if the customer has opted for consolidated invoicing in their Amazon Business account. If the invoice is not available yet, this field returns Pending. If the invoice is not consolidated, this object returns null.

{ "invoiceNumber": "JPXX8PV8HMOI", "invoiceDate": "2022-03-30T15:30:22.077Z", "consolidatedInvoiceDetails" : { "invoiceNumber" : "11XS-123S`-XXX` }, }

📘

The getInvoiceDetailsByOrderLineItems operation now returns two invoiceNumber attributes per transaction: one in the InvoiceDetail object and one in consolidatedInvoiceDetails. In EU, both invoiceNumber attributes contain the same ID. In Japan, the invoiceNumber in the InvoiceDetail is the ID for shipment-based invoices, and the invoiceNumber in the consolidatedInvoiceDetails object is the ID for consolidated invoices.

November 2024

What’s New: Best Seller badge
Supported regions: NA, EU, FE
The badges field in the productsResult object has been updated to return a BESTSELLER_BADGE that identifies best-selling products. Displaying this badge provides end customers with quick visibility into popular and trusted products, enabling informed purchasing decisions.

"badges": [ { "name": null, "fragment": { "title": "#1 Best Seller", "message": null, "link": { "text": "Office Products", "url": "https://www.amazon.com/gp/bestsellers/office-products" }, "type": "BESTSELLER_BADGE", "fragments": null } } ]

What’s new: shippingAddress
Supported regions: NA, EU, FE
Reporting API now returns shippingAddress in the Shipment object. This object contains the shipping address associated with the order and is returned in both getOrdersByOrderDate and getOrdersByOrderId operations. shippingAddress includes the following details:

  • addressLine1: The primary address with the street name, building number, city, state, and postal code.
  • addressLine2: The secondary address which can contain apartment, suite, room, or floor numbers.
  • city: The city of the address.
  • state: The state of the address.
  • postalCode: The postal code of the address.
  • countryCode: The country code of the address.
"shippingAddress": { "addressLine1": "7316 PARKRIDGE BLVD APT 88", "addressLine2": null, "city": "IRVING", "state": "TX", "postalCode": "75063-8351", "countryCode": "US" }

What’s New: Ordering API now supports multi-legal entities (MLE)
Supported regions: NA, FE
You can now configure MLE support for Ordering API. The auxiliary attribute type has been added in the request body to allow you to identify the legal entity or group that will own the order. By configuring MLE, you can better manage spend for each of your legal entities. For information, see How to configure Ordering API for MLE.

{ "externalId": "ExternalID-OrderLevel-IT-{{$randomPhoneNumber}}", "lineItems": [ { "externalId": "LineLevel-1", "quantity": 1, "attributes": [ { "attributeType": "SelectedProductReference", "productReference": { "id": "B00CA31590", "productReferenceType": "ProductIdentifier" } } ], "expectations": [ { "expectationType": "ExpectedUnitPrice", "amount": { "currencyCode": "EUR", "amount": 115 } } , { "expectationType": "ExpectedCharge", "amount": { "currencyCode": "EUR", "amount": 10000 }, "source": "SUBTOTAL" } ] } ], "attributes": [ { "attributeType": "Auxiliary", "values": { "key": { "value" : "vatid14156352" } } }, { "attributeType": "PurchaseOrderNumber", "purchaseOrderNumber": "PO2" }, { "attributeType": "BuyerReference", "userReference": { "userReferenceType": "UserEmail", "emailAddress": "test_email@amazon.com" } }, { "attributeType": "BuyingGroupReference", "groupReference": { "groupReferenceType": "GroupIdentity", "identifier": "Leg5Grp1" } }, { "attributeType": "Region", "region": "IT" }, { "attributeType": "SelectedPaymentMethodReference", "paymentMethodReference": { "paymentMethodReferenceType": "StoredPaymentMethod" } }, { "attributeType": "ShippingAddress", "address": { "addressType": "PhysicalAddress", "fullName": "Amazon Test Order- Return", "phoneNumber": "9898989898", "companyName": "companyName_amazoncompany", "addressLine1": "Viale Monte Grappa 3/5", "addressLine2": "", "city": "Milano", "stateOrRegion": "Milano", "postalCode": "28045", "countryCode": "IT" } }, { "attributeType": "BillingAddress", "address": { "addressType": "PhysicalAddress", "fullName": "i2 IT test2", "phoneNumber": "4402075501000", "companyName": "", "addressLine1": "325 9th Ave N,", "addressLine2": "", "city": "Seattle", "stateOrRegion": "WA", "postalCode": "98109", "countryCode": "US" } } ], "expectations": [ { "expectationType": "ExpectedCharge", "amount": { "currencyCode": "EUR", "amount": 20 }, "source": "SUBTOTAL" }, { "expectationType": "ExpectedCharge", "amount": { "currencyCode": "EUR", "amount": 10 }, "source": "TAX" }, { "expectationType": "ExpectedCharge", "amount": { "currencyCode": "EUR", "amount": 1 }, "source": "SHIPPING" } ] }

The API response remains the same.

October 2024

What’s New: PDF credit memo support now available in Amazon Business NA region
Supported regions: NA
Document API now supports the programmatic download of PDF credit memo documents in NA. For more information, see How to download invoices.

POST https://na.business-api.amazon.com/reports/2021-09-30/reports { "reportOptions": { "invoiceId":invoiceId, "documentType": "Credits" }, "reportType": "GET_AB_INVOICE_PDF", "marketplaceIds": ["ATVPDKIKX0DER"] }
{ "reportId": "ID323" }

What’s changed: name removed from badges object
Supported regions: NA and EU

The name field has been removed from the badges object in NA and EU. This field is still returned in JP until all partners have migrated to the new fields in the fragment object.

Here is a side-by-side comparison of the previous and current API responses.

Previous responseCurrent response
"badges": \[ { "name": null, "fragment": { "title": "Sustainability Features", "message": " Products with trusted sustainability certification(s).", "type": "SUSTAINABILITY_BADGE", "link": null, "fragments": [ { "title": "Forestry practices", "message": "Made with materials from well-managed forests, recycled materials, and/or other controlled wood sources.", "type": "SUSTAINABILITY_ATTRIBUTE", "link": null, "type": "SUSTAINABILITY_ATTRIBUTE", "fragments": null } ] } } ]"badges": \[ { "fragment": { "title": "Sustainability Features", "message": " Products with trusted sustainability certification(s).", "type": "SUSTAINABILITY_BADGE", "link": null, "fragments": [ { "title": "Forestry practices", "message": "Made with materials from well-managed forests, recycled materials, and/or other controlled wood sources.", "type": "SUSTAINABILITY_ATTRIBUTE", "link": null, "type": "SUSTAINABILITY_ATTRIBUTE", "fragments": null } ] } } ]

What’s New: Amazon Business APIs support static sandbox
Supported Regions: NA, EU, FE

You can now access Amazon Business APIs in static sandbox mode to make API calls without affecting production data. Using the sandbox environment saves you time during developer registration and provides hands-on experience with Amazon Business APIs. For instructions on using the static sandbox, see Amazon Business API sandbox.

You can send requests to the following sandbox endpoints:

Amazon Business marketplacesEndpoint
North America (Canada and US)https://sandbox.na.business-api.amazon.com
Europe (Spain, UK, France, Germany, Italy)https://sandbox.eu.business-api.amazon.com
Far East (Japan)https://sandbox.jp.business-api.amazon.com

September 2024

What’s New: badges object now returns more badge information
Supported regions: NA, EU, FE
badges in the offers object has been updated to return an array of fragment objects. This object also returns the new BUSINESS_INVOICE_BADGE, which corresponds to the Invoice by Amazon (IBA) badge in EU. If there are no values, the response returns an empty field.

"badges": [{ "name": "JCT", "fragment": { "title": "JCT", "message": null, "type": "JCT", "link": null, "fragments": null } }, { "name": null, "fragment": { "title": "Eligible for Tax Qualified Invoice (excluding untaxable products)", "message": " You can download a tax qualified invoice (payment statement) from Your Orders after the product has been shipped. However, this excludes untaxable products such as online code version software.", "type": "BUSINESS_INVOICE_BADGE", "link": null, "fragments": null } } ],

What’s New: fulfiller object in offers
Supported regions: NA, EU, FE
fulfiller object has been added in the offers object. This field contains the fulfiller’s name and fulfillmentType for a given offer. This field is always present in the API response.

"fulfiller": { "name": "Amazon", "fulfillmentType" : "AMAZON_FULFILLMENT" },

What’s New: badges in the productsResult object
Supported regions: NA, EU
badges object has been added at the product level. This object returns all of the badges associated with an ASIN, such as sustainability badges. If there are no values, the response is null.

"badges": [ { "name": null, "fragment": { "title": "Sustainability Features", "message": " Products with trusted sustainability certification(s).", "type": "SUSTAINABILITY_BADGE", "link": null, "fragments": [{ "title": "Forestry practices", "message": "Made with materials from well-managed forests, recycled materials, and/or other controlled wood sources.", "type": "SUSTAINABILITY_ATTRIBUTE", "link": null, "type": "SUSTAINABILITY_ATTRIBUTE", "fragments": null }] } } ],

What’s New: certificates list
Supported regions: NA, EU
certificates attribute has been added to the merchant object at the product level. This attribute lists the certificates associated with the merchant, such as "Small and Medium-Sized Enterprise" or “Women-Owned Business Enterprise.” This field is always present in the API response.

"certificates": [ "Women-Owned Small Business", "Minority-Owned Business", "889 certification", "Registered Small Business"], },

What’s New: buyingGuidanceV2 object
Supported regions: NA, EU, FE
buyingGuidanceV2 object has been added in the offers object. The previous buyingGuidance field only displayed the buying guidance, such as “Preferred” or “Restricted.” The new field returns the policies that contribute to that buying guidance, such as “Prefer items with sustainability certifications” or “Restrict items that are not eligible for Invoice by Amazon.” This field is always present in the API response.

"buyingGuidanceV2": { "buyingGuidance": [ { "title": "PREFERRED", "type": "PREFERRED", "message": null, "link": null, "fragments": [ { "title": "Buy Local", "message": "Sold by a local seller that your organization encourages you to buy from", "link": { "text": "EDIT POLICY", "url": "https://www.amazon.com/ab/ccp-portal/policies/view/group/A2UHE68K81N946/id/CCPALOCALS/2f7c59bb-ada9-4d9d-90bd-8b07f0ac4822%3Ffrom=DPX-B0014C2NBC" }, "type": "BUY_LOCAL", "fragments": null } ] } ] },

What’s Changed: Deprecation of badges, buyingGuidance, and fulfillmentType
Supported regions: NA, EU, FE
The following Product Search API fields have been deprecated:

  • badges in favor of badgesV2
  • buyingGuidance in favor of buyingGuidanceV2
  • fulfillmentType in favor of fulfiller

These deprecated fields will still be supported until all partners have migrated to the new fields. Here is a side-by-side comparison of the deprecated and new fields.

Deprecated fieldNew field
"badges": [ { "name": "JCT" } ],"badges": [ { "name": null, "fragment": { "title": "Sustainability Features", "message": " Products with trusted sustainability certification(s).", "type": "SUSTAINABILITY_BADGE", "link": null, "fragments": [{ "title": "Forestry practices", "message": "Made with materials from well-managed forests, recycled materials, and/or other controlled wood sources.", "type": "SUSTAINABILITY_ATTRIBUTE", "link": null, "type": "SUSTAINABILITY_ATTRIBUTE", "fragments": null }] } } ],
"buyingGuidance": "PREFERRED" "buyingGuidanceV2": { "buyingGuidance": [ { "title": "PREFERRED", "type": "PREFERRED", "message": null, "link": null, "fragments": [ { "title": "Buy Local", "message": "Sold by a local seller that your organization encourages you to buy from", "link": { "text": "EDIT POLICY", "url": "https://www.amazon.com/ab/ccp-portal/policies/view/group/A2UHE68K81N946/id/CCPALOCALS/2f7c59bb-ada9-4d9d-90bd-8b07f0ac4822%3Ffrom=DPX-B0014C2NBC" }, "type": "BUY_LOCAL", "fragments": null } ] } ] },
"fulfillmentType": "MERCHANT_FULFILLMENT""fulfiller": { "name": "Speedy Marquee", "fulfillmentType": "MERCHANT_FULFILLMENT" },

August 2024

What’s new: sellerCredentialDetails
Supported regions: NA
sellerCredentialDetails field has been added in the lineItem object. Previously, the API only returned a list of certificate names in the sellerCredentials field. Now, the API also returns an array of the following fields for each certificate:

  • certificateType: The name of the credential or certificate.
  • certifyingAgenciesDetails: Details of the issuing agency and certificate. This object contains the certifyingAgencyName and certificateExpirationDate.
"sellerCredentialDetails": [ { "certificateType": "Minority-Owned Business", "certifyingAgenciesDetails": [ { "certifyingAgencyName": "SAM", "certificateExpirationDate": 2024-06-11T00: 00Z } ] }, { "certificateType": "Registered Small Business", "certifyingAgenciesDetails": [ { "certifyingAgencyName": "SAM", "certificateExpirationDate": 2024-06-11T00: 00Z } ] }, { "certificateType": "889 certification", "certifyingAgenciesDetails": [ { "certifyingAgencyName": "SAM", "certificateExpirationDate": 2024-06-11T00: 00Z } ] } ]

What’s New: sellerPrimaryAddress
Supported regions: NA
sellerPrimaryAddress has been added in the Seller object. Previously, the API only returned the seller’s city, state, and postal code. Now, Seller includes sellerPrimaryAddress, which returns these fields:

  • addressLine1: The primary address of the seller with the street name, building number, city, state, and postal code.
  • addressLine2: The secondary address of the seller which can contain apartment, suite, room, or floor numbers.
  • city: The city of the selling merchant.
  • state: The state of the selling merchant.
  • postalCode: The postal code of the selling merchant.
  • countryCode: The country code of the selling merchant.
"sellerPrimaryAddress": { "addressLine1": "2709 NASSAU BND APT D2", "city": "coconut creek", "state": "Florida", "postalCode": "33066-2756", "countryCode": "US" }

What’s Changed: Deprecation of sellerCity, sellerState, and sellerPostalCode
Supported regions: NA
The following fields in the Seller object have been deprecated:

  • sellerCity in favor of city
  • sellerState in favor of state
  • sellerPostalCode in favor of postalCode

These deprecated fields will still be supported. However, partners should use the new fields in the sellerPrimaryAddress object to receive additional data.

What’s New: taxonomies now returns ECLASS codes
Supported regions: EU
The taxonomies object now returns ECLASS codes for applicable products. ECLASS codes enable accurate mapping of cost centers, streamlined approval workflows, and compliance measures during integrated search and direct ordering processes.

"taxonomies": [ { "taxonomyCode": "47121602", "title": "Vacuum cleaners", "type": "UNSPSC" }, { "taxonomyCode": "29160500", "title": "Floor care appliance (household)", "type": "ECLASS" } ],

What’s New: Support for multiple line items per quote
Supported regions: NA
Integrated Quoting now supports sending multiple line items in a single quote. Before this change, partners would have to submit a separate QuoteRequest for each line item. Now, when a QuoteRequest contains multiple line items, the resulting QuoteMessage also contains multiple line items.

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd"> <cXML xml:lang="en-US" payloadID="123-createRfq@sourcingModule.com" timestamp="2022-05-23T15:27:20-07:00"> <Header> <From> <Credential domain="NetworkId"> <Identity>SourcingModuleIdentity</Identity> </Credential> </From> <To> <Credential domain="NetworkId"> <Identity>AmazonBusinessIdentity</Identity> </Credential> </To> <Sender> <Credential domain="NetworkId"> <Identity>AmazonBuyer12345</Identity> <SharedSecret>randomSecurePassword</SharedSecret> </Credential> <UserAgent>Sourcing Module 1.0</UserAgent> </Sender> </Header> <Request> <QuoteRequest> <QuoteRequestHeader requestID=""requestDate="2022-05-23T15:27:21-07:00" type="new" openDate="2022-05-23T15:27:21-07:00" closeDate="2022-05-30T15:27:21-07:00" currency="USD" xml:lang="en-US" quoteReceivingPreference="winningOnly"> <Name xml:lang="EN">Name of the request</Name> <Description xml:lang="en-US"> Description of quote request </Description> <ShipTo> <Address isoCountryCode="US" addressID="159"> <Name xml:lang="en">Acme, INC.</Name> <PostalAddress name="default"> <DeliverTo>Buyer Name</DeliverTo> <Street>House Number</Street> <Street>Street</Street> <City>City</City> <State>State</State> <PostalCode>123456</PostalCode> <Country isoCountryCode="US">United States</Country> </PostalAddress> <Email name="default">buyer@acmeinc.com</Email> </Address> </ShipTo> <Extrinsic name="BuyerEmail">buyer@acmeinc.com</Extrinsic> <Extrinsic name="RequesterEmail">requester@acmeinc.com</Extrinsic> <Comments xml:lang="en-US">some comment which buyer wants to pass </Comments> </QuoteRequestHeader> <Extrinsic name="ExternalQuoteRequestID"> reqID-6634853691153124390 </Extrinsic> <QuoteItemOut quantity="1000" lineNumber="1" requestedDeliveryDate="2022-06-23T15:27:21-07:00" itemClassification="material"> <ItemID> <SupplierPartID>"Amazon Identified Asin"</SupplierPartID> </ItemID> <ItemDetail> <UnitPrice> <Money currency="USD">350.0</Money> </UnitPrice> <Description xml:lang="en">Digital cameras</Description> <UnitOfMeasure>EA</UnitOfMeasure> <Classification domain="unspsc">45121504</Classification> <ManufacturerPartID>ABN-23455634</ManufacturerPartID> <ManufacturerName>Nikon</ManufacturerName> </ItemDetail> </QuoteItemOut> <QuoteItemOut quantity="100" lineNumber="2" requestedDeliveryDate="2022-06-23T15:27:21-07:00" itemClassification="material"> <ItemID> <SupplierPartID>"Amazon Identified Asin"</SupplierPartID> </ItemID> <ItemDetail> <UnitPrice> <Money currency="USD">15.0</Money> </UnitPrice> <Description xml:lang="en">Office chairs</Description> <UnitOfMeasure>EA</UnitOfMeasure> <Classification domain="unspsc">45121504</Classification> <ManufacturerPartID>ABN-23455684</ManufacturerPartID> <ManufacturerName>Amazon Basics</ManufacturerName> </ItemDetail> </QuoteItemOut> </QuoteRequest> </Request> </cXML>
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.024/cXML.dtd"> <cXML payloadID="123-sendQuoteMessage@amazon.com" timestamp="2022-05-24T14:37:31-07:00"> <Header> <From> <Credential domain="NetworkId"> <Identity>AmazonBusinessIdentity</Identity> </Credential> </From> <To> <Credential domain="DOMAIN"> <Identity>SourcingModuleIdentity</Identity> </Credential> </To> <Sender> <Credential domain="NetworkId"> <Identity>AmazonBusinessIdentity</Identity> <SharedSecret>randomSecurePassword</SharedSecret> </Credential> <UserAgent>Amazon Business 1.0</UserAgent> </Sender> </Header> <Message> <QuoteMessage> <QuoteMessageHeader currency="USD" quoteDate="2022-05-23T15:27:21-07:00" quoteID="10000000000000000000003563" type="accept" xml:lang="en_US"> <OrganizationID> <Credential domain="NetworkID"> <Identity>AmazonBuyer12345</Identity> </Credential> </OrganizationID> <Total> <Money currency="USD">491003.6</Money> </Total> <QuoteRequestReference requestDate="2022-05-23T16:27:21-07:00" requestID="esi.iq.6634853691153124390" /> <Comments>Some comments</Comments> </QuoteMessageHeader> <Extrinsic name="ExternalQuoteRequestID">reqID-</Extrinsic> <Extrinsic name="quoteExpiryDate">2022-06-18T14:37:31-07:00</Extrinsic> <QuoteItemIn lineNumber="1" quantity="1000" requestedDeliveryDate="2022-06-23T14:37:31-07:00" type="accept" itemClassification="material"> <Extrinsic name="QuoteExpiryDate">2022-05-30T15:27:21-07:00</Extrinsic> <ItemID> <SupplierPartID>B07C2Z21X5</SupplierPartID> <SupplierPartAuxiliaryID>amzn.esi.qm.11111111-2222-3333-4444-abcdefg12345,2</SupplierPartAuxiliaryID> </ItemID> <ItemDetail> <UnitPrice> <Money currency="USD">477.00</Money> </UnitPrice> <Description xml:lang="en">Digital Cameras</Description> <UnitOfMeasure>Pack</UnitOfMeasure> <ManufacturerPartID /> <ManufacturerName>Amazon</ManufacturerName> </ItemDetail> <Shipping> <Money currency="USD">240.72</Money> <Description xml:lang="en_US" /> </Shipping> <Tax> <Money currency="USD">9540.44</Money> <Description xml:lang="en_US" /> </Tax> <Total> <Money currency="USD">486780.72</Money> </Total> </QuoteItemIn> <QuoteItemIn lineNumber="2" quantity="100" requestedDeliveryDate="2022-06-23T14:37:31-07:00" type="accept" itemClassification="material"> <Extrinsic name="QuoteExpiryDate">2022-05-30T15:27:21-07:00</Extrinsic> <ItemID> <SupplierPartID>B07B7K7N3P</SupplierPartID> <SupplierPartAuxiliaryID>amzn.esi.qm.11111111-2222-3333-4444-abcdefg12345,1</SupplierPartAuxiliaryID> </ItemID> <ItemDetail> <UnitPrice> <Money currency="USD">39.97</Money> </UnitPrice> <Description xml:lang="en">=Office Chair</Description> <UnitOfMeasure>Pack</UnitOfMeasure> <ManufacturerPartID /> <ManufacturerName>Amazon</ManufacturerName> </ItemDetail> <Shipping> <Money currency="USD">70.00</Money> <Description xml:lang="en_US" /> </Shipping> <Tax> <Money currency="USD">155.88</Money> <Description xml:lang="en_US" /> </Tax> <Total> <Money currency="USD">4222.88</Money> </Total> </QuoteItemIn> </QuoteMessage> </Message> </cXML>

May 2024

What’s changed: Support of PDF credit memo
Supported regions: EU, FE
Document API now supports download of PDF credit memo documents.

Previous releases:

Current releases: