Reporting API static sandbox guide
The Reporting 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 Reporting 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 Reporting 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
Path: /reports/2025-06-09/orderReports
Scenario: Calling Reporting API getOrderReports operation to return a list of order reports between orderStartDate of 2025-01-15T10:30:00Z and orderEndDate of 2025-02-15T10:30:00Z.
GET https://sandbox.na.business-api.amazon.com/reports/2025-06-09/orderReports?orderStartDate=2025-01-15T10%3A30%3A00Z&orderEndDate=2025-02-15T10%3A30%3A00Z®ion=US&orderStatuses=CLOSED
Response: A successful response returns order report data for the specified date range.
Status code: 200
{
"ordersReport": [
{
"orderMetadata": {
"orderDate": {
"date": "2025-04-11T00:00:00Z"
},
"orderId": "112-3456789-0123456"
},
"purchaseOrderNumber": "PO-2025-0123",
"orderStatus": "CLOSED",
"charges": [
{
"type": "SUBTOTAL",
"amount": {
"currencyCode": "USD",
"amount": 499.95
}
},
{
"type": "SHIPPING_AND_HANDLING",
"amount": {
"currencyCode": "USD",
"amount": 25.0
}
},
{
"type": "PROMOTION",
"amount": {
"currencyCode": "USD",
"amount": -50.0
}
},
{
"type": "TAX",
"amount": {
"currencyCode": "USD",
"amount": 37.5
}
},
{
"type": "NET_TOTAL",
"amount": {
"currencyCode": "USD",
"amount": 512.45
}
}
],
"buyingCustomer": {
"name": "[customerName]",
"email": "[customerEmail]"
},
"buyerGroup": {
"name": "[buyerGroupName]"
},
"businessOrderInfo": {
"glCode": "[glCode]",
"costCenter": "[costCenter]",
"location": "[location]",
"projectCode": "[projectCode]",
"department": "[department]"
},
"shipTo": {
"addressLine1": "[addressLine1]",
"addressLine2": "[addressLine2]",
"city": "[city]",
"stateOrRegion": "[state]",
"postalCode": "[postalCode]",
"countryCode": "US"
},
"approverDetails": {
"lastOrderApproverCustomer": {
"name": "[approverName]",
"email": "[approverEmail]"
}
}
}
],
"nextPageToken": "[nextPageToken]"
}
Scenario: Calling Reporting API without the required orderStartDate field in the request.
GET https://sandbox.na.business-api.amazon.com/reports/2025-06-09/orderReports?orderEndDate=2025-04-01T00:00:00Z
Response: Returns a 400 status code error when required parameters are missing.
Status code: 400
{
"errors": [{
"code": "INVALID_REQUEST_PARAMETER",
"message": "The required parameter orderStartDate is missing.",
"details": "Please provide the required parameter orderStartDate in the request."
}]
}
Path: GET /reports/2025-06-09/orderLineItemReports
Scenario: Calling Reporting API getOrderLineItemReports operation to retrieve order line item reports within the specified time range.
GET https://sandbox.na.business-api.amazon.com/reports/2025-06-09/orderLineItemReports?orderStartDate=2025-04-01T00%3A00%3A00Z&orderEndDate=2025-04-30T00%3A00%3A00Z®ion=US&orderIds=112-3456789-0123456
Response: A successful response returns order line item report data for the specified date range
Status code: 200
{
"orderLineItemsReport": [
{
"orderMetadata": {
"orderDate": {
"date": "2025-04-11T00:00:00Z"
},
"orderId": "112-3456789-0123456"
},
"orderLineItemId": "1",
"purchaseOrderNumber": "PO-2025-0123",
"purchaseOrderLineItemNumber": "PO-2025-0123-1",
"productDetails": {
"productCategory": "Office Electronics",
"asin": "B08N5KWB9H",
"title": "Professional Laptop Docking Station",
"unspsc": {
"code": "43211602"
},
"productCondition": "New",
"brandCode": "TH-101",
"brandName": "TechHub",
"manufacturerName": "TechHub Electronics",
"serialNumbers": [
"DOCK-2025-001",
"DOCK-2025-002"
]
},
"quantity": 5,
"listedPricePerUnit": {
"currencyCode": "USD",
"amount": 129.99
},
"unitPrice": {
"currencyCode": "USD",
"amount": 99.99
},
"charges": [
{
"type": "SUBTOTAL",
"amount": {
"currencyCode": "USD",
"amount": 499.95
}
},
{
"type": "SHIPPING_AND_HANDLING",
"amount": {
"currencyCode": "USD",
"amount": 25.0
}
},
{
"type": "PROMOTION",
"amount": {
"currencyCode": "USD",
"amount": -50.0
}
},
{
"type": "TAX",
"amount": {
"currencyCode": "USD",
"amount": 37.5
}
},
{
"type": "NET_TOTAL",
"amount": {
"currencyCode": "USD",
"amount": 512.45
}
}
],
"taxExemption": {
"applied": false,
"type": "None",
"optOut": false
},
"discount": {
"program": "Business Volume Discount",
"type": "Volume",
"amount": {
"currencyCode": "USD",
"amount": 50.0
},
"ratio": "0.10"
},
"sustainability": {
"certificationCategory": "Environmental",
"certificationType": "Climate Pledge Friendly"
},
"seller": {
"name": "[sellerName]",
"primaryAddress": {
"addressLine1": "[addressLine1]",
"addressLine2": "[addressLine2]",
"city": "[city]",
"stateOrRegion": "[state]",
"postalCode": "[postalCode]",
"countryCode": "US"
},
"credentials": {
"types": [
"Small Business"
],
"details": [
{
"certificateType": "SmallBusiness",
"certifyingAgenciesDetails": [
{
"agencyName": "[certifyingAgencyName]",
"certificateExpirationDate": {
"date": "2028-04-01T00:00:00Z"
}
}
]
}
]
}
}
}
],
"nextPageToken": "[nextPageToken]"
}
Scenario: Calling Reporting API with invalid orderStartDate.
GET https://sandbox.na.business-api.amazon.com/reports/2025-06-09/orderLineItemReports?orderStartDate=2025-04-01T00%3A00%3A00Z&orderEndDate=2025-04-30T00%3A00%3A00Z®ion=US&orderIds=112-3456789-0123456)/reports/2025-06-09/orderLineItemReports?orderStartDate=2025-04-01T00:00:00Z&orderEndDate=2025-02-01T00:00:00Z
Response: Returns an error when the date range is invalid.
Status code: 400
{
"errors": [{
"code": "InvalidInput",
"message": "Invalid date range specified.",
"details": "The orderStartDate must be before or equal to the orderEndDate."
}]
}
Path: GET /reports/2025-06-09/purchaseOrders/{purchaseOrderNumber}/orderReports
Scenario: Calling Reporting API getOrderReportsByPurchaseOrderNumber operation to retrieve order reports by the purchase order number.
GET https://sandbox.na.business-api.amazon.com/reports/2025-06-09/purchaseOrders/PO-12345/orderReports?region=US
Response: A successful response returns order report data for the specified purchase order number
Status code: 200
{
"ordersReport": [
{
"orderMetadata": {
"orderDate": {
"date": "2025-04-11T00:00:00Z"
},
"orderId": "112-3456789-0123456"
},
"purchaseOrderNumber": "PO-12345",
"orderStatus": "CLOSED",
"charges": [
{
"type": "SUBTOTAL",
"amount": {
"currencyCode": "USD",
"amount": 499.95
}
},
{
"type": "SHIPPING_AND_HANDLING",
"amount": {
"currencyCode": "USD",
"amount": 25.0
}
},
{
"type": "PROMOTION",
"amount": {
"currencyCode": "USD",
"amount": -50.0
}
},
{
"type": "TAX",
"amount": {
"currencyCode": "USD",
"amount": 37.5
}
},
{
"type": "NET_TOTAL",
"amount": {
"currencyCode": "USD",
"amount": 512.45
}
}
],
"buyingCustomer": {
"name": "[customerName]",
"email": "[customerEmail]"
},
"buyerGroup": {
"name": "[buyerGroupName]"
},
"businessOrderInfo": {
"glCode": "[glCode]",
"costCenter": "[costCenter]",
"location": "[location]",
"projectCode": "[projectCode]",
"department": "[department]"
},
"shipTo": {
"addressLine1": "[addressLine1]",
"addressLine2": "[addressLine2]",
"city": "[city]",
"stateOrRegion": "[state]",
"postalCode": "99002",
"countryCode": "US"
},
"approverDetails": {
"lastOrderApproverCustomer": {
"name": "[approverName]",
"email": "[approverEmail]"
}
}
}
],
"nextPageToken": "[nextPageToken]"
}
Scenario: Calling Reporting API getOrderReportsByPurchaseOrderNumber operation with an invalid purchase order number.
GET https://sandbox.na.business-api.amazon.com/reports/2025-06-09/shipmentLineItemReports?orderStartDate=2025-04-01T00%3A00%3A00Z&orderEndDate=2025-04-30T00%3A00%3A00Z&orderIds=112-3456789-0123456®ion=US
Response: Returns an error when the purchase order number is missing or invalid.
Status code: 400
{
"errors": [{
"code": "INVALID_REQUEST_PARAMETER",
"message": "The required parameter purchaseOrderNumber is missing or invalid.",
"details": "Please provide a valid purchase order number."
}]
}
Path: GET /reports/2025-06-09/shipmentReports
Scenario: Calling Reporting API getShipmentReports operation to retrieve a list of shipment reports in the specified time range.
GET https://sandbox.na.business-api.amazon.com/reports/2025-06-09/shipmentReports?orderStartDate=2025-04-01T00%3A00%3A00Z&orderEndDate=2025-04-30T00%3A00%3A00Z&shipmentStatuses=SHIPPED&orderIds=112-3456789-0123456®ion=US
Response: A successful response returns shipment report data for the specified date range
Status code: 200
{
"shipmentsReport": [
{
"orderMetadata": {
"orderDate": {
"date": "2025-04-11T00:00:00Z"
},
"orderId": "112-3456789-0123456"
},
"shipmentMetadata": {
"shipmentDate": {
"date": "2025-04-21T00:00:00Z"
},
"shipmentId": "SHIP-12345"
},
"purchaseOrderNumber": "PO-12345",
"shipmentStatus": "SHIPPED",
"deliveryInfo": {
"expectedDeliveryDate": {
"date": "2025-04-22T00:00:00Z"
},
"status": "NOT_DELIVERED"
},
"charges": [
{
"type": "SUBTOTAL",
"amount": {
"currencyCode": "USD",
"amount": 100.0
}
},
{
"type": "SHIPPING_AND_HANDLING",
"amount": {
"currencyCode": "USD",
"amount": 10.0
}
},
{
"type": "PROMOTION",
"amount": {
"currencyCode": "USD",
"amount": -5.0
}
},
{
"type": "TAX",
"amount": {
"currencyCode": "USD",
"amount": 5.0
}
},
{
"type": "NET_TOTAL",
"amount": {
"currencyCode": "USD",
"amount": 110.0
}
}
],
"shippingAddress": {
"addressLine1": "[addressLine1]",
"addressLine2": "[addressLine2]",
"city": "[city]",
"stateOrRegion": "[state]",
"postalCode": "[postalCode]",
"countryCode": "US"
}
}
],
"nextPageToken": "NEXT_PAGE_TOKEN"
}
GET https://sandbox.na.business-api.amazon.com/reports/2025-06-09/shipmentLineItemReports?orderStartDate=2025-04-01T00%3A00%3A00Z&orderEndDate=2025-04-30T00%3A00%3A00Z&orderIds=112-3456789-0123456®ion=US
Response: Returns an error when the date range is invalid.
Status code: 400
{
"errors": [{
"code": "InvalidInput",
"message": "Invalid date range specified.",
"details": "The orderStartDate must be before or equal to the orderEndDate."
}]
}
Path: GET /reports/2025-06-09/shipmentLineItemReports
Scenario: Calling Reporting API getShipmentLineItemReports operation to retrieve a list of shipment line item reports within the specified time range.
GET https://sandbox.na.business-api.amazon.com/reports/2025-06-09/shipmentLineItemReports?orderStartDate=2025-04-01T00%3A00%3A00Z&orderEndDate=2025-04-30T00%3A00%3A00Z&orderIds=112-3456789-0123456®ion=US
Response: A successful response returns shipment line item report data for the specified date range
Status code: 200
{
"shipmentLineItemsReport": [
{
"orderMetadata": {
"orderDate": {
"date": "2025-04-11T00:00:00Z"
},
"orderId": "112-3456789-0123456"
},
"shipmentMetadata": {
"shipmentDate": {
"date": "2025-04-21T00:00:00Z"
},
"shipmentId": "SHIP-12345"
},
"purchaseOrderNumber": "PO-12345",
"purchaseOrderLineItemNumber": "1",
"orderLineItemId": "LINE-12345",
"productDetails": {
"productCategory": "Office Electronics",
"asin": "B00EXAMPLE",
"title": "Example Product",
"unspsc": {
"code": "43211602"
},
"productCondition": "New",
"brandCode": "EXBRAND",
"brandName": "Example Brand",
"manufacturerName": "Example Manufacturer",
"serialNumbers": [
"SN123456",
"SN123457"
]
},
"charges": [
{
"type": "SUBTOTAL",
"amount": {
"currencyCode": "USD",
"amount": 100.0
}
},
{
"type": "SHIPPING_AND_HANDLING",
"amount": {
"currencyCode": "USD",
"amount": 10.0
}
},
{
"type": "PROMOTION",
"amount": {
"currencyCode": "USD",
"amount": -5.0
}
},
{
"type": "TAX",
"amount": {
"currencyCode": "USD",
"amount": 5.0
}
},
{
"type": "NET_TOTAL",
"amount": {
"currencyCode": "USD",
"amount": 110.0
}
}
],
"quantity": 2,
"carrierName": "Example Carrier",
"packages": [
{
"trackingId": "1Z999AA1123456789",
"packageId": "PACKAGE-12345"
}
],
"receivingInfo": {
"date": {
"date": "2025-04-23T00:00:00Z"
},
"status": "RECEIVED",
"quantity": 2
}
}
],
"nextPageToken": "NEXT_PAGE_TOKEN"
}
Scenario: Calling Reporting API getShipmentLineItemReports operation with an invalid date range.
GET https://sandbox.na.business-api.amazon.com/reports/2025-06-09/shipmentLineItemReports?orderStartDate=2025-04-01T00%3A00%3A00Z&orderEndDate=2025-04-30T00%3A00%3A00Z&orderIds=112-3456789-0123456®ion=US
Response: This scenario returns an error when the date range is invalid.
Status code: 400
{
"errors": [{
"code": "InvalidInput",
"message": "Invalid date range specified.",
"details": "The orderStartDate must be before or equal to the orderEndDate."
}]
}
Updated about 13 hours ago