Reconciliation API static sandbox guide
The Reconciliation API supports the Amazon Business API static sandbox. The static sandbox uses pattern matching to return static, mocked responses.
You can use the sandbox environment to securely test your integration with the Reconciliation API before moving to production. By sending requests to the sandbox endpoints instead of production endpoints, you can test standard workflows without triggering real-world events.
Prerequisites
Before calling the Reconciliation API static sandbox, complete the steps in Accessing the Amazon Business API sandbox environment to create a sandbox app and generate a sandbox API access token.
Once you’ve generated the access token, direct each sandbox call to the appropriate Amazon Business API sandbox endpoint for your region.
Sandbox scenarios
Use the following sample requests to test the success and error scenarios in the Reconciliation API static sandbox. If you use input parameters other than the sample values below, an error will occur.
Path: GET /reconciliation/2021-01-08/transactions
Scenario: Calling Reconciliation API sandbox getTransactions operation to return a list of business transactions between feedStartDate of 2020-07-09T00:00:00Z and feedEndDate of 2020-08-01T00:00:00Z:
GET https://sandbox.na.business-api.amazon.com/reconciliation/2021-01-08/transactions?feedStartDate=2020-07-09T00:00:00Z&feedEndDate=2020-08-01T00:00:00Z
Response: A successful request returns a 200 response code with a transactions object containing details about one transaction in the response body.
Status code: 200 OK
{
"transactions": [
{
"marketplaceId": "ATVPDKIKX0DER",
"transactionDate": "2020-04-03T16:59:18.768Z",
"feedDate": "2021-05-12T20:44:21.791Z",
"transactionType": "CHARGE",
"transactionId": "1x47pVc03Ffs71cjjCct",
"chargeIdentifier":"RA5RE0N60",
"shipTaxRate": "0.00",
"giftWrapTaxRate": "0.00",
"legalEntityName": "May ProdInv",
"invoiceNumber": "JP218PV8HMOI",
"amount": {
"currencyCode": "USD",
"amount": "5.99"
},
"paymentInstrumentType": "PayStation",
"buyer": {
"id": "amzn1.account.3KXYF4ES2JQB4XSQ3WJXEMTUNF2GINLRMZYGCNTDNB2TGN32NFQR3RAADVPCS56Y226EN5QTGEQSLWPB3G5573CD7JWWZJ3CAXWP53A",
"name": "jared",
"email": "[email protected]"
},
"payer": {
"id": "amzn1.account.3KXYF4ES2JQB4XSQ3WJXEMTUNF2GINLRMZYGCNTDNB2TGN32NFQR3RAADVPCS56Y226EN5QTGEQSLWPB3G5573CD7JWWZJ3CAXWP53A",
"name": "jared",
"email": "[email protected]"
},
"associatedTransactionDetails": [
{
"associatedTransactionId": "ONf39R7NmjIh9247YJ34"
}
],
"transactionLineItems": [
{
"totalAmount": {
"currencyCode": "USD",
"amount": "5.99"
},
"principalAmount": {
"currencyCode": "USD",
"amount": "5.99"
},
"shippingCharge": {
"currencyCode": "USD",
"amount": "2.99"
},
"discount": {
"currencyCode": "USD",
"amount": "-2.99"
},
"tax": {
"currencyCode": "USD",
"amount": "0.0"
},
"taxRate": "0.00",
"orderId": "114-1458190-2465828",
"unspsc": "44121700",
"orderLineItemId": "31208275451321",
"purchaseOrderNumber": "",
"asin": "B07T8K1HJG",
"productTitle": "Ticonderoga Neon Pencils, #2 Pre-Sharpened Wood Pencils with Erasers, 18-Count, 13018",
"itemQuantity": 1,
"shipmentId": "DhG3L9W23",
"shipmentDate": "2020-04-03T16:59:21Z",
"merchantLegalName": "Amazon.com Services LLC",
"businessOrderInfo": {
"GL code": "535-office",
"COVID-19 Related?": "No",
"Cost center": ""
}
}
]
}
]
}
Scenario: Calling Reconciliation API sandbox getTransactions operation to return a list of business transactions within an invalid date range:
GET https://sandbox.na.business-api.amazon.com/reconciliation/2021-01-08/transactions?feedStartDate=incorrectFormatDate&feedEndDate=2020-08-01T00:00:00
Response: This scenario returns a 400 status code with an “[incorrectFormatDate]” error message.
Response code: 400 Bad Request
{
"errors": [
{
"code": "INVALID_REQUEST_PARAMETER",
"message": "Input date [incorrectFormatDate] is not in the expected ISO8601 format.",
"details": ""
}
]
}
Path: POST /reconciliation/2021-01-08/invoices
Scenario: Calling Reconciliation API sandbox getInvoiceDetailsByOrderLineItems operation to get invoice data for order line items identified with valid order, line item, and shipment identifiers:
POST https://sandbox.na.business-api.amazon.com/reconciliation/2021-01-08/invoices
{
"orderLineItems": [
{
"orderId": "503-0807783-5846230",
"orderLineItemId": "6172301145805",
"shipmentId": "Dps13nXXc"
},
{
"orderId": "250-9059274-9386231",
"orderLineItemId": "6172160940605",
"shipmentId": "DZms0yvhc"
}
]
}
Response: A successful request returns a 200 response code with invoice details for two order line items.
Response code: 200 OK
{
"invoiceDetailsByOrderLineItems": [
{
"orderLineItem": {
"orderId": "250-9059274-9386231",
"orderLineItemId": "6172160940605",
"shipmentId": "DZms0yvhc"
},
"invoiceDetails": [
{
"invoiceNumber": "JP218PV8HMOI",
"invoiceDate": "2022-03-30T15:30:22.077Z",
"consolidatedInvoiceDetails": {
"invoiceNumber": "11XS-123S-XFA1"
},
"invoiceType": "STANDARD",
"associatedInvoiceNumber": null,
"associatedInvoiceDate": null,
"invoiceIssuer": {
"name": "Mizuta",
"registrationNumber": null
},
"billToAddress": {
"fullName": "test return",
"phoneNumber": "81120899543",
"companyName": null,
"addressLine1": "Arco Tower Annex, 1 Chome-8-1 Shimomeguro, Meguro City, Toky",
"addressLine2": null,
"city": null,
"stateOrRegion": "Yamanashi-ken",
"postalCode": "153-0064",
"countryCode": "JP"
},
"sellerInformation": {
"name": "Mizuta",
"registrationNumber": null
},
"orderDate": "2022-03-29T18:46:51Z",
"currencyCode": "JPY",
"invoiceTotal": "1751.0",
"tax": [],
"transactionDataItems": [
{
"taxRate": "0.1",
"unit": 1,
"asin": "4863893469",
"title": "ハリー・ポッターと呪いの子 第一部、第二部 特別リハーサル版 (ハリー・ポッターシリーズ)",
"unitTaxInclusivePrice": {
"currencyCode": "",
"amount": "0"
},
"unitTaxExclusivePrice": {
"currencyCode": "",
"amount": "0"
},
"unitTaxAmount": {
"currencyCode": "JPY",
"amount": "159.0"
},
"totalAmount": {
"currencyCode": "JPY",
"amount": "1751.0"
},
"discount": null,
"apportionment": [],
"fees": []
}
],
"fees": [
{
"feeType": "SHIPPING",
"tax": {
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "61.0"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "61.0"
},
"amount": {
"currencyCode": "JPY",
"amount": "0.0"
}
},
"discount": {
"currencyCode": "JPY",
"amount": "-61.0"
},
"apportionment": []
}
]
},
{
"invoiceNumber": "JP22E0VEIAJGKI",
"invoiceDate": "2022-03-30T15:30:22.077Z",
"invoiceType": "STANDARD",
"associatedInvoiceNumber": null,
"associatedInvoiceDate": null,
"invoiceIssuer": {
"name": "アマゾンジャパン合同会社",
"registrationNumber": null
},
"billToAddress": {
"fullName": "test return",
"phoneNumber": "81120899543",
"companyName": null,
"addressLine1": "Arco Tower Annex, 1 Chome-8-1 Shimomeguro, Meguro City, Toky",
"addressLine2": null,
"city": null,
"stateOrRegion": "Yamanashi-ken",
"postalCode": "153-0064",
"countryCode": "JP"
},
"sellerInformation": {
"name": "アマゾンジャパン合同会社",
"registrationNumber": null
},
"orderDate": "2022-03-29T18:46:51Z",
"currencyCode": "JPY",
"invoiceTotal": "3267.0",
"tax": [],
"transactionDataItems": [
{
"taxRate": "0.1",
"unit": 5,
"asin": "B09DXP8C3Q",
"title": "ショウワノート PUIPUIモルカー 文具パック 942865M02",
"unitTaxInclusivePrice": {
"currencyCode": "",
"amount": "0"
},
"unitTaxExclusivePrice": {
"currencyCode": "",
"amount": "0"
},
"unitTaxAmount": {
"currencyCode": "JPY",
"amount": "99.0"
},
"totalAmount": {
"currencyCode": "JPY",
"amount": "3267.0"
},
"discount": null,
"apportionment": [],
"fees": []
}
],
"fees": [
{
"feeType": "SHIPPING",
"tax": {
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "182.0"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "182.0"
},
"amount": {
"currencyCode": "JPY",
"amount": "0.0"
}
},
"discount": {
"currencyCode": "JPY",
"amount": "-182.0"
},
"apportionment": []
}
]
},
{
"invoiceNumber": "JP21UV8HMOC",
"invoiceDate": "2022-04-09T04:52:05.942Z",
"invoiceType": "CREDIT_MEMO",
"associatedInvoiceNumber": "JP218PV8HMOI",
"associatedInvoiceDate": "2022-03-30T15:30:22.077Z",
"invoiceIssuer": {
"name": "Mizuta",
"registrationNumber": null
},
"billToAddress": {
"fullName": "test return",
"phoneNumber": "81120899543",
"companyName": null,
"addressLine1": "Arco Tower Annex, 1 Chome-8-1 Shimomeguro, Meguro City, Toky",
"addressLine2": null,
"city": null,
"stateOrRegion": "Yamanashi-ken",
"postalCode": "153-0064",
"countryCode": "JP"
},
"sellerInformation": {
"name": "Mizuta",
"registrationNumber": null
},
"orderDate": "2022-03-29T18:46:51Z",
"currencyCode": "JPY",
"invoiceTotal": "1751.00",
"tax": [
{
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "1751.0"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "1592.0"
},
"amount": {
"currencyCode": "JPY",
"amount": "159.0"
}
}
],
"transactionDataItems": [
{
"taxRate": "0.1",
"unit": 1,
"asin": "4863893469",
"title": "ハリー・ポッターと呪いの子 第一部、第二部 特別リハーサル版 (ハリー・ポッターシリーズ)",
"unitTaxInclusivePrice": {
"currencyCode": "",
"amount": "0"
},
"unitTaxExclusivePrice": {
"currencyCode": "",
"amount": "0"
},
"unitTaxAmount": {
"currencyCode": "JPY",
"amount": "159.0"
},
"totalAmount": {
"currencyCode": "JPY",
"amount": "1818.00"
},
"discount": null,
"apportionment": [
{
"orderLineItemId": "6172160940605",
"lineNumber": 1,
"units": 1,
"unitPrice": {
"currencyCode": "JPY",
"amount": "1592.0"
},
"taxAmount": {
"currencyCode": "JPY",
"amount": "159.0"
}
}
],
"fees": []
}
],
"fees": [
{
"feeType": "SHIPPING",
"tax": {
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "73.00"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "61.00"
},
"amount": {
"currencyCode": "JPY",
"amount": "12.00"
}
},
"discount": {
"currencyCode": "JPY",
"amount": "-67.00"
},
"apportionment": [
{
"taxExclusiveFee": {
"currencyCode": "JPY",
"amount": "61.0"
},
"taxAmount": {
"currencyCode": "JPY",
"amount": "6.0"
}
}
]
}
]
},
{
"invoiceNumber": "JP2SRUXAJGKC",
"invoiceDate": "2022-04-09T04:52:05.942Z",
"invoiceType": "CREDIT_MEMO",
"associatedInvoiceNumber": "JP22E0VEIAJGKI",
"associatedInvoiceDate": "2022-03-30T15:30:22.077Z",
"invoiceIssuer": {
"name": "アマゾンジャパン合同会社",
"registrationNumber": null
},
"billToAddress": {
"fullName": "test return",
"phoneNumber": "81120899543",
"companyName": null,
"addressLine1": "Arco Tower Annex, 1 Chome-8-1 Shimomeguro, Meguro City, Toky",
"addressLine2": null,
"city": null,
"stateOrRegion": "Yamanashi-ken",
"postalCode": "153-0064",
"countryCode": "JP"
},
"sellerInformation": {
"name": "アマゾンジャパン合同会社",
"registrationNumber": null
},
"orderDate": "2022-03-29T18:46:51Z",
"currencyCode": "JPY",
"invoiceTotal": "2178.00",
"tax": [
{
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "2178.0"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "1980.0"
},
"amount": {
"currencyCode": "JPY",
"amount": "198.0"
}
}
],
"transactionDataItems": [
{
"taxRate": "0.1",
"unit": 2,
"asin": "B09DXP8C3Q",
"title": "ショウワノート PUIPUIモルカー 文具パック 942865M02",
"unitTaxInclusivePrice": {
"currencyCode": "",
"amount": "0"
},
"unitTaxExclusivePrice": {
"currencyCode": "",
"amount": "0"
},
"unitTaxAmount": {
"currencyCode": "JPY",
"amount": "99.0"
},
"totalAmount": {
"currencyCode": "JPY",
"amount": "2311.00"
},
"discount": null,
"apportionment": [
{
"orderLineItemId": "6172160940645",
"lineNumber": 1,
"units": 2,
"unitPrice": {
"currencyCode": "JPY",
"amount": "990.0"
},
"taxAmount": {
"currencyCode": "JPY",
"amount": "99.0"
}
}
],
"fees": []
}
],
"fees": [
{
"feeType": "SHIPPING",
"tax": {
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "145.00"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "121.00"
},
"amount": {
"currencyCode": "JPY",
"amount": "24.00"
}
},
"discount": {
"currencyCode": "JPY",
"amount": "-133.00"
},
"apportionment": [
{
"taxExclusiveFee": {
"currencyCode": "JPY",
"amount": "121.0"
},
"taxAmount": {
"currencyCode": "JPY",
"amount": "12.0"
}
}
]
}
]
},
{
"invoiceNumber": "JP2SPSMAJGKC",
"invoiceDate": "2022-04-09T01:43:15.233Z",
"invoiceType": "CREDIT_MEMO",
"associatedInvoiceNumber": "JP22E0VEIAJGKI",
"associatedInvoiceDate": "2022-03-30T15:30:22.077Z",
"invoiceIssuer": {
"name": "アマゾンジャパン合同会社",
"registrationNumber": null
},
"billToAddress": {
"fullName": "test return",
"phoneNumber": "81120899543",
"companyName": null,
"addressLine1": "Arco Tower Annex, 1 Chome-8-1 Shimomeguro, Meguro City, Toky",
"addressLine2": null,
"city": null,
"stateOrRegion": "Yamanashi-ken",
"postalCode": "153-0064",
"countryCode": "JP"
},
"sellerInformation": {
"name": "アマゾンジャパン合同会社",
"registrationNumber": null
},
"orderDate": "2022-03-29T18:46:51Z",
"currencyCode": "JPY",
"invoiceTotal": "1089.00",
"tax": [
{
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "1089.0"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "990.0"
},
"amount": {
"currencyCode": "JPY",
"amount": "99.0"
}
}
],
"transactionDataItems": [
{
"taxRate": "0.1",
"unit": 1,
"asin": "B09DXP8C3Q",
"title": "ショウワノート PUIPUIモルカー 文具パック 942865M02",
"unitTaxInclusivePrice": {
"currencyCode": "",
"amount": "0"
},
"unitTaxExclusivePrice": {
"currencyCode": "",
"amount": "0"
},
"unitTaxAmount": {
"currencyCode": "JPY",
"amount": "99.0"
},
"totalAmount": {
"currencyCode": "JPY",
"amount": "1156.00"
},
"discount": null,
"apportionment": [
{
"orderLineItemId": "6172160940645",
"lineNumber": 1,
"units": 1,
"unitPrice": {
"currencyCode": "JPY",
"amount": "990.0"
},
"taxAmount": {
"currencyCode": "JPY",
"amount": "99.0"
}
}
],
"fees": []
}
],
"fees": [
{
"feeType": "SHIPPING",
"tax": {
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "73.00"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "61.00"
},
"amount": {
"currencyCode": "JPY",
"amount": "12.00"
}
},
"discount": {
"currencyCode": "JPY",
"amount": "-67.00"
},
"apportionment": [
{
"taxExclusiveFee": {
"currencyCode": "JPY",
"amount": "61.0"
},
"taxAmount": {
"currencyCode": "JPY",
"amount": "6.0"
}
}
]
}
]
}
]
},
{
"orderLineItem": {
"orderId": "503-0807783-5846230",
"orderLineItemId": "6172301145805",
"shipmentId": "Dps13nXXc"
},
"invoiceDetails": [
{
"invoiceNumber": "JP25EF9G0FUI",
"invoiceDate": "2022-04-01T08:48:53.158Z",
"invoiceType": "STANDARD",
"associatedInvoiceNumber": null,
"associatedInvoiceDate": null,
"invoiceIssuer": {
"name": "Shenzhen Sepo Supply Chain Co., LTD",
"registrationNumber": null
},
"billToAddress": {
"fullName": "test return",
"phoneNumber": "81120899543",
"companyName": null,
"addressLine1": "Arco Tower Annex, 1 Chome-8-1 Shimomeguro, Meguro City, Toky",
"addressLine2": null,
"city": null,
"stateOrRegion": "Yamanashi-ken",
"postalCode": "153-0064",
"countryCode": "JP"
},
"sellerInformation": {
"name": "Shenzhen Sepo Supply Chain Co., LTD",
"registrationNumber": null
},
"orderDate": "2022-03-29T19:19:55Z",
"currencyCode": "JPY",
"invoiceTotal": "1409.0",
"tax": [
{
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "1409.0"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "1281.0"
},
"amount": {
"currencyCode": "JPY",
"amount": "128.0"
}
}
],
"transactionDataItems": [
{
"taxRate": "0.1",
"unit": 1,
"asin": "B09D2J8ZMD",
"title": "60個 風船 バルーン ゴム風船 誕生日 飾り付け 吹雪入れ風船 誕生日会 バースデー 卒業 開店 記念日 結婚式 お祝",
"unitTaxInclusivePrice": {
"currencyCode": "JPY",
"amount": "999.0"
},
"unitTaxExclusivePrice": {
"currencyCode": "JPY",
"amount": "908"
},
"unitTaxAmount": {
"currencyCode": "JPY",
"amount": "91.0"
},
"totalAmount": {
"currencyCode": "JPY",
"amount": "999.0"
},
"discount": null,
"apportionment": [
{
"orderLineItemId": "6172301145805",
"lineNumber": 1,
"units": 1,
"unitPrice": {
"currencyCode": "JPY",
"amount": "908.0"
},
"taxAmount": {
"currencyCode": "JPY",
"amount": "91.0"
}
}
],
"fees": []
}
],
"fees": [
{
"feeType": "SHIPPING",
"tax": {
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "410.0"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "373.0"
},
"amount": {
"currencyCode": "JPY",
"amount": "37.0"
}
},
"discount": null,
"apportionment": [
{
"taxExclusiveFee": {
"currencyCode": "JPY",
"amount": "373.0"
},
"taxAmount": {
"currencyCode": "JPY",
"amount": "37.0"
}
}
]
}
]
},
{
"invoiceNumber": "JP22C9G0FUC",
"invoiceDate": "2022-04-09T03:38:16.262Z",
"invoiceType": "CREDIT_MEMO",
"associatedInvoiceNumber": "JP25EF9G0FUI",
"associatedInvoiceDate": "2022-04-01T08:48:53.158Z",
"invoiceIssuer": {
"name": "Shenzhen Sepo Supply Chain Co., LTD",
"registrationNumber": null
},
"billToAddress": {
"fullName": "test return",
"phoneNumber": "81120899543",
"companyName": null,
"addressLine1": "Arco Tower Annex, 1 Chome-8-1 Shimomeguro, Meguro City, Toky",
"addressLine2": null,
"city": null,
"stateOrRegion": "Yamanashi-ken",
"postalCode": "153-0064",
"countryCode": "JP"
},
"sellerInformation": {
"name": "Shenzhen Sepo Supply Chain Co., LTD",
"registrationNumber": null
},
"orderDate": "2022-03-29T19:19:55Z",
"currencyCode": "JPY",
"invoiceTotal": "1409.00",
"tax": [
{
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "1409.0"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "1281.0"
},
"amount": {
"currencyCode": "JPY",
"amount": "128.0"
}
}
],
"transactionDataItems": [
{
"taxRate": "0.1",
"unit": 1,
"asin": "B09D2J8ZMD",
"title": "60個 風船 バルーン ゴム風船 誕生日 飾り付け 吹雪入れ風船 誕生日会 バースデー 卒業 開店 記念日 結婚式 お祝",
"unitTaxInclusivePrice": {
"currencyCode": "JPY",
"amount": "999.0"
},
"unitTaxExclusivePrice": {
"currencyCode": "JPY",
"amount": "908"
},
"unitTaxAmount": {
"currencyCode": "JPY",
"amount": "91.0"
},
"totalAmount": {
"currencyCode": "JPY",
"amount": "1409.00"
},
"discount": null,
"apportionment": [
{
"orderLineItemId": "6172301145805",
"lineNumber": 1,
"units": 1,
"unitPrice": {
"currencyCode": "JPY",
"amount": "908.0"
},
"taxAmount": {
"currencyCode": "JPY",
"amount": "91.0"
}
}
],
"fees": []
}
],
"fees": [
{
"feeType": "SHIPPING",
"tax": {
"rate": "0.1",
"inclusiveTotal": {
"currencyCode": "JPY",
"amount": "410.00"
},
"exclusiveTotal": {
"currencyCode": "JPY",
"amount": "373.00"
},
"amount": {
"currencyCode": "JPY",
"amount": "37.00"
}
},
"discount": null,
"apportionment": [
{
"taxExclusiveFee": {
"currencyCode": "JPY",
"amount": "373.0"
},
"taxAmount": {
"currencyCode": "JPY",
"amount": "37.0"
}
}
]
}
]
}
]
}
]
}
Scenario: Calling Reconciliation API sandbox getInvoiceDetailsByOrderLineItems operation to get invoice data for order line items identified with valid order, line item, and shipment identifiers:
POST https://sandbox.na.business-api.amazon.com/reconciliation/2021-01-08/invoices
Response: This scenario returns a 400 status code with a “Missing required request parameters” error message.
Response code: 400 Bad Request
{
"errors": [
{
"code": "INVALID_REQUEST_PARAMETER",
"message": "Missing required request parameters.",
"details": ""
}
]
}
Updated 4 months ago