Reporting API v2025-06-09 reference
Amazon Business API for Order and Shipment Reporting
Overview
The Amazon Business API for Order and Shipment Reporting provides comprehensive capabilities for analyzing order data, tracking shipments, and monitoring procurement activities. This API enables businesses to retrieve detailed information about orders, order line items, shipments, and shipment items. Key features include:
- Detailed order and shipment data retrieval
- Line item-level reporting for orders and shipments
- Flexible filtering options for targeted data analysis
- Pagination support for handling large datasets
- Comprehensive error handling and status reporting
These capabilities facilitate in-depth analysis and reporting of procurement activities, helping businesses track supplier performance, monitor spending goals, and optimize their purchasing processes.
Version information
Version : 2025-06-09
Contact information
Contact : AB Support
Contact URL : https://developer-docs.amazon.com/amazon-business/
License information
License : Amazon Software License
License URL : https://aws.amazon.com/asl/
URI scheme
Host : www
Schemes : HTTPS
Consumes
application/json
Produces
application/json
External Docs
Description : Learn more about the Amazon Business API.
URL : http://business.amazon.com
Operations
getOrderReports
getOrderLineItemReports
getOrderReportsByPurchaseOrderNumber
getShipmentReports
getShipmentLineItemReports
Paths
GET /reports/2025-06-09/orderReports
Operation: getOrderReports
Description
Fetches orders from all legal entities associated with the partyId based on specified search criteria. This endpoint allows for detailed querying of order data, enabling comprehensive order reporting and analysis.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 0.5 | 10 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. For questions about your usage plan, reach out to your Amazon Business technical contact.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | orderStartDate required | The start of the order date range to search for orders, in ISO 8601 format. Must not be more than 366 days before orderEndDate. | string (date-time) |
| Query | orderEndDate required | The end of the order date range to search for orders, in ISO 8601 format. Must not be in the future and must not be more than 366 days after orderStartDate. | string (date-time) |
| Query | orderStatuses optional | List of OrderStatus values used to filter the results. Possible values: - PENDING_APPROVAL : The order has been submitted for approval.- PAYMENT_CONFIRMED : The payment information has been collected by Amazon Business.- PENDING_FULFILLMENT : The order is due for fulfillment. - PENDING : The order details are being processed by Amazon Business.- CANCELLED : The order has been cancelled either by the buyer or by Amazon Business.- CLOSED : The order has been delivered to the buyer and closed. Min count : 1 | < string > array(csv) |
| Query | region optional | The region where the order was placed. If the business has not placed orders in that region or does not belong to that region, the result would be empty. | enum (Region) |
| Query | nextPageToken optional | A page token returned in the response to your previous request when the number of results exceed the page size. Must be used with the same query parameters as the original request, changing parameters will result in an error. To get the next page of results, include pageToken as a parameter. There are no more pages to return when the response returns no nextPageToken. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Orders were successfully retrieved. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetOrderReportsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
GET /reports/2025-06-09/orderLineItemReports
Operation: getOrderLineItemReports
Description
Fetches order line items from all legal entities associated with the partyId based on specified search criteria. This endpoint allows for detailed querying of order line item data, enabling comprehensive order line item reporting and analysis.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 0.5 | 10 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. For questions about your usage plan, reach out to your Amazon Business technical contact.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | orderStartDate required | The start of the order date range to search for order line items, in ISO 8601 format. Must not be more than 366 days before orderEndDate.", | string (date-time) |
| Query | orderEndDate required | The end of the order date range to search for order line items, in ISO 8601 format. Must not be in the future and must not be more than 366 days after orderStartDate.", | string (date-time) |
| Query | region optional | The region where the order was placed. If the business has not placed orders in that region or does not belong to that region, the result would be empty. | enum (Region) |
| Query | orderIds optional | List of order IDs to filter by. If the order date for any specified order ID is not within the provided date range, an empty result will be returned. Min count : 1 Max count : 30 | < string > array(csv) |
| Query | nextPageToken optional | A page token returned in the response to your previous request when the number of results exceed the page size. Must be used with the same query parameters as the original request, changing parameters will result in an error. To get the next page of results, include pageToken as a parameter. There are no more pages to return when the response returns no nextPageToken. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Order line items were successfully retrieved. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetOrderLineItemReportsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
GET /reports/2025-06-09/purchaseOrders/{purchaseOrderNumber}/orderReports
Operation: getOrderReportsByPurchaseOrderNumber
Description
Fetches orders associated with a specific purchase order number. This endpoint allows for detailed querying of order data related to a particular purchase order, enabling comprehensive order reporting and analysis. This API supports data retrieval for the past 2 years only. If the purchase order is older than 2 years, it would return empty result.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 0.5 | 10 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. For questions about your usage plan, reach out to your Amazon Business technical contact.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | purchaseOrderNumber required | The purchase order number used to retrieve associated orders. | string |
| Query | region required | The region where the order was placed. If the business has not placed orders in that region or does not belong to that region, the result would be empty. | enum (Region) |
| Query | nextPageToken optional | A page token returned in the response to your previous request when the number of results exceed the page size. Must be used with the same query parameters as the original request, changing parameters will result in an error. To get the next page of results, include pageToken as a parameter. There are no more pages to return when the response returns no nextPageToken. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Orders were successfully retrieved. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetOrderReportsByPurchaseOrderNumberResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
GET /reports/2025-06-09/shipmentReports
Operation: getShipmentReports
Description
Fetches shipments from all legal entities associated with the partyId based on specified search criteria. This endpoint allows for detailed querying of shipment data, enabling comprehensive shipment reporting and analysis.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 0.5 | 10 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. For questions about your usage plan, reach out to your Amazon Business technical contact.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | orderStartDate required | The start of the order date range to search for shipments, in ISO 8601 format. Must not be more than 366 days before orderEndDate.", | string (date-time) |
| Query | orderEndDate required | The end of the order date range to search for shipments, in ISO 8601 format. Must not be in the future and must not be more than 366 days after orderStartDate.", | string (date-time) |
| Query | shipmentStatuses optional | List of shipment status values used to filter the results. Possible values: - SHIPPED : The shipment has been sent out.- PENDING_PAYMENT : The shipment is awaiting payment before it can be processed.- SHIPPING_SOON : The shipment is being prepared and will be shipped shortly.- SHIPPED_PLANNED : The shipment has been planned but not yet dispatched. Min count : 1 | < string > array(csv) |
| Query | orderIds optional | List of order IDs to filter by. If the order date for any specified order ID is not within the provided date range, an empty result will be returned. Min count : 1 Max count : 30 | < string > array(csv) |
| Query | region optional | The region where the order was placed. If the business has not placed orders in that region or does not belong to that region, the result would be empty. | enum (Region) |
| Query | nextPageToken optional | A page token returned in the response to your previous request when the number of results exceed the page size. Must be used with the same query parameters as the original request, changing parameters will result in an error. To get the next page of results, include pageToken as a parameter. There are no more pages to return when the response returns no nextPageToken. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Shipment details were successfully retrieved. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentReportsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
GET /reports/2025-06-09/shipmentLineItemReports
Operation: getShipmentLineItemReports
Description
Fetches shipment line items from all legal entities associated with the partyId based on specified search criteria. This endpoint allows for detailed querying of shipment line item data, enabling comprehensive shipment line item reporting and analysis.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 0.5 | 10 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. For questions about your usage plan, reach out to your Amazon Business technical contact.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | orderStartDate required | The start of the order date range to search for shipment line items, in ISO 8601 format. Must not be more than 366 days before orderEndDate.", | string (date-time) |
| Query | orderEndDate required | The end of the order date range to search for shipment line items, in ISO 8601 format. Must not be in the future and must not be more than 366 days after orderStartDate.", | string (date-time) |
| Query | orderIds optional | List of order IDs to filter by. If the order date for any specified order ID is not within the provided date range, an empty result will be returned. Min count : 1 Max count : 30 | < string > array(csv) |
| Query | purchaseOrderNumbers optional | List of purchase order numbers to filter by. If the order date for any specified purchase order number is not within the provided date range, an empty result will be returned. Min count : 1 Max count : 30 | < string > array(csv) |
| Query | region optional | The region where the order was placed. If the business has not placed orders in that region or does not belong to that region, the result would be empty. | enum (Region) |
| Query | nextPageToken optional | A page token returned in the response to your previous request when the number of results exceed the page size. To get the next page of results, include pageToken as a parameter. There are no more pages to return when the response returns no nextPageToken. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Shipment items were successfully retrieved. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetShipmentLineItemReportsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Error Responses and Schemas
This table contains HTTP status codes and associated information for error responses.
| HTTP Code | Description | Schema |
|---|---|---|
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 404 | The resource specified does not exist. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 413 | The request size exceeded the maximum accepted size. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 415 | The request payload is in an unsupported format. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 429 | The frequency of requests was greater than allowed. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 503 | Temporary overloading or maintenance of the server. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
Definitions
Address
A detailed physical address.
| Name | Description | Schema |
|---|---|---|
| addressLine1 required | The primary address line. minLength : 1 | string |
| addressLine2 optional | The secondary address line. maxLength : 60 | string |
| city required | The city name. minLength : 1 | string |
| stateOrRegion optional | The state or region. Mandatory for addresses in the US. | string |
| postalCode required | The postal code. minLength : 1 | string |
| countryCode required | The country code in ISO 3166-1 alpha-2 format. Pattern : "^[A-Z]{2}$" | string |
Customer
Details of a customer.
| Name | Description | Schema |
|---|---|---|
| name required | The name of the customer. | string |
| email optional | The email address of the customer. | string |
OrderLineItemReport
Represents a detailed line item report for an order,
| Name | Description | Schema |
|---|---|---|
| orderMetadata required | Metadata about an order including order ID and order date. | OrderMetadata |
| orderLineItemId required | The unique identifier assigned to this specific line item in the order. | string |
| purchaseOrderNumber optional | The purchase order number associated with this line item. | string |
| purchaseOrderLineItemNumber optional | The reference number that identifies this line item on the purchase order. | string |
| productDetails required | Details of the product in this line item. | ProductDetails |
| unitPrice optional | The actual purchased price per unit for this line item. | Money |
| quantity optional | The quantity of items Minimum value : 0 | integer |
| charges required | List of charges associated with the order | < Charge > array |
| taxExemption optional | Information about tax exemption for this line item. | TaxExemption |
| pricingProgram optional | Information about discounts applied to this line item. | PricingProgram |
| sustainability optional | Sustainability information for this line item. | Sustainability |
| seller optional | Information about the seller of this line item. | Seller |
ReceivingInfo
A line item's receiving status.
| Name | Description | Schema |
|---|---|---|
| customer required | The customer associated with this receiving info. | Customer |
| date optional | The date when the item was received. If the item is not yet received, this field will be null. | DateTime |
| status required | The status of receiving an item. Possible values: - ALL_ITEMS_RECEIVED : The item has been fully received.- PARTIALLY_RECEIVED : Only a part of the item quantity has been received.- PENDING : The item has not been received yet.- ITEMS_MISSING : Some items from the shipment are missing. | string |
| quantity required | The quantity of the item received. Minimum value : 0 | integer |
GetOrderLineItemReportsResponse
The response schema for the GetOrderLineItemReports operation.
| Name | Description | Schema |
|---|---|---|
| orderLineItemsReport required | The list of order line items matching the search criteria. | < OrderLineItemReport > array |
| nextPageToken required | A token to retrieve the next page of results. | string |
| size optional | Number of order line items in the response. | integer |
CertifyingAgencyDetail
Information about a certifying agency.
| Name | Description | Schema |
|---|---|---|
| agencyName optional | The name of the certifying agency. | string |
| certificateExpirationDate optional | The expiration date of the certificate. | DateTime |
DeliveryInfo
Information about the delivery of a shipment.
| Name | Description | Schema |
|---|---|---|
| expectedDeliveryDate required | The expected date and time of delivery. | DateTime |
| status required | The status of a delivery. Possible values: - DELIVERED : The shipment has been successfully delivered to the recipient.- NOT_DELIVERED : The shipment has not been delivered yet.- NOT_AVAILABLE : The delivery status is currently unavailable. | string |
DateTime
The date format based on ISO 8601.
| Name | Description | Schema |
|---|---|---|
| date required | The date and time in ISO 8601 format with UTC timezone. The format is YYYY-MM-DDThh:mm:ssZ. For example, 2025-01-15T10:30:00Z represents January 15, 2025 at 10:30 AM UTC. | string (date-time) |
Money
Representation of a monetary value.
| Name | Description | Schema |
|---|---|---|
| currencyCode required | The currency code in ISO 4217 format. Pattern : "^[A-Z]{3}$" | string |
| amount required | The monetary amount. | number |
OrderReport
Represents a detailed order report containing comprehensive order information.
| Name | Description | Schema |
|---|---|---|
| orderMetadata required | Metadata about an order including order ID and order date. | OrderMetadata |
| purchaseOrderNumber optional | The purchase order number associated with the order. | string |
| charges required | List of charges associated with the order | < Charge > array |
| orderStatus required | The current status of an order in the system. Possible values: - PENDING_APPROVAL : The order has been submitted for approval.- PAYMENT_CONFIRMED : The payment information has been collected by Amazon Business.- PENDING_FULFILLMENT : The order is due for fulfillment. - PENDING : The order details are being processed by Amazon Business.- CANCELLED : The order has been cancelled either by the buyer or by Amazon Business.- CLOSED : The order has been delivered to the buyer and closed. | string |
| buyingCustomer optional | Details of the customer who placed the order. | Customer |
| buyerGroup optional | Details of the buyer group associated with the order. | BuyerGroupDetails |
| businessOrderInfo optional | Additional business-specific information about the order. | < string, string > map |
| approverDetails optional | Details of the person who approved the order. | ApproverDetails |
ShipmentReport
Represents a detailed shipment report.
| Name | Description | Schema |
|---|---|---|
| orderMetadata required | Metadata about an order including order ID and order date. | OrderMetadata |
| shipmentMetadata required | Metadata about a shipment including shipment ID and shipment date. | ShipmentMetadata |
| purchaseOrderNumber optional | The purchase order number associated with the order. | string |
| shipmentStatus required | The status of a shipment. Possible values: - SHIPPED : The shipment has been sent out.- PENDING_PAYMENT : The shipment is awaiting payment before it can be processed.- SHIPPING_SOON : The shipment is being prepared and will be shipped shortly.- SHIPPED_PLANNED : The shipment has been planned but not yet dispatched. | string |
| shippingAddress required | The shipping address for the shipment. | Address |
| charges required | List of charges associated with the order | < Charge > array |
| deliveryInfo optional | Information about the delivery of the shipment. | DeliveryInfo |
Sustainability
Sustainability information for a line item.
| Name | Description | Schema |
|---|---|---|
| certificationCategory optional | The category of sustainability certification. | string |
| certificationTypes optional | The types of sustainability certification. | < string > array |
ProductDetails
Information about a product.
| Name | Description | Schema |
|---|---|---|
| productCategory required | The category of the product. | string |
| asin required | The Amazon Standard Identification Number (ASIN) of the product. | string |
| title required | The title of the product. | string |
| unspsc required | The United Nations Standard Products and Services Code (UNSPSC) for the product. | Unspsc |
| productCondition required | The physical condition of the product at time of shipment. | string |
| brandCode required | The code identifying the brand of the product. | string |
| brandName required | The name of the brand. | string |
| manufacturerName required | The name of the manufacturer. | string |
| serialNumbers optional | List of serial numbers associated with the product. | < string > array |
GetOrderReportsByPurchaseOrderNumberResponse
The response schema for the GetOrderReportsByPurchaseOrderNumber operation.
| Name | Description | Schema |
|---|---|---|
| ordersReport required | The list of orders matching the search criteria. | < OrderReport > array |
| nextPageToken required | A token to retrieve the next page of results. | string |
| size optional | Number of orders in the response. | integer |
ApproverDetails
Details of the order approver.
| Name | Description | Schema |
|---|---|---|
| lastOrderApproverCustomer optional | Details of a customer. | Customer |
ShipmentLineItemReport
Represents a detailed shipment line item report.
| Name | Description | Schema |
|---|---|---|
| orderMetadata required | Metadata about an order including order ID and order date. | OrderMetadata |
| shipmentMetadata required | Metadata about a shipment including shipment ID and shipment date. | ShipmentMetadata |
| purchaseOrderNumber optional | The purchase order number associated with the order. | string |
| orderLineItemId required | The unique identifier assigned to this specific line item in the order. | string |
| purchaseOrderLineItemNumber optional | The reference number that identifies this line item on the purchase order. | string |
| productDetails required | Details of the product in this line item. | ProductDetails |
| charges required | List of charges associated with the order | < Charge > array |
| quantity optional | The quantity of items Minimum value : 0 | integer |
| carrierName optional | The name of the carrier for this shipment. | string |
| packages optional | The physical packages that comprise this shipment item. | < Package > array |
| receivingInfo optional | The Receiving status, date and quantity details for tracking shipment items in 3-way matching. | ReceivingInfo |
GetOrderReportsResponse
The response schema for the GetOrderReports operation.
| Name | Description | Schema |
|---|---|---|
| ordersReport required | The list of orders matching the search criteria. | < OrderReport > array |
| nextPageToken required | A token to retrieve the next page of results. | string |
| size optional | Number of orders in the response. | integer |
BuyerGroupDetails
Details of a buyer group.
| Name | Description | Schema |
|---|---|---|
| name required | The name of the group. | string |
PricingProgram
Information about pricing programs and discounts applied to a line item.
| Name | Description | Schema |
|---|---|---|
| name required | The name of the pricing program applied. | string |
| discountAmount required | The discount amount applied to this line item through the pricing program. | Money |
OrderMetadata
Metadata about an order including order ID and order date.
| Name | Description | Schema |
|---|---|---|
| orderDate required | The date when the order was placed. | DateTime |
| orderId required | The unique identifier for the order. | string |
| region optional | The region where the order was placed. Possible values: - DE : Germany- FR : France- UK : United Kingdom- IT : Italy- ES : Spain- IN : India- US : United States of America- CA : Canada- MX : Mexico- JP : Japan- AU : Australia | string |
ShipmentMetadata
Metadata about a shipment including shipment ID and shipment date.
| Name | Description | Schema |
|---|---|---|
| shipmentId required | The unique identifier for the shipment. | string |
| shipmentDate required | The date when the shipment was made. | DateTime |
Charge
Financial amount for a specific type of charge
| Name | Description | Schema |
|---|---|---|
| type required | The type of charge. Possible values: - SUBTOTAL : The subtotal amount before additional charges and adjustments.- SHIPPING_AND_HANDLING : The charges for shipping and handling services.- PROMOTION : The promotional discount applied. - TAX : The tax amount.- NET_TOTAL : The final total amount after all charges and adjustments. | string |
| amount required | The monetary amount for this charge | Money |
Unspsc
United Nations Standard Products and Services Code (UNSPSC).
| Name | Description | Schema |
|---|---|---|
| code required | The UNSPSC code. Pattern : "^[0-9]{8}$" | string |
Error
Error response returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| code required | An error code that identifies the type of error that occurred. | string |
| message required | A message that describes the error condition. | string |
| details optional | Additional details that can help the caller understand or fix the issue. | string |
TaxExemption
Information about tax exemption for a line item.
| Name | Description | Schema |
|---|---|---|
| applied required | Indicates if tax exemption was applied. | boolean |
| type required | The type of tax exemption. | string |
| optOut required | Indicates if the customer opted out of tax exemption. | boolean |
GetShipmentReportsResponse
The response schema for the GetShipmentReports operation.
| Name | Description | Schema |
|---|---|---|
| shipmentsReport required | The list of shipments matching the search criteria. | < ShipmentReport > array |
| nextPageToken required | A token to retrieve the next page of results. | string |
| size optional | Number of shipments in the response. | integer |
SellerCredentials
Comprehensive information about seller's credentials including basic and detailed credential data.
| Name | Description | Schema |
|---|---|---|
| types optional | List of credential types held by the seller. | < string > array |
| details optional | Detailed information about each credential including certification and expiration details. | < CredentialDetail > array |
CredentialDetail
Detailed information about a specific credential.
| Name | Description | Schema |
|---|---|---|
| certificateType required | The type of certificate. | string |
| certifyingAgenciesDetails optional | Details about the agencies certifying this credential. | < CertifyingAgencyDetail > array |
ErrorList
A list of error responses returned when a request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| errors required | A list of errors. | < Error > array |
GetShipmentLineItemReportsResponse
The response schema for the GetShipmentLineItemReports operation.
| Name | Description | Schema |
|---|---|---|
| shipmentLineItemsReport required | The list of shipment line items matching the search criteria. | < ShipmentLineItemReport > array |
| nextPageToken required | A token to retrieve the next page of results. | string |
| size optional | Number of shipment line items in the response. | integer |
Package
Represents a package in a shipment.
| Name | Description | Schema |
|---|---|---|
| trackingId required | The tracking identifier assigned by the carrier for package tracking purposes. | string |
| packageId required | The identifier that represents this package in the shipment. | string |
Seller
Information about the seller of a line item.
| Name | Description | Schema |
|---|---|---|
| name required | The name of the seller. | string |
| primaryAddress required | The primary address of the seller. | Address |
| credentials optional | Comprehensive information about seller's credentials including basic and detailed credential data. | SellerCredentials |
Region
The region where the order was placed. If the business has not placed orders in that region or does not belong to that region, the result would be empty.
Type : enum
| Value | Description |
|---|---|
| DE | Germany |
| FR | France |
| UK | United Kingdom |
| IT | Italy |
| ES | Spain |
| IN | India |
| US | United States of America |
| CA | Canada |
| MX | Mexico |
| JP | Japan |
| AU | Australia |
Updated about 8 hours ago