Ordering API overview

What is Ordering API?

Amazon Business Ordering API allows you to automate your ordering process by integrating your purchasing system with Amazon Business. Your business customers will place orders in the Amazon Business marketplace without visiting Amazon Business or leaving your purchasing system. With Amazon Business Ordering API, your organization and business customers will save time, effort, and reduce repetitive work.

👍

Test this API in the Amazon Business API Explorer!

Benefits of Ordering API

Amazon Business Ordering API provides your organization and your business customers these benefits:

Synchronous order response

Ordering API enables synchronous order responses, improving the customer shopping experience. It eliminates the order response wait time that takes five minutes to couple of hours, resulting in order rejection at times.

Enhanced security

Ordering API uses OAuth 2.0 security protocol that is based on Login With Amazon (LWA). In this model, Amazon Business user account authorizes your application (app) by interacting with pages displayed by Amazon Business and your website. For more information on the OAuth workflow, see Third-party website authorization workflow.

Improved developer experience

Ordering API uses OpenAPI to define our contract. OpenAPI makes it easy for integrators to generate their client code for most programming languages by using readily available tools.

Order information, notifications, and updates

Ordering API helps your customers get order information, such as expected delivery date range, shipment tracking ID, and carrier name. This API also offers an optional subscription to Amazon Simple Notification Service (SNS). By subscribing to Amazon SNS, your customers will receive real-time order updates. Refer to What is Amazon SNS? for more information.

How Ordering API works

You can place orders and retrieve order status by calling Ordering API.

Operations

Ordering API provides two operations:

Placing an order with the Ordering API placeOrder operation requires the following details:

• a unique user-defined identifier
• line items to be included in the purchase order
• attributes containing properties that a customer would select during the ordering flow, such as the shipping address and payment method
• expectations about the order that the customer does not directly control, such as the unit price

After a successful placeOrder request, Ordering API attempts to fulfill the order given the product identifiers, expectations, and attributes present in the request. The way the order is fulfilled depends on the details provided in the request and the safeguards present in your Amazon Business account. For more information, see Safeguards.

Once an order is placed, you can call the orderDetails operation and provide the ID for your desired order to retrieve the order status. This status update includes details such as the order’s shipping status and expected delivery date.

Available regions

Ordering API is available in the following regions and marketplaces:

Polymorphism

Attributes and expectations in Ordering API are polymorphic. This means there are many specific subtypes of an attribute or expectation. When an attribute or expectation is required in a request, a specific subtype is selected in its place. The subtype's schema name must be passed as a discriminator to indicate which subtype it is. For example, a request to pass an order-level SelectedProductReference attribute would look like this:

{
  "externalId": "[oroder-12345]",
  "lineItems": [],
  "attributes": [
    {
      "attributeType": "SelectedProductReference",
      "productReference": {
        "productReferenceType": "ProductIdentifier",
        "id": "[asin]"
      }
    }
  ],
  "expectations": []
}

The attributeType property contains the exact, case-sensitive schema name of the subtype, SelectedProductReference. This is in addition to the actual contents of the attribute, which is the value of the productReference property.

The value of the productReference property is of type ProductReference, which is polymorphic, hence the productReferenceType discriminator property. The concrete subtype used is ProductIdentifier, which contains the product’s ASIN. It’s unacceptable to pass a value other than a defined subtype schema name in a discriminator property because it will result an error. It’s unacceptable to pass the supertype schema name in the attributeType discriminator property.

Safeguards

Product price and availability changes over time. Ordering API accommodates this variation by working in conjunction with order safeguards. Safeguards are constraints between the customer's expectations and Amazon Business order fulfillment. For example, you could define a safeguard so that if an item unit price increases by more than 20%, Ordering API rejects the line item.

If the safeguards are turned on, the constraints are evaluated against the customer's expectations and the Amazon Business order fulfillment. The API request will include a unit price expectation for each line item.

Here are the safeguards that get evaluated against expectations.

{
  "externalId": "[order-12345]",
  "lineItems": [
    {
      "externalId": "[line-item-1]",
      "quantity": 5,
      "attributes": [
        {
          "attributeType": "SelectedProductReference",
          "productReference": {
            "productReferenceType": "ProductIdentifier",
            "id": "[asin]"
          }
        }
      ],
      "expectations": [      
    {
     "expectationType": "ExpectedUnitPrice",
          "amount": { 
       "currencyCode": "USD",
            "amount": 10.00
          }
        }
      ]
    }
  ],
  "attributes": [],
  "expectations": []
}

In the example, the request is for five units of a single product with ASIN, [asin], with an expected price of $10.00 for each unit. The order-level attributes and expectations are omitted for simplicity. Ordering API will evaluate the request against actual offerings. If the price of the item doesn't exceed $12.00, Ordering API will place an order. That is 20% more than expected. If no offering is below $12.00, Ordering API rejects the line item but will continue to process other line items. If there are no other line items, Ordering API will reject the order.

{
  "externalId": "line-item-1",
  "acceptedItems": [],
  "rejectedItems": [
      {
          "quantity": 5,
          "artifacts": [
              {
                  "rejectionArtifactType": "RejectionGroup",
                  "supportingArtifacts": [
                      {
                          "rejectionArtifactType": "RejectionMessage",
                          "message": "Insufficient stock or no offer complies with your safeguards."
                      },
                      {
                          "rejectionArtifactType": "RejectionCode",
                          "code": "008-007"
                      }
                  ]
              },
              {
                  "rejectionArtifactType": "UnavailableQuantity",
                  "quantity": 5
              }
          ]
      }
  ]
}

Seller Substitutions

The Seller Substitutions safeguard allows you to get substitute items from other sellers when an item is unavailable. This safeguard can affect how Ordering API selects buying options (offers for an item on the Amazon Business catalog) to fulfill an order request.

Ordering API selects the buying option for an order line item based on a combination of the following details:

• The product in the request, identified by the ASIN in the SelectedProductReference attribute.
• The buying option in the request, identified by the offer ID in the SelectedBuyingOptionReference attribute.
• The configuration of the Seller Substitutions safeguard.

If a valid buying option is present in the request, Ordering API will perform the following actions:

1. Select as much quantity of this buying option as possible. Note that the constraints within the Seller Substitutions safeguard do not apply here.
2. If any quantity remains unfilled for the line item (either because Amazon didn’t have enough quantity available, or because the buying option reference was invalid) and Seller Substitutions are enabled, Ordering API will perform the following actions:
   1. Find substitute buying options based on the product reference in the request, filtered as specified in the Seller Substitutions safeguard.
   2. Fill the remaining quantity for the line item by selecting buying options in descending order of preference (typically, this is in ascending order of price; more generally, we try to maximize the quantity filled within the customer’s safeguard tolerances).
3. If any quantity remains unfilled after substitution, proceed according to the configuration of the Low stock and Item unavailable safeguards.

If a buying option reference is not present in the request or is invalid, Ordering API proceeds from Step 2 above.

Example 1:

The request contains a product reference [ASIN] and a valid buying option reference [Buying Option ID] that has 5 or more quantity available. The buying option has a price of $9.99, which is within the tolerances allowed by customer-configured unit price safeguards. This buying option is used to fill all the quantity in the request, yielding a subtotal of $49.95 (5 * $9.99).

{
    "externalId": "line-item-1",
    "quantity": 5,
    "attributes": [
        {
            "attributeType": "SelectedProductReference",
            "productReference": {
                "productReferenceType": "ProductIdentifier",
                "id": "[ASIN]"
            }
        },
        {
            "attributeType": "SelectedBuyingOptionReference",
            "buyingOptionReference": {
                "buyingOptionReferenceType": "BuyingOptionIdentifier",
                "id": "[Buying Option ID]"
            }
        }
    ]
}

{
    "externalId": "line-item-1",
    "acceptedItems": [
        {
            "quantity": 5,
            "artifacts": [
                {
                    "acceptanceArtifactType": "UnitPrice",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 9.99
                    }
                },
                {
                    "acceptanceArtifactType": "Charge",
                    "category": "SUBTOTAL",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 49.95
                    }
                }
            ]
        }
    ],
    "rejectedItems": []
}

Example 2:

The request contains a product reference [ASIN] and a valid buying option reference [Buying Option ID] that has only 3 quantity available. Seller Substitutions are enabled, so 2 remaining quantity is filled by the cheapest available marketplace offer, at a price of $10.99. This yields a subtotal of $51.95 (3 $9.99 + 2 $10.99).

{
    "externalId": "line-item-1",
    "quantity": 5,
    "attributes": [
        {
            "attributeType": "SelectedProductReference",
            "productReference": {
                "productReferenceType": "ProductIdentifier",
                "id": "[ASIN]"
            }
        },
        {
            "attributeType": "SelectedBuyingOptionReference",
            "buyingOptionReference": {
                "buyingOptionReferenceType": "BuyingOptionIdentifier",
                "id": "[Buying Option ID]"
            }
        }
    ]
}

{
    "externalId": "line-item-1",
    "acceptedItems": [
        {
            "quantity": 3,
            "artifacts": [
                {
                    "acceptanceArtifactType": "UnitPrice",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 9.99
                    }
                },
                {
                    "acceptanceArtifactType": "Charge",
                    "category": "SUBTOTAL",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 29.97
                    }
                }
            ]
        },
        {
            "quantity": 2,
            "artifacts": [
                {
                    "acceptanceArtifactType": "UnitPrice",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 10.99
                    }
                },
                {
                    "acceptanceArtifactType": "Charge",
                    "category": "SUBTOTAL",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 21.98
                    }
                }
            ]
        }
    ],
    "rejectedItems": []
}

Example 3:

The request contains a product reference [ASIN] and a valid buying option reference [Buying Option ID] that has only 3 quantity available. Seller Substitutions are disabled, so the 2 remaining quantity is rejected. This yields a subtotal of $29.97 (3 _ $9.99).
Note that which portion of the order is rejected may change based on the value of the Low stock and Item unavailable safeguards. It is possible for just the unfilled quantity, whole line item, or even the entire order to be rejected.

{
    "externalId": "line-item-1",
    "quantity": 5,
    "attributes": [
        {
            "attributeType": "SelectedProductReference",
            "productReference": {
                "productReferenceType": "ProductIdentifier",
                "id": "[ASIN]"
            }
        },
        {
            "attributeType": "SelectedBuyingOptionReference",
            "buyingOptionReference": {
                "buyingOptionReferenceType": "BuyingOptionIdentifier",
                "id": "[Buying Option ID]"
            }
        }
    ]
}

{
    "externalId": "line-item-1",
    "acceptedItems": [
        {
            "quantity": 3,
            "artifacts": [
                {
                    "acceptanceArtifactType": "UnitPrice",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 9.99
                    }
                },
                {
                    "acceptanceArtifactType": "Charge",
                    "category": "SUBTOTAL",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 29.97
                    }
                }
            ]
        }
    ],
    "rejectedItems": [
        {
            "quantity": 2,
            "artifacts": [
                {
                    "rejectionArtifactType": "RejectionGroup",
                    "supportingArtifacts": [
                        {
                            "rejectionArtifactType": "RejectionMessage",
                            "message": "Insufficient stock or no offer complies with your safeguards."
                        },
                        {
                            "rejectionArtifactType": "RejectionCode",
                            "code": "008-007"
                        }
                    ]
                },
                {
                    "rejectionArtifactType": "UnavailableQuantity",
                    "quantity": 2
                }
            ]
        }
    ]
}

Example 4:

The request contains a product reference [ASIN] and no buying option reference. Seller Substitutions are enabled, so all 5 quantity is filled using the cheapest available marketplace offers; the cheapest available offer has a price of $10.99, but only 4 quantity. The remaining single quantity is filled using the next available marketplace offer, at a price of $11.99. This yields a subtotal of $55.95 (4 $10.99 + 1 $11.99).

{
    "externalId": "line-item-1",
    "quantity": 5,
    "attributes": [
        {
            "attributeType": "SelectedProductReference",
            "productReference": {
                "productReferenceType": "ProductIdentifier",
                "id": "[ASIN]"
            }
        }
    ]
}

{
    "externalId": "line-item-1",
    "acceptedItems": [
        {
            "quantity": 4,
            "artifacts": [
                {
                    "acceptanceArtifactType": "UnitPrice",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 10.99
                    }
                },
                {
                    "acceptanceArtifactType": "Charge",
                    "category": "SUBTOTAL",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 43.96
                    }
                }
            ]
        },
        {
            "quantity": 1,
            "artifacts": [
                {
                    "acceptanceArtifactType": "UnitPrice",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 11.99
                    }
                },
                {
                    "acceptanceArtifactType": "Charge",
                    "category": "SUBTOTAL",
                    "amount": {
                        "currencyCode": "USD",
                        "amount": 11.99
                    }
                }
            ]
        }
    ],
    "rejectedItems": []
}

Example 5:

The request contains a product reference [ASIN] and no buying option reference. Seller Substitutions are disabled, leaving no source of buying options, so all 5 quantity is rejected.
Note that this may also result in the entire order being rejected, depending on the configuration of the Low stock and Item unavailable safeguards.

{
    "externalId": "line-item-1",
    "quantity": 5,
    "attributes": [
        {
            "attributeType": "SelectedProductReference",
            "productReference": {
                "productReferenceType": "ProductIdentifier",
                "id": "[ASIN]"
            }
        }
    ]
}

{
    "externalId": "line-item-1",
    "acceptedItems": [],
    "rejectedItems": [
        {
            "quantity": 5,
            "artifacts": [
                {
                    "rejectionArtifactType": "RejectionGroup",
                    "supportingArtifacts": [
                        {
                            "rejectionArtifactType": "RejectionMessage",
                            "message": "Insufficient stock or no offer complies with your safeguards."
                        },
                        {
                            "rejectionArtifactType": "RejectionCode",
                            "code": "008-007"
                        }
                    ]
                },
                {
                    "rejectionArtifactType": "UnavailableQuantity",
                    "quantity": 5
                }
            ]
        }
    ]
}

Result

An order is processed while containing a subset of the requested line items or the requested quantity for those line items. This means parts of the order get rejected. Ordering API will show which part of the order gets rejected with artifacts.

The Ordering API result will consist of:
• line items with accepted and rejected portions
• acceptance artifacts
• rejection artifacts

In the example, discussed in Safeguards section, a line item was rejected because of an item price constraint. But because there are other line items, Ordering API will continue to process the other line items in the request.

📘

In the Mexico region, orders placed via Ordering API will generate PDF Facturas electrónicas (CFDI) . These invoices will be accessible in the Your Orders screen. For more information, see Amazon Business Mexico support .

Complete fulfillment

Line items are broken up into accepted portions (quantity that is available), and rejected portions (quantity that isn’t available). The net quantity across all these items for a single line item will add to the originally requested quantity.

{
  "externalId": "[order-12345]",
  "lineItems": [
    {
      "externalId": "line-item-1",
      "quantity": 5,
      "attributes": [
        {
          "attributeType": "SelectedProductReference",
          "productReference": {
            "productReferenceType": "ProductIdentifier",
            "id": "[asin]"
          }
        }
      ]
    }

  ],
  "attributes": [],
  "expectations": []
}

This is a request for five units of a single product with ASIN, [asin]. The order-level attributes and expectations were omitted for simplicity. The response means all five units of the product are available.

{
  "lineItems": [
    {
      "externalId": "line-item-1",
      "acceptedItems": [
        {
          "quantity": 5,

          "artifacts": [
            {
              "acceptanceArtifactType": "Charge",
              "category": "SUBTOTAL",
              "type": "PRINCIPAL",
              "amount": {
                "currencyCode": "USD",
                "amount": 9.99
              }
            }
          ]
        }
      ],  
  "rejectedItems": []
    }
  ],
  "acceptanceArtifacts": [],
  "rejectionArtifacts": []
}

📘

The line item's externalId is the user-supplied value in the request line item. The items in the result are linked to the items in the request. There are no rejectedItems because all five units of this item are available.

Partial fulfillment

A customer has configured a safeguard to send what's available. Instead of rejecting the item or order, Ordering API will fulfill the item partially and reject the remaining quantity.

Sample: Three units of the item are available and met the customer's expectations.

{
  "lineItems": [
    {
      "externalId": "line-item-1",
      "acceptedItems": [
        {
          "quantity": 3,
          "artifacts": [
            {
              "acceptanceArtifactType": "Charge",
              "category": "SUBTOTAL",
              "type": "PRINCIPAL",
              "amount": {

                "currencyCode": "USD",
                "amount": 9.99
              }
            }
          ]
        }
  ],
      "rejectedItems": [
        {
          "quantity": 2,
          "artifacts": [
            {
              "rejectionArtifactType": "RejectionCode",

              "code": "008-008"
            },
            {
              "rejectionArtifactType": "RejectionMessage",
              "message": "Item is out of stock."
            }
          ]
        }
      ]
    }
  ],
  "acceptanceArtifacts": [],
  "rejectionArtifacts": []
}

The total quantity across the accepted and rejected items remains five, which matches the requested quantity.

Total rejection

A customer has configured a safeguard that removes the line item or rejects the order if the requested quantity isn’t available.

{
  "lineItems": [
    {
      "externalId": "line-item-1",
      "acceptedItems": [],
      "rejectedItems": [
        {
          "quantity": 3,
          "artifacts": [
            {
              "rejectionArtifactType": "AvailableQuantity",
              "quantity": 3
            }
          ]
        },
        {
          "quantity": 2,
          "artifacts": [
            {
              "rejectionArtifactType": "RejectionCode",
              "code": "008-008"
            },
            {
              "rejectionArtifactType": "RejectionMessage",           
          	"message": "Item is out of stock."
            }

          ]
        }
      ]

       }
  ],
  "acceptanceArtifacts": [],
  "rejectionArtifacts": []
}

In the example, the three units become part of rejected items. The rejected items indicate that the quantity was available but rejected due to other constraints. The total quantity across all items adds to five. The order-level artifacts are omitted for simplicity.

Getting started

There are two parts in the onboarding process. First, the developer partner onboarding. Second, the customer onboarding on the Ordering API.

Developer partner onboarding

Amazon Business will work with you in completing your onboarding. The process takes four to six weeks and it involves:

Step 1. Submit your developer profile request
Step 2. Create an app client in Solution Provider Portal
Step 3. Authorize your Amazon Business API apps
Step 4. Create your request

Step 5. Configure Amazon SNS
Step 6. Activate the SNS feature

After completing Step 5. Configure Amazon SNS, please contact your Amazon Business Customer Advisor and share your IAM Publish Role and SNS topic ARNs. The Amazon Business Customer Advisor will connect with the team who will activate the SNS feature, and sends you a status update:

{"externalRequestId":"external-order-id-12345"}

Step 7. Test your configuration
To test the configuration, use externalId as path parameter.

Path - GET /ordering/2022-10-30/orders/{externalId}
With ActualOrder: Path - GET /ordering/2022-10-30/orders/external-order-id-12345

GET /ordering/2022-10-30/orders/11-123456789 
{
"x-amz-user-email":"[[email protected]]"
}

{
        "lineItems": [
          {
            "externalId": "line-item-1",
            "acceptedItems": [
               {
                "quantity": 5,
                "artifacts": [
                {
                  "acceptanceArtifactType": "Charge", "category": "SUBTOTAL",
                  "type": "PRINCIPAL",
                  "amount": { 
                      "currencyCode": "USD",
                      "amount": 9.99
                     }
                    } 
                  ]
                } 
               ],
        "rejectedItems": []
          }
        ],
        "acceptanceArtifacts": [],
        "rejectionArtifacts": []
}

Customer onboarding

After completion of API integration, onboard your business customers to Amazon Business Ordering API. Ask your business customers to complete these steps:

Step 1. Create an Amazon Business account
Step 2. Create a group
Step 3. Configure the purchasing system and generate a unique group identifier
Step 4. Set up the purchasing preference
Step 5. Add a payment method
Step 6. Switch the setting of the purchasing system from test mode to active mode
Step 7. Add user to a group

Step 1. Create an Amazon Business account

Create an Amazon Business account for the desired Amazon Business store.

Step 2. Create a group

1. Sign in to your Amazon Business account. Navigate to Account Details > Business Settings. The Business setting displays.
2. Navigate to Members > Groups. Select Groups.

The group setting displays.

3. Select Add Group.

The Create Group displays.

4. In the Group name text box, enter the name of the group that is allowed to access your purchasing system.
   Sample group name: OrderingAPI_TestGroup

📘

In the future, if you decide to revoke the access permission for this group, select the box turn off purchasing for this group.

4. Select the applicable payment methods and shipping addresses for the group.

5. Select Add Group. The group is added to the list.

Step 3. Configure the purchasing system and generate a unique group identifier

1. Select the group name. In the example, the group name is OrderingAPI_TestGroup. The page for this group displays.
2. Navigate to System integrations > Configure purchasing system.

3. On the next screen, place your mouse cursor in the search box. The list of available purchasing systems displays. Select your purchasing system.

📘

The group identifier generated here is your BuyingGroup reference in the Ordering APIrequest.

If your purchasing system isn’t in the list, enter Ordering-API in the search box. Select Ordering API.
A screen detailing the unique group identifier displays. Select Save.

Step 4. Set up the purchasing preference

1. Navigate to System integrations > Configure purchasing system.
2. Navigate to Order safeguards. Select Edit.

The next screen provides option for setting how to handle order requests.

3. Select Edit to set the option for each safeguard.
4. Select Save.

Step 5. Add a payment method

Manage the checkout preferences by adding a payment method.

1. Navigate to Payment Method > Add a payment method.

2. Select Add payment method.

3. Select the applicable payment method: credit or debit cards, personal checking accounts, or business checking accounts.

Step 6. Switch the setting of the purchasing system from test mode to active mode

Once the setup and integration meets your expectations, switch the setting of the purchasing system from Test Mode to Active Mode:

1. Navigate to Systems Integration > Purchasing system.
2. Select Switch to Active mode.

🚧

After a group is turned to Active mode, all orders made using the group will be shipped and charged.

Step 7. Add user to a group

The Purchase Order will reach Amazon Business when there’s an assigned group and users in the purchasing system.

1. Select the group name.
   In the example, the group name is OrderingAPI_TestGroup. The page for this group displays.

2. Select Add people.
   The next screen will allow you add people for this group. You have these options: Invite by email, Upload a spreadsheet, or Share an invite link.

Invite by email

1. Enter the email address of the people who is allowed to access your purchasing system.
2. Select Buyer (requisitioner).
3. Select Invite people.

Upload a spreadsheet

1. Select this spreadsheet template.
2. Open the spreadsheet file and make changes.
3. Save the file in your local folder.
4. Select Browse and select the file to upload the spreadsheet.

The page displays the number of entries to process.

5. Select Upload the file.

Share an invite link

1. Select Copy this link.
2. Paste the link in the body of your email message.

Frequently asked questions

Q: Which region or country does Ordering APIsupports?
A: Ordering API supports all Amazon Business marketplace.

Q: What role to request for Ordering API?
A: The role to request for Ordering API is AmazonBusinessOrderPlacement.

Q: Is it required to add groups and users in my purchasing system before using the Ordering API?
A: Yes. The Purchase Order will reach Amazon Business when there’s an assigned group and users in the purchasing system.

Q: Do you have a sample response to share?
A: Yes. Here’s the sample response.

HTTP/1.1 200 OK
x-amzn-RequestId: ...
Content-Type: application/json
Content-Length: ...

{
  "lineItems": [
    {
      "externalId": "line-item-1",
      "acceptedItems": [
         {
          "quantity": 1,

          "artifacts": [
            {
              "acceptanceArtifactType": "DeliveryTimeRange",
              "lowerBoundary": "2023-01-01T08:00:00Z",
              "upperBoundary": "2023-01-02T07:59:59Z"
            },
            {
              "acceptanceArtifactType": "UnitPrice",
              "amount": {
                "currencyCode": "USD",
                "amount": 9.99
              }
            },
            {
              "acceptanceArtifactType": "Charge",
              "amount": {
                "currencyCode": "USD",
                "amount": 4.99
              },
              "category": "SHIPPING",
              "type": "PRINCIPAL"
            },
            {




              "acceptanceArtifactType": "Charge",
              "amount": {
                "currencyCode": "USD",
                "amount": 9.99
              },
              "category": "SUBTOTAL",
              "type": "PRINCIPAL"
            },
            {
              "acceptanceArtifactType": "OrderIdentifier",
              "identifier": "000-1111111-2222222"
            }
          ]
        }
      ],    
 "rejectedItems": []
    }
  ],
  "acceptanceArtifacts": [
    {
      "acceptanceArtifactType": "Charge",
      "amount": {
        "currencyCode": "USD",
        "amount": 4.99
      },
      "category": "SHIPPING",
      "type": "PRINCIPAL"
    },
    {
      "acceptanceArtifactType": "Charge",

      "amount": {
        "currencyCode": "USD",
        "amount": 9.99
    },
      "category": "SUBTOTAL",
      "type": "PRINCIPAL"
    },
    {
      "acceptanceArtifactType": "Signed"
    }
  ],
  "rejectionArtifacts": []
}

Q: Does Ordering API return an error response for unsuccessful request?
A: Yes. If the request is unsuccessful, Ordering API returns an error response.

HTTP/1.1 400 Bad Request
x-amzn-RequestId: ...
Content-Type: application/json
Content-Length: ...

{
  "errors": [
    {
      "code": "INVALID_REQUEST_PARAMETER",
      "message": "The following required request parameter is missing: lineItems",
      "details": ""

    }
  ]
}

HTTP/1.1 403 Forbidden
x-amzn-RequestId: ...
Content-Type: application/json
Content-Length: ...

{
  "errors": [
    {
      "message": "The security token included in the request is invalid.",
      "code": "InvalidInput"
    }
  ]
} 

Q: What features/functionalities are currently not supported with Ordering API?
A: The following features are not currently supported:

For information about Punchout Ordering, see Punchout - Purchasing System Integration. For information about cXML Direct Ordering, contact your Amazon Business customer advisor.

Appendices

Appendix 1: Amazon Business endpoints, store URLs, and store IDs

Amazon Business endpoints

Amazon Business store URLs

Amazon Business store IDs

Appendix 2: Ordering API model and reference

Refer to Ordering API v1 model and Ordering API v1 reference.

Appendix 3: Ordering API rejection codes

Ordering API follows standard HTTP status codes. Generally, the API returns HTTP 400 status code for any missing inputs. If the API input is valid but the order cannot be fulfilled due to service issues or business logic reasons, then rejection codes are provided with HTTP 200 status code.

Below are the rejection codes provided with an HTTP 200 status code in response.

Appendix 4: Multi-legal entity support

You can configure Ordering API for multi-legal entities (MLE). For more information, see How to configure Ordering API for multi-legal entities.