Release Notes

What's new with Amazon Business API

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

Get updates. Subscribe to our RSS feed.

December 2022

What’s new: VCS Lite invoice download
Supported region: EU

Document API now provides the downloadable link for VAT Calculation Service (VCS) Lite invoices. VCS Lite is an extension of VCS provided to sellers in EU region.

What’s changed: Document API now supports Amazon Business JP store
Supported region: FE

Document API now supports the Amazon Business JP store in FE region. Before this release, the Document API only supports the EU region. The Document API allows Amazon Business customers to retrieve and manage reports. It also lets customers tie transactions back to invoice documents.

What's new: Product description
Supported region: NA, EU, and FE

We added a product description field in Product Search API. This new field displays general information about the product item.

"productDescription":"The world's smartest cleaning robots just got smarter. The robot vacuum is thoughtfully designed with you and your specific needs in mind."

What's fixed: Guided buying policy
Supported region: NA, EU, and FE

We fixed the issue related to guided buying (GB) policy for Integrated Search users. This allows parity with Punchout shopping experience. Before this release, the guided buying policy is applicable only to the user with admin or requisitioner role; or if the user has associated Punchout session. By fixing this bug, the GB policy now applies to all roles at organization level.

````
 "buyingGuidance": "PREFERRED" 
 ````

What's changed: Page number limit
Supported region: NA, EU, and FE

Product Search API sets a page number limit of up to 13 for each request. This prevents request failure if the requested page number exceeds the limit.

"request": {
  "parameters": {
    "productId": {
      "value": "B07VDJ5RVF"
    },
    "locale": {
      "value": "es_US"
    },
    "facets": {
      "value": [
        "OFFERS"
      ]
    },
    "pageNumber": {
      "value": "13"
    }
  }
},
"response": {
  "matchingProductCount": 1,
  "numberOfPages" : 1,
  "refinements": {
    "categories": [],
    "subCategories": [],
    "availabilityOptions": [],
    "deliveryDayOptions": [],
    "eligibleForFreeShippingOptions": [],
    "primeEligible": []
  },
  "products": [
    {
      "includedDataTypes": {
        "OFFERS": []
         }
  }
    ]
}

What’s changed: Descriptions for enum values
Supported region: NA, EU, and FE

We added descriptions for enum values to provide clarity on what each enum value means.

September 2022

What’s fixed: invoicePDF
Supported Region: EU

We changed how the Document API behaves when retrieving invoices for a given orderId and orderLineItemId combination.

Previously, Document API takes orderId and orderLineItemId as input and retrieve invoices associated with the first shipmentId. When there are multiple shipments for a given orderId and orderLineItemId, Document API responded with invoice documents associated with the first shipmentId.

By taking shipmentId as an input, Document API now returns the relevant invoices associated with the given shipmentId.

{
 "reportOptions": {
 "orderLineItemId": "9999999999",
 "orderId": "111-111-1111111111111",
 "shipmentId": "DfsA23Vs"
 },
 "reportType": "GET_AB_INVOICE_PDF",
 "marketplaceIds": ["ATVPDKIKX0DER"," A1F83G8C2ARO7P"]
}

What’s changed: Onboarding process for Product Search API
Supported Region: NA, EU, and FE

Since September 13, 2022, Amazon Business Product Search API role is available online through Developer Central. This allows developer partners to create profile account on Developer Central. The offline Developer Request Access Form (DRAF) submission is no longer applicable.

What’s fixed: totalFeedbackCount and meanFeedbackRating
Supported Region: NA, EU, FE

We added totalFeedbackCount and meanFeedbackRating in merchant object. This allows customers to retrieve the mean feedback ratings of the merchant and the total Feedback Count for the selling merchant on Amazon Business. By default, these fields are inactive. We activate these fields by request.

{
“merchant” : {
“merchantId” : qwerty,
“name” : ping,
meanFeedbackRating“ : 5.0,
totalFeedbackCount“ : 48
}
}

What’s new: marketplaceId, invoiceNumber, and invoiceDate
Supported Region: NA, EU, and FE

  1. We added marketplaceId at transactions level to identify the marketplace where the item was purchased. Passing the marketplaceId in the transactions help business customers match the marketplace they want connection to.
"transactions": [
  {
    "marketplaceId": "ATVPDKIKX0DER",
        
  }
 ]
  1. A new API in Amazon Business that returns invoiceNumber for the given order line item information. This allows customers to tie transactions back to Invoice PDFs. Order line item includes:
  • OrderId: The Amazon Business order identifier associated with the item.
  • OrderLineItemId: The Amazon Business order line item identifier for the item.
  • ShipmentId: The Amazon Business identifier for the shipment associated with the item.
{
"orderLineItems": [
{
"orderId": "111-111-1111111111111",
"orderLineItemId": "9999999999",
"shipmentId": "DfsA23Vs"
}
]
}
{
      "invoiceDetailsByOrderLineItems": [{
        "orderLineItem": {
          "orderId": "111-111-1111111111111",
          "orderLineItemId": "9999999999",
          "shipmentId": "DfsA23Vs"
        },
        "invoiceDetails": [{
          "invoiceNumber": "HHHH-1234",
        }]
      }]
    }
  }
  1. A new API in Amazon Business that returns invoiceDate with corresponding invoiceNumber for the given order line items. This allows customers to tie transactions back to Invoice PDFs. The invoiceDate format is YYYY/MM/DD HH:MM:SS. Timezone is UTC.
"orderLineItems": [
  {
    "orderId": "111-111-1111111111111",    
    "orderLineItemId": "9999999999",    
    "shipmentId": "DfsA23Vs"  
  }
]
{
      "invoiceDetailsByOrderLineItems": [{
        "orderLineItem": {
          "orderId": "111-111-1111111111111",
          "orderLineItemId": "9999999999",
          "shipmentId": "DfsA23Vs"
        },
        "invoiceDetails": [{
          "invoiceNumber": "HHHH-1234",
          "invoiceDate": "2022-09-01T00:00:00Z"
        }]
      }]
    }

What’s new: BusinessOrderInfo, transactionIds, and carrierTrackingNumbers
Supported Region: NA, EU, and FE

  1. We added BusinessOrderInfo in the order response. This allows customers to retrieve the business order information provided during procurement. The API response includes this information.
  • customField: A non-labelled field that lets buyers specify additional information while placing an order.
  • glCode: A unique general ledge (lg) code assigned to the order.
  • projectCode: A unique project code assigned to the order.
  • costCenter: A business unit where the expense for the order is allocated.
  • location: The location for which the related order was placed.
  • department: The department associated with the order.

Customers now able to see the fields and values in the reporting API response. This includes orders placed prior to this release.

"businessOrderInfo": {
                "CustomField1": "PC_HRD_01",
                "GL code": "13007",
                "Project code": "PC_2022",
                "Cost center": "CC_1212",
                "Location": "Dallas",
                "department": "DD_1212" 
            }
  1. We added transactionId in lineItems object to provide transaction identifier for specific ASIN. This provides an array of all applicable transactionId associated with the item.
"transactionIds": [
    "XRQttSzQFcgzke32onOR"
    ],
  1. We added carrierTrackingNumbers in lineItems object to provide carrier tracking identifier for specific ASIN. This provides an array of all applicable carrierTrackingNumbers associated with the item.
"carrierTrackingNumbers": [
    "272686024037"
    ]

August 2022

What’s new: shippingRegion as an optional query parameter
Supported Region: NA, EU, and FE

We added an optional query parameter to determine the shippingRegion in our Product Search API. Buyers have an option to provide a shippingPostalCode for the shippingRegion. The value in the shippingPostalCode determines the shippingRegion for the product. The shippingRegion can take in ISO_3166-1_alpha-2 code for any country.

Prior to this release, when a buyer wants to ship a product outside the productRegion, the API request returns a failed response. With the optional query parameter, the API request returns search results based on the value in the shippingPostalCode.

📘

Note: shippingPostalCode and shippingRegion must belong to the same country.

To get a valid API response, shippingPostalCode and shippingRegion must belong to the same country. If the shippingRegion is blank, API returns search results based on productRegion.

products/2020-08-26/products/B0056QT2Z2?productRegion=US&shippingRegion=AU&locale=en_US&requestId=1234&legalEntityId=A8FFE1G5W2E7T&customerId=ASI4P9TV3BVKP&facets=OFFERS&category=BOOKS&pageSize=2&shippingPostalCode=11000

July 2022

What’s new: featuredOffer object
Supported Regions: NA, EU, and FE

SearchOffersRequest operation now returns all offers associated with the item including Amazon’s buybox winner as featuredOffer. Prior to this release, the searchOffersRequest returned all offers for an ASIN except the buybox winner. The overall list includes the featured offer and all other offers with the same ASIN. The featured offer is on top of the list.

"featuredOffer": {

 "availability": "In Stock.",
 "buyingGuidance": "NONE",
 "buyingRestrictions": [],
 "fulfillmentType": "MERCHANT_FULFILLMENT",
 "merchant": {
 "merchantId": null,
 "name": null,
 "meanFeedbackRating": null,
 "totalFeedbackCount": null
 },
 "offerId": "Hx2p5GRGzpmpfj49zJdrF78xDY0BnOhFOUOa7wZeNiqm%2BflVni%2F0OL9NlUecUVGOPj1YDtEzatcoZ0OchKvuIL%2Bv17qCY%2B1nI%3D",
 "price": {
 "value": {
 "amount": 7.18,
 "currencyCode": "USD"
 },
 "formattedPrice": null,
 "priceType": "NEW"
 },
 "listPrice": {
 "value": {
 "amount": 15.84,
 "currencyCode": "USD"
 },
 "formattedPrice": null,
 "priceType": "LIST_PRICE"
 },
 "productCondition": "NEW",
 "productConditionNote": "",
 "condition": {
 "conditionValue": "NEW",
 "conditionNote": "",
 "subCondition": "UNKNOWN"
 },
 "quantityLimits": {
 "maxQuantity": 30,
 "minQuantity": 1
 },
 "quantityPrice": {
 "quantityPriceTiers": []
 },
 "taxExclusivePrice": {
 "taxExclusiveAmount": null,
 "displayString": "",
 "formattedPrice": "",
 "label": ""
 },
 "deliveryInformation": "FREE delivery Tomorrow, July 30. Order within 5 hrs 52 mins"
 }

What’s new: seller object and deliveryInformation object
Supported Regions: NA, EU, and FE

  1. We added seller object in lineItems object, which includes the following fields:
  • sellerName: Name of the selling merchant.
  • sellerCity: City of the selling merchant.
  • sellerState: State of the selling merchant.
  • sellerPostalCode: Postal code of the selling merchant.
"seller": {
    "sellerName": "XYZ, Inc.",
    "sellerCity": "Livermore",
    "sellerState": "CA",
    "sellerPostalCode": "94551"
 }
  1. We added deliveryInformation object in shipments object, which includes: expectedDeliveryDate and deliveryStatus.

    • expectedDeliveryDate: The expected delivery date of the shipment. The format is YYYY/MM/DD HH:MM:SS. Timezone is UTC.

    • deliveryStatus: The current delivery status of the shipment. Valid response values include DELIVERED, NOT_DELIVERED and NOT_AVAILABLE

"deliveryInformation": {
    "expectedDeliveryDate": "2022-05-10T06:59:59Z",
    "deliveryStatus": "DELIVERED"
 },