{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-seller-central/main/json-schema/amazon-seller-central-search-orders-response-schema.json", "title": "SearchOrdersResponse", "description": "A list of orders.", "x-generated": "2026-09-24", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/amazon-seller-central-searchorders-api-openapi.yml#/components/schemas/SearchOrdersResponse", "type": "object", "required": [ "orders" ], "properties": { "orders": { "description": "An array containing all orders that match the search criteria.", "type": "array", "items": { "$ref": "#/$defs/Order" } }, "pagination": { "$ref": "#/$defs/Pagination", "description": "Pagination occurs when a request has results that exceed the response limit. This means the results are divided into individual pages. To retrieve a different page, you must pass the token value as the `paginationToken` query parameter in the subsequent request. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `maxResultsPerPage` and `includedData`, which can be modified between calls. The token will expire after 24 hours. When there are no other pages to fetch, the `pagination` field will be absent from the response." }, "lastUpdatedBefore": { "type": "string", "format": "date-time", "description": "Only orders updated before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "createdBefore": { "type": "string", "format": "date-time", "description": "Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } }, "$defs": { "AddressExtendedFields": { "description": "Additional address components that provide more detailed location information, helping with precise delivery routing. \n\n**Note**: Only available with Brazil shipping addresses.", "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } } }, "Alias": { "description": "An alternative identifier that provides a different way to reference the same order.", "type": "object", "required": [ "aliasId", "aliasType" ], "properties": { "aliasId": { "description": "The alternative identifier value that can be used to reference this order.", "type": "string" }, "aliasType": { "description": "The kind of alternative identifier this represents.\n\n**Possible values**: `SELLER_ORDER_ID`", "type": "string" } } }, "Asin": { "description": "The Amazon Standard Identification Number (ASIN), which uniquely identifies a product (catalog item).", "type": "string" }, "AssociatedOrder": { "description": "Another order that has a direct business relationship with the current order, such as replacements or exchanges.", "type": "object", "properties": { "orderId": { "description": "The unique identifier of the related order that is associated with the current order.", "type": "string" }, "associationType": { "description": "The relationship between the current order and the associated order.\n\n**Possible values**: `REPLACEMENT_ORIGINAL_ID`, `EXCHANGE_ORIGINAL_ID`", "type": "string" } } }, "AssociatedOrderItem": { "description": "An associated order item that a customer has purchased with the product. For example, a tire installation service purchased with tires.", "type": "object", "properties": { "orderId": { "description": "The order identifier of the associated order item.", "type": "string" }, "orderItemId": { "description": "The order item identifier of the associated order item.", "type": "string" }, "associationType": { "description": "The type of association between the order items.\n\n**Possible values**:\n- `VALUE_ADD_SERVICE` (The associated item is a service order)", "type": "string" } } }, "BusinessHour": { "type": "object", "description": "Business days and hours when the destination is open for deliveries.", "properties": { "dayOfWeek": { "type": "string", "description": "Specific day of the week for which operating hours are being defined.", "enum": [ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" ], "x-docgen-enum-table-extension": [ { "value": "SUN", "description": "Sunday" }, { "value": "MON", "description": "Monday" }, { "value": "TUE", "description": "Tuesday" }, { "value": "WED", "description": "Wednesday" }, { "value": "THU", "description": "Thursday" }, { "value": "FRI", "description": "Friday" }, { "value": "SAT", "description": "Saturday" } ] }, "timeWindows": { "type": "array", "description": "Collection of time windows during which the location is available for deliveries on the specified day.", "items": { "$ref": "#/$defs/TimeWindow" } } } }, "Buyer": { "description": "Information about the customer who purchased the order.", "type": "object", "properties": { "buyerName": { "description": "The full name of the customer who placed the order.", "type": "string" }, "buyerEmail": { "description": "The anonymized email address of the buyer. **Note:** Only available for merchant-fulfilled (FBM) orders.", "type": "string" }, "buyerCompanyName": { "description": "The name of the company or organization for a business order.", "type": "string" }, "buyerPurchaseOrderNumber": { "description": "The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout.", "type": "string" } } }, "ConstraintType": { "type": "string", "description": "Classification of the enforcement level required for shipping and delivery constraints.", "enum": [ "MANDATORY" ], "x-docgen-enum-table-extension": [ { "value": "MANDATORY", "description": "Constraint that must be strictly enforced for delivery." } ] }, "CustomerAddress": { "description": "The physical address of the customer.", "type": "object", "properties": { "name": { "description": "The full name of the person who will receive the delivery at this address.", "type": "string" }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "description": "The primary street address.", "type": "string" }, "addressLine2": { "description": "Additional address information.", "type": "string" }, "addressLine3": { "description": "Additional address information.", "type": "string" }, "city": { "description": "The city of the address.", "type": "string" }, "districtOrCounty": { "description": "The district or county of the address.", "type": "string" }, "stateOrRegion": { "description": "The state, province, or region of the address.", "type": "string" }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "description": "The postal code, ZIP code, or equivalent mailing code of the address.", "type": "string" }, "countryCode": { "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format.", "type": "string" }, "phone": { "description": "The contact phone number for delivery coordination and customer communication.\n\n**Note**: The buyer phone number will be suppressed in some cases, including but not limited to:\n\n- All FBA (Fulfillment by Amazon) orders.\n- Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date.", "type": "string" }, "extendedFields": { "description": "Additional address components specific to certain countries that provide more detailed location information.\n\n**Note**: Only available with Brazil shipping addresses.", "$ref": "#/$defs/AddressExtendedFields" }, "addressType": { "description": "The type of location.\n\n**Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`", "type": "string" } } }, "DateTimeRange": { "description": "A time period with start and end boundaries.", "type": "object", "properties": { "earliestDateTime": { "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "type": "string", "format": "date-time" }, "latestDateTime": { "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "type": "string", "format": "date-time" } } }, "Decimal": { "description": "A decimal number with no loss of precision. Follows RFC 7159 for number representation.", "type": "string" }, "DeliveryPreference": { "description": "Contains all delivery instructions that the customer provides for the shipping address.", "type": "object", "properties": { "dropOffLocation": { "type": "string", "description": "The drop-off location selected by the customer." }, "addressInstruction": { "type": "string", "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryTime": { "$ref": "#/$defs/PreferredDeliveryTime", "description": "Business hours and days when the delivery is preferred." }, "deliveryCapabilities": { "type": "array", "items": { "$ref": "#/$defs/PreferredDeliveryCapability" }, "description": "A list of miscellaneous delivery capabilities associated with the shipping address." } } }, "ExceptionDate": { "type": "object", "description": "Special dates when normal business hours are modified or suspended, requiring different delivery scheduling.", "properties": { "exceptionDate": { "description": "Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity.", "type": "string", "format": "date" }, "exceptionDateType": { "description": "Operational status of the business on the specified exception date.", "type": "string", "enum": [ "CLOSED", "OPEN" ], "x-docgen-enum-table-extension": [ { "value": "CLOSED", "description": "Business operations are suspended on this date." }, { "value": "OPEN", "description": "Business operations are active on this date." } ] }, "timeWindows": { "type": "array", "description": "Alternative operating hours that apply specifically to this exception date.", "items": { "$ref": "#/$defs/TimeWindow" } } } }, "FulfillmentOrder": { "description": "Information about a fulfillment order associated with a customer order. A fulfillment order represents a unit of fulfillment created by Amazon for the order. **Note:** Only available for EasyShip orders at present.", "type": "object", "required": [ "fulfillmentOrderId" ], "properties": { "fulfillmentOrderId": { "description": "The Fulfillment Order ID assigned by Amazon after fulfillment planning. This identifier is identical to the Shipment ID required by External Fulfillment APIs.", "type": "string" } } }, "FulfillmentStatus": { "description": "The current fulfillment status of an order, indicating where the order is in the fulfillment process from placement to handover to carrier.", "type": "string", "enum": [ "PENDING_AVAILABILITY", "PENDING", "UNSHIPPED", "PARTIALLY_SHIPPED", "SHIPPED", "CANCELLED", "UNFULFILLABLE" ], "x-docgen-enum-table-extension": [ { "value": "PENDING_AVAILABILITY", "description": "This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future. The order is not ready for shipment." }, { "value": "PENDING", "description": "The order has been placed but is not ready for shipment. For standard orders, the initial order status is `PENDING`. For pre-orders, the initial order status is `PENDING_AVAILABILITY`, and the order passes into the `PENDING` status when payment authorization begins." }, { "value": "UNSHIPPED", "description": "The order is ready for shipment, but no items in the order have been shipped." }, { "value": "PARTIALLY_SHIPPED", "description": "At least one, but not all, items in the order have been shipped." }, { "value": "SHIPPED", "description": "All items have been shipped to the customer." }, { "value": "CANCELLED", "description": "The order has been canceled and will not be fulfilled." }, { "value": "UNFULFILLABLE", "description": "The order cannot be fulfilled. This state only applies to Amazon-fulfilled orders that were not placed on Amazon's retail website." } ] }, "GiftOption": { "description": "Gift wrapping and personalization options selected by the customer for an order item.", "type": "object", "properties": { "giftMessage": { "description": "Personal message from the buyer to be included with the gift-wrapped item.", "type": "string" }, "giftWrapLevel": { "description": "Type or quality level of gift wrapping service selected by the customer.", "type": "string" } } }, "HourMinute": { "type": "object", "description": "The time when the business opens or closes.", "properties": { "hour": { "type": "integer", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "integer", "description": "The minute when the business opens or closes." } } }, "ItemCancellation": { "description": "The cancellation information of the order item.", "type": "object", "properties": { "cancellationRequest": { "description": "Details of the cancellation request submitted for this order item.", "$ref": "#/$defs/ItemCancellationRequest" }, "cancellationExecution": { "description": "Details of how the cancellation was executed for this order item.", "$ref": "#/$defs/ItemCancellationExecution" } } }, "ItemCancellationExecution": { "description": "Details of how the cancellation was executed for a specific order item, including who performed the cancellation and the reason.", "type": "object", "properties": { "cancelledBy": { "description": "Entity that executed the cancellation for this item. \n\n**Possible values**: `BUYER`, `MERCHANT`, `AMAZON`", "type": "string" }, "cancelReason": { "description": "Explanation provided for why the cancellation was executed.", "type": "string" } } }, "ItemCancellationRequest": { "description": "Detailed information about a cancellation request submitted for a specific order item.", "type": "object", "properties": { "requester": { "description": "Entity that initiated the cancellation request for this item. \n\n**Possible values**: `BUYER`", "type": "string" }, "cancelReason": { "description": "Explanation provided for why the cancellation was requested.", "type": "string" } } }, "ItemCondition": { "description": "Detailed information about the physical condition and quality state of the item being sold.", "type": "object", "properties": { "conditionType": { "description": "The primary condition category that broadly describes the item's state.\n\n**Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`.", "type": "string" }, "conditionSubtype": { "description": "A more specific condition classification that provides additional detail about the item's quality within the main condition type.\n\n**Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`, `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`.", "type": "string" }, "conditionNote": { "description": "Additional details provided by the seller to describe the specific condition of this particular item.", "type": "string" } } }, "ItemCustomization": { "description": "Information about any personalization, customization, or special modifications applied to this order item.", "type": "object", "properties": { "customizedUrl": { "description": "The URL of the customized data for custom orders from the Amazon Custom program.", "type": "string" } } }, "ItemExpense": { "description": "The expense information related to this specific item.", "type": "object", "properties": { "pointsCost": { "description": "The cost of points.", "$ref": "#/$defs/ItemPointsCost" } } }, "ItemFulfillment": { "description": "Information about how the order item should be processed, packed, and shipped to the customer.", "type": "object", "properties": { "quantityFulfilled": { "description": "The number of units of this item that have been successfully processed and shipped.", "type": "integer" }, "quantityUnfulfilled": { "description": "The number of units of this item that remain to be processed and shipped.", "type": "integer" }, "picking": { "description": "Information related to the warehouse picking process for this item.", "$ref": "#/$defs/ItemPicking" }, "packing": { "description": "Information related to the packaging process for this item.", "$ref": "#/$defs/ItemPacking" }, "shipping": { "description": "Information related to the shipping and delivery process for this item.", "$ref": "#/$defs/ItemShipping" } } }, "ItemInternationalShipping": { "description": "Additional requirements needed for cross-border shipping of an order item.", "type": "object", "properties": { "iossNumber": { "description": "Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale.", "type": "string" } } }, "ItemPacking": { "description": "Information related to the packaging process for an order item.", "type": "object", "properties": { "giftOption": { "description": "Gift wrapping and messaging specified for this item.", "$ref": "#/$defs/GiftOption" }, "serialNumberRequirement": { "description": "Whether serial numbers must be provided for this line item.", "$ref": "#/$defs/SerialNumberRequirement" } } }, "ItemPicking": { "description": "Information related to the warehouse picking process for an order item.", "type": "object", "properties": { "substitutionPreference": { "description": "Substitution preference for an order item when it becomes unavailable during fulfillment.", "$ref": "#/$defs/ItemSubstitutionPreference" } } }, "ItemPointsCost": { "description": "Information about Amazon Points granted with the purchase of an item, including both quantity and monetary equivalent value.", "type": "object", "properties": { "pointsGranted": { "description": "Details of the Amazon Points granted, including count and monetary value.", "$ref": "#/$defs/PointsGranted" } } }, "ItemPrice": { "description": "Pricing information for the order item.", "type": "object", "properties": { "unitPrice": { "description": "The price charged for a single unit of this product, before any quantity-based calculations.", "$ref": "#/$defs/Money" }, "priceDesignation": { "description": "Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business).\n\n**Possible value**: `BUSINESS_PRICE`", "type": "string" } } }, "ItemProceeds": { "description": "The money that the seller receives from the sale of this specific item.", "type": "object", "properties": { "proceedsTotal": { "description": "The total monetary amount for this order item.", "$ref": "#/$defs/Money" }, "breakdowns": { "description": "The breakdown of proceeds.", "type": "array", "items": { "$ref": "#/$defs/ItemProceedsBreakdown" } } } }, "ItemProceedsBreakdown": { "description": "Detailed proceeds breakdown for a specific order item.", "type": "object", "required": [ "type", "subtotal" ], "properties": { "type": { "description": "Category classification of the proceeds breakdown. \n\n**Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`", "type": "string" }, "subtotal": { "description": "Monetary amount for the proceeds breakdown.", "$ref": "#/$defs/Money" }, "detailedBreakdowns": { "description": "Further granular breakdown of the subtotal.", "type": "array", "items": { "$ref": "#/$defs/ItemProceedsDetailedBreakdown" } } } }, "ItemProceedsDetailedBreakdown": { "description": "Further granular breakdown of the subtotal of the proceeds breakdown, only available for TAX and DISCOUNT proceeds types.", "type": "object", "properties": { "subtype": { "description": "Specific classification of the further granular breakdown. \n\n**Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`", "type": "string" }, "value": { "description": "Monetary amount for the further granular breakdown.", "$ref": "#/$defs/Money" } } }, "ItemProduct": { "description": "Product information for an order item.", "type": "object", "properties": { "asin": { "description": "The Amazon Standard Identification Number (ASIN) of the item.", "$ref": "#/$defs/Asin" }, "title": { "description": "The product name or title as displayed to customers in the marketplace.", "type": "string" }, "sellerSku": { "description": "The item's seller stock keeping unit (SKU).", "$ref": "#/$defs/SKU" }, "condition": { "description": "Information about the physical condition and quality of the item being sold.", "$ref": "#/$defs/ItemCondition" }, "price": { "description": "Pricing information for this product.", "$ref": "#/$defs/ItemPrice" }, "serialNumbers": { "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders.", "type": "array", "items": { "type": "string" } }, "customization": { "description": "Information about any personalization or customization applied to this product.", "$ref": "#/$defs/ItemCustomization" } } }, "ItemPromotion": { "description": "Details about any discounts, coupons, or promotional offers applied to this item.", "type": "object", "properties": { "breakdowns": { "description": "A list of promotions applied to the order item.", "type": "array", "items": { "$ref": "#/$defs/ItemPromotionBreakdown" } } } }, "ItemPromotionBreakdown": { "description": "Detailed information about a specific promotional offer applied to an order item.", "type": "object", "properties": { "promotionId": { "description": "Unique identifier for the promotion applied to this item.", "type": "string" } } }, "ItemShipping": { "description": "Information related to the shipping and delivery process for an order item.", "type": "object", "properties": { "scheduledDeliveryWindow": { "description": "When this item is expected to be delivered to the customer.", "$ref": "#/$defs/DateTimeRange" }, "shippingConstraints": { "description": "Special shipping requirements and restrictions that apply to this item.", "$ref": "#/$defs/ItemShippingConstraints" }, "internationalShipping": { "description": "Additional information needed for cross-border delivery of this item.", "$ref": "#/$defs/ItemInternationalShipping" } } }, "ItemShippingConstraints": { "description": "Special shipping requirements and restrictions that must be observed when shipping an order item.", "type": "object", "properties": { "palletDelivery": { "description": "The line item must be delivered by pallet.", "$ref": "#/$defs/ConstraintType" }, "cashOnDelivery": { "description": "Payment must be collected from the customer at the time of delivery.", "$ref": "#/$defs/ConstraintType" }, "signatureConfirmation": { "description": "The recipient of the line item must sign to confirm its delivery.", "$ref": "#/$defs/ConstraintType" }, "recipientIdentityVerification": { "description": "The person receiving the line item must be the same as the intended recipient of the order.", "$ref": "#/$defs/ConstraintType" }, "recipientAgeVerification": { "description": "The carrier must confirm that the recipient is of the legal age to receive the line item upon delivery.", "$ref": "#/$defs/ConstraintType" } } }, "ItemSubstitutionOption": { "type": "object", "description": "Alternative product that can be substituted for an original order item when it becomes unavailable during fulfillment.", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number of the substitute product." }, "quantityOrdered": { "type": "integer", "description": "Number of units of the substitute item to be selected if substitution occurs." }, "sellerSku": { "type": "string", "description": "The item's seller stock keeping unit (SKU)." }, "title": { "type": "string", "description": "Product name or title of the substitute item as displayed to customers." }, "measurement": { "description": "Unit of measure and quantity specifications for the substitute product.", "$ref": "#/$defs/Measurement" } } }, "ItemSubstitutionPreference": { "type": "object", "description": "Substitution preference for an order item when it becomes unavailable during fulfillment.", "required": [ "substitutionType" ], "properties": { "substitutionType": { "type": "string", "description": "Source and nature of the substitution preferences for this item.", "enum": [ "CUSTOMER_PREFERENCE", "AMAZON_RECOMMENDED", "DO_NOT_SUBSTITUTE" ], "x-docgen-enum-table-extension": [ { "value": "CUSTOMER_PREFERENCE", "description": "Substitution preferences defined by the customer" }, { "value": "AMAZON_RECOMMENDED", "description": "Substitution options suggested by Amazon's system" }, { "value": "DO_NOT_SUBSTITUTE", "description": "Prohibition against any item substitutions" } ] }, "substitutionOptions": { "type": "array", "description": "List of alternative products that can be substituted for the original item if it becomes unavailable.", "items": { "$ref": "#/$defs/ItemSubstitutionOption" } } } }, "ItemTax": { "description": "Tax information for an order item.", "type": "object", "properties": { "taxCalculationBreakdowns": { "description": "A list of tax calculation breakdowns for the order item.", "type": "array", "items": { "$ref": "#/$defs/ItemTaxCalculationBreakdown" } }, "taxCollections": { "description": "A list of tax collections for the order item.", "type": "array", "items": { "$ref": "#/$defs/ItemTaxCollection" } } } }, "ItemTaxCalculationBreakdown": { "description": "Tax calculation breakdowns for an order item.", "type": "object", "properties": { "reportingScheme": { "description": "The tax reporting scheme applied to this order item.\n\n**Possible values**:\n- `UOSS` (Union one stop shop. The item being purchased is held in the EU for shipment)\n- `IOSS` (Import one stop shop. The item being purchased is not held in the EU for shipment)", "type": "string" } } }, "ItemTaxCollection": { "description": "Tax collection information for an order item.", "type": "object", "properties": { "model": { "description": "The tax collection model applied to the item.\n\n**Possible values**:\n- `MARKETPLACE_FACILITATOR` (Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller)", "type": "string" }, "responsibleParty": { "description": "The party responsible for withholding the taxes and remitting them to the taxing authority.", "type": "string" } } }, "Measurement": { "type": "object", "description": "Specifies the unit of measure and quantity for items that are sold by weight, volume, length, or other measurements rather than simple count.", "required": [ "unit", "value" ], "properties": { "unit": { "type": "string", "description": "The specific unit of measurement used to quantify this item.", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "x-docgen-enum-table-extension": [ { "value": "OUNCES", "description": "The item is measured in ounces." }, { "value": "POUNDS", "description": "The item is measured in pounds." }, { "value": "KILOGRAMS", "description": "The item is measured in kilograms." }, { "value": "GRAMS", "description": "The item is measured in grams." }, { "value": "MILLIGRAMS", "description": "The item is measured in milligrams." }, { "value": "INCHES", "description": "The item is measured in inches." }, { "value": "FEET", "description": "The item is measured in feet." }, { "value": "METERS", "description": "The item is measured in meters." }, { "value": "CENTIMETERS", "description": "The item is measured in centimeters." }, { "value": "MILLIMETERS", "description": "The item is measured in millimeters." }, { "value": "SQUARE_METERS", "description": "The item is measured in square meters." }, { "value": "SQUARE_CENTIMETERS", "description": "The item is measured in square centimeters." }, { "value": "SQUARE_FEET", "description": "The item is measured in square feet." }, { "value": "SQUARE_INCHES", "description": "The item is measured in square inches." }, { "value": "GALLONS", "description": "The item is measured in gallons." }, { "value": "PINTS", "description": "The item is measured in pints." }, { "value": "QUARTS", "description": "The item is measured in quarts." }, { "value": "FLUID_OUNCES", "description": "The item is measured in fluid ounces." }, { "value": "LITERS", "description": "The item is measured in liters." }, { "value": "CUBIC_METERS", "description": "The item is measured in cubic meters." }, { "value": "CUBIC_FEET", "description": "The item is measured in cubic feet." }, { "value": "CUBIC_INCHES", "description": "The item is measured in cubic inches." }, { "value": "CUBIC_CENTIMETERS", "description": "The item is measured in cubic centimeters." }, { "value": "COUNT", "description": "The item is measured by count." } ] }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } } }, "MerchantAddress": { "description": "The physical address of the merchant.", "type": "object", "properties": { "name": { "description": "The name of the business or facility at this address.", "type": "string" }, "addressLine1": { "description": "The primary street address of the merchant's location.", "type": "string" }, "addressLine2": { "description": "Additional address information.", "type": "string" }, "addressLine3": { "description": "Additional address information.", "type": "string" }, "city": { "description": "The city of the address.", "type": "string" }, "districtOrCounty": { "description": "The district or county of the address.", "type": "string" }, "stateOrRegion": { "description": "The state, province, or region of the address.", "type": "string" }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "description": "The postal code or ZIP code of the address.", "type": "string" }, "countryCode": { "description": "The two-letter country code for the address, in ISO 3166-1 format.", "type": "string" } } }, "Money": { "description": "An amount of money, including units in the form of currency.", "properties": { "amount": { "$ref": "#/$defs/Decimal" }, "currencyCode": { "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards.", "type": "string" } }, "required": [ "amount", "currencyCode" ], "type": "object" }, "Order": { "description": "Comprehensive information about a customer order.", "type": "object", "required": [ "orderId", "createdTime", "lastUpdatedTime", "salesChannel", "orderItems" ], "properties": { "orderId": { "description": "An Amazon-defined order identifier.", "type": "string" }, "orderAliases": { "description": "Alternative identifiers that can be used to reference this order, such as seller-defined order numbers.", "type": "array", "items": { "$ref": "#/$defs/Alias" } }, "createdTime": { "type": "string", "format": "date-time", "description": "The time when the customer placed the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "lastUpdatedTime": { "type": "string", "format": "date-time", "description": "The most recent time when any aspect of this order was modified by Amazon or the seller. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "programs": { "type": "array", "description": "Special programs associated with this order that may affect fulfillment or customer experience. \n\n**Possible values**: `AMAZON_BAZAAR`, `AMAZON_BUSINESS`, `AMAZON_EASY_SHIP`, `AMAZON_HAUL`, `DELIVERY_BY_AMAZON`, `FBM_SHIP_PLUS`, `INVOICE_BY_AMAZON`, `IN_STORE_PICK_UP`, `PREMIUM`, `PREORDER`, `PRIME`", "items": { "type": "string" } }, "associatedOrders": { "description": "Other orders that have a direct relationship to this order, such as replacement or exchange orders.", "type": "array", "items": { "$ref": "#/$defs/AssociatedOrder" } }, "salesChannel": { "description": "Information about where this order was placed.", "$ref": "#/$defs/SalesChannel" }, "buyer": { "description": "Information about the customer who purchased this order.", "$ref": "#/$defs/Buyer" }, "recipient": { "description": "Information about the person or location where this order should be delivered.", "$ref": "#/$defs/Recipient" }, "proceeds": { "description": "Financial information about this order.", "$ref": "#/$defs/OrderProceeds" }, "payment": { "description": "Payment information for the order.", "$ref": "#/$defs/OrderPayment" }, "tax": { "description": "Tax-related information for the order.", "$ref": "#/$defs/OrderTax" }, "fulfillment": { "description": "Information about how this order is being processed and shipped.", "$ref": "#/$defs/OrderFulfillment" }, "orderItems": { "description": "The list of all order items included in this order.", "type": "array", "items": { "$ref": "#/$defs/OrderItem" } }, "packages": { "description": "Shipping packages created for this order, including tracking information. **Note:** Only available for merchant-fulfilled (FBM) orders.", "type": "array", "items": { "$ref": "#/$defs/OrderPackage" } }, "fulfillmentOrders": { "description": "The list of fulfillment orders associated with this customer order. Each entry corresponds to one fulfillment unit created by Amazon for this order. **Note:** Only available for EasyShip orders at present.", "type": "array", "items": { "$ref": "#/$defs/FulfillmentOrder" } } } }, "OrderFulfillment": { "description": "Information about how the order is being processed, packed, and shipped to the customer.", "type": "object", "required": [ "fulfillmentStatus" ], "properties": { "fulfillmentStatus": { "description": "The current status of the order in the fulfillment process, from pending to handover to carrier.", "$ref": "#/$defs/FulfillmentStatus" }, "fulfilledBy": { "description": "Specifies whether Amazon or the merchant is responsible for fulfilling this order.\n\n**Possible values**: `AMAZON`, `MERCHANT`.", "type": "string" }, "fulfillmentServiceLevel": { "description": "The category of the shipping speed option selected by the customer at checkout.\n\n**Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`.", "type": "string" }, "shipByWindow": { "description": "The promised time period within which the order must be shipped to meet the customer's delivery expectations.", "$ref": "#/$defs/DateTimeRange" }, "deliverByWindow": { "description": "The promised time period within which the order should be delivered to the customer.", "$ref": "#/$defs/DateTimeRange" }, "labelPrintingWindow": { "description": "The earliest time available to print the shipping label for the order. Printing is available any time after the earliestDateTime. Response does not include a latestDateTime.\n\nNote: If blank, printing is available at any time.", "$ref": "#/$defs/DateTimeRange" } } }, "OrderItem": { "description": "Information about a single product within an order.", "type": "object", "required": [ "orderItemId", "quantityOrdered", "product" ], "properties": { "orderItemId": { "description": "A unique identifier for this specific item within the order.", "type": "string" }, "quantityOrdered": { "description": "The number of units of this item that the customer ordered.", "type": "integer" }, "measurement": { "description": "The unit of measure and value for items sold by weight, volume, or other measurements rather than simple count.", "$ref": "#/$defs/Measurement" }, "associatedOrderItems": { "description": "A list of order items associated with this item. For example, a value-add service purchased with the product.", "type": "array", "items": { "$ref": "#/$defs/AssociatedOrderItem" } }, "programs": { "type": "array", "description": "Special programs that apply specifically to this item within the order.\n\n**Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`", "items": { "type": "string" } }, "product": { "description": "Information about the product being ordered.", "$ref": "#/$defs/ItemProduct" }, "proceeds": { "description": "The money that the seller receives from the sale of this specific item.", "$ref": "#/$defs/ItemProceeds" }, "expense": { "description": "The expense information related to this specific item.", "$ref": "#/$defs/ItemExpense" }, "promotion": { "description": "Details about any discounts, coupons, or promotional offers applied to this item.", "$ref": "#/$defs/ItemPromotion" }, "cancellation": { "description": "The cancellation information of the order item.", "$ref": "#/$defs/ItemCancellation" }, "fulfillment": { "description": "Information about how the order item should be processed, packed, and shipped to the customer.", "$ref": "#/$defs/ItemFulfillment" }, "tax": { "description": "Tax-related information for this order item.", "$ref": "#/$defs/ItemTax" } } }, "OrderPackage": { "description": "Information about a physical shipping package, including tracking details. **Note:** Only available for merchant-fulfilled (FBM) orders.", "type": "object", "required": [ "packageReferenceId" ], "properties": { "packageReferenceId": { "description": "A unique identifier for this package within the context of the order.", "type": "string" }, "createdTime": { "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "type": "string", "format": "date-time" }, "packageStatus": { "description": "The current status of this package.", "$ref": "#/$defs/PackageStatus" }, "carrier": { "description": "The carrier responsible for transporting this package to the customer.", "type": "string" }, "shipTime": { "description": "The exact time when this package was handed over to the carrier and began its journey to the customer. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "type": "string", "format": "date-time" }, "shippingService": { "description": "The specific shipping method or service used for delivering this package.", "type": "string" }, "trackingNumber": { "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress.", "type": "string" }, "shipFromAddress": { "description": "The physical address from which this package was shipped, typically the merchant's warehouse or fulfillment center.", "$ref": "#/$defs/MerchantAddress" }, "packageItems": { "description": "A list of all order items included in this specific package.", "type": "array", "items": { "$ref": "#/$defs/PackageItem" } } } }, "OrderPayment": { "description": "Payment information about the order.", "type": "object", "properties": { "paymentExecutions": { "description": "A list of payment executions for the order.", "type": "array", "items": { "$ref": "#/$defs/PaymentExecution" } } } }, "OrderProceeds": { "description": "The money that the seller receives from the sale of the order.", "type": "object", "properties": { "grandTotal": { "description": "The total amount that the seller receives from the sale of the order.", "$ref": "#/$defs/Money" }, "breakdowns": { "description": "Categorized proceeds for the order. Proceed categories are either aggregated across all order items (such as `ITEM`, `SHIPPING`, and `TAX`) or applied at the order level (such as `DELIVERY_TIP`).", "type": "array", "items": { "$ref": "#/$defs/OrderProceedsBreakdown" } } } }, "OrderProceedsBreakdown": { "description": "An entry detailing proceeds information.", "type": "object", "required": [ "type", "subtotal" ], "properties": { "type": { "description": "The proceeds category. \n\n**Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `TAX`, `DISCOUNT`, `DELIVERY_TIP`, `OTHER`. **Note:** `DELIVERY_TIP` is charged separately and not attributed to a specific item. The remaining categories are aggregated across all order items.", "type": "string" }, "status": { "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`.\n\n**Possible values**: `PENDING`, `FINALIZED`.", "type": "string" }, "subtotal": { "description": "The monetary amount for the proceeds category.", "$ref": "#/$defs/Money" } } }, "OrderTax": { "description": "Tax information about the order.", "type": "object", "properties": { "taxRegistrations": { "description": "A list of tax registrations associated with the order.", "type": "array", "items": { "$ref": "#/$defs/OrderTaxRegistration" } }, "taxInvoicing": { "description": "Tax invoicing information for the order.", "$ref": "#/$defs/OrderTaxInvoicing" } } }, "OrderTaxInvoicing": { "description": "Tax invoicing information for the order.", "type": "object", "properties": { "buyerInvoicePreference": { "description": "The buyer's invoicing preference, which indicates whether the seller should issue an individual or a business invoice to the buyer. \n\n **Note**: This attribute is only available in the Turkey marketplace. \n\n**Possible values**:\n- `INDIVIDUAL` (Issues an individual invoice to the buyer)\n- `BUSINESS` (Issues a business invoice to the buyer)", "type": "string" }, "invoiceStatus": { "description": "The status of the invoice. Only available for Easy Ship orders and orders in the Brazil marketplace.\n\n**Possible values**:\n- `NOT_REQUIRED` (The order does not require an electronic invoice to be uploaded)\n- `NOT_FOUND` (The order requires an electronic invoice but it is not uploaded)\n- `PROCESSING` (The required electronic invoice was uploaded and is processing)\n- `ERRORED` (The uploaded electronic invoice was not accepted)\n- `ACCEPTED` (The uploaded electronic invoice was accepted)", "type": "string" } } }, "OrderTaxRegistration": { "description": "Tax registration information for an entity associated with the order.", "type": "object", "properties": { "entityType": { "description": "The type of entity that the tax registration belongs to.\n\n**Possible values**:\n- `BUYER` (Indicates that this is the buyer's tax registration information)\n- `MERCHANT` (Indicates that this is the merchant's tax registration information)\n- `MARKETPLACE` (Indicates that this is the marketplace's tax registration information)", "type": "string" }, "legalName": { "description": "The legal name associated with the tax registration.", "type": "string" }, "taxRegistrationType": { "description": "The type of the tax registration number.\n\n**Possible values**: `BUSINESS`, `VAT`, `CST`, `CPF`, `CNPJ`", "type": "string" }, "taxRegistrationNumber": { "description": "The tax registration number that identifies the entity for tax purposes.", "type": "string" }, "taxRegistrationAddress": { "description": "The address associated with the tax registration.", "$ref": "#/$defs/CustomerAddress" }, "taxRegistrationAttributes": { "description": "Additional attributes related to the tax registration.", "type": "array", "items": { "$ref": "#/$defs/TaxRegistrationAttribute" } } } }, "PackageItem": { "description": "Individual order item contained within a shipping package.", "type": "object", "required": [ "orderItemId", "quantity" ], "properties": { "orderItemId": { "description": "Unique identifier of the order item included in this package.", "type": "string" }, "quantity": { "description": "Number of units of this item included in the package shipment.", "type": "integer" }, "transparencyCodes": { "description": "The transparency codes associated with this item for product authentication.", "type": "array", "items": { "type": "string" } } } }, "PackageStatus": { "description": "Current status and detailed tracking information for a shipping package throughout the delivery process.", "type": "object", "required": [ "status" ], "properties": { "status": { "description": "Primary status classification of the package in the shipping workflow.", "type": "string", "enum": [ "PENDING", "IN_TRANSIT", "SHIPPED", "DELIVERED", "CANCELLED", "UNDELIVERABLE" ], "x-docgen-enum-table-extension": [ { "value": "PENDING", "description": "Package preparation stage before carrier handoff" }, { "value": "IN_TRANSIT", "description": "Package movement phase within carrier network" }, { "value": "SHIPPED", "description": "Package dispatch confirmation to customer" }, { "value": "DELIVERED", "description": "Package completion at final destination" }, { "value": "CANCELLED", "description": "Package shipment termination before delivery" }, { "value": "UNDELIVERABLE", "description": "Package delivery failure" } ] }, "detailedStatus": { "description": "Granular status information providing specific details about the package's current location and handling stage. \n\n**Possible values**:\n- `PENDING_SCHEDULE` (Package awaiting pickup scheduling)\n- `PENDING_PICK_UP` (Package ready for carrier collection from seller)\n- `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier)\n- `LABEL_CANCELLED` (Shipping label canceled by seller)\n- `PICKED_UP` (Package collected by carrier from seller location)\n- `DROPPED_OFF` (Package delivered to carrier by seller)\n- `AT_ORIGIN_FC` (Package at originating fulfillment center)\n- `AT_DESTINATION_FC` (Package at destination fulfillment center)\n- `DELIVERED` (Package successfully delivered to recipient)\n- `REJECTED_BY_BUYER` (Package refused by intended recipient)\n- `UNDELIVERABLE` (Package cannot be delivered due to address or access issues)\n- `RETURNING_TO_SELLER` (Package in transit back to seller)\n- `RETURNED_TO_SELLER` (Package successfully returned to seller)\n- `LOST` (Package location unknown or confirmed lost)\n- `OUT_FOR_DELIVERY` (Package on delivery vehicle for final delivery)\n- `DAMAGED` (Package damaged during transit)\n", "type": "string" } } }, "Pagination": { "type": "object", "description": "Pagination occurs when a request has results that exceed the response limit. This means the results are divided into individual pages. To retrieve a different page, you must pass the token value as the `paginationToken` query parameter in the subsequent request. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `maxResultsPerPage` and `includedData`, which can be modified between calls. The token will expire after 24 hours. When there are no other pages to fetch, the `pagination` field will be absent from the response.", "properties": { "nextToken": { "description": "A token that can be used to fetch the next page of results.", "type": "string" } } }, "PaymentExecution": { "description": "Payment execution details for an order.", "type": "object", "properties": { "paymentMethod": { "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on).", "type": "string" }, "paymentAmount": { "description": "The monetary value of the payment execution.", "$ref": "#/$defs/Money" }, "acquirerId": { "description": "The unique identifier of the payment processor or acquiring bank that authorizes the payment. \n\n**Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`.", "type": "string" }, "cardBrand": { "description": "The card network or brand used in the payment transaction (for example, Visa or Mastercard).\n\n**Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard`.", "type": "string" }, "authorizationCode": { "description": "The unique code that confirms the payment authorization.\n\n**Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`.", "type": "string" } } }, "PointsGranted": { "description": "Information about Amazon Points awarded with an item purchase.", "type": "object", "properties": { "pointsNumber": { "type": "integer", "description": "Total number of Amazon Points granted to the customer's account for this item purchase." }, "pointsMonetaryValue": { "description": "Cash equivalent value of the awarded Amazon Points.", "$ref": "#/$defs/Money" } } }, "PreferredDeliveryCapability": { "description": "Special delivery capabilities available at the shipping address that may affect delivery options and methods. \n\n**Possible values**:\n- `HAS_ACCESS_POINT` (Delivery location includes designated pickup or drop-off access points)\n- `PALLET_ENABLED` (Address is equipped to receive large pallet deliveries)\n- `PALLET_DISABLED` (Address cannot accommodate pallet delivery methods)", "type": "string" }, "PreferredDeliveryTime": { "type": "object", "description": "Customer-specified time preferences for when deliveries should be attempted at the destination address.", "properties": { "businessHours": { "type": "array", "items": { "$ref": "#/$defs/BusinessHour" }, "description": "Business hours when the business is open for deliveries." }, "exceptionDates": { "type": "array", "items": { "$ref": "#/$defs/ExceptionDate" }, "description": "Specific dates within the next 30 days when normal business hours do not apply." } } }, "Recipient": { "description": "Information about the recipient to whom the order should be delivered.", "type": "object", "properties": { "deliveryAddress": { "description": "The address where the order should be delivered to the customer.", "$ref": "#/$defs/CustomerAddress" }, "deliveryPreference": { "description": "Special instructions and preferences that the customer specifies for how the order should be delivered.", "$ref": "#/$defs/DeliveryPreference" } } }, "SKU": { "description": "The seller SKU of a product (catalog item). This is a unique number assigned by the seller when listing an item.", "type": "string" }, "SalesChannel": { "description": "Information about where the customer placed this order.", "type": "object", "required": [ "channelName" ], "properties": { "channelName": { "description": "The name of the sales platform or channel where the customer placed this order.\n\n**Possible values**: `AMAZON`, `NON_AMAZON`", "type": "string" }, "marketplaceId": { "description": "The unique identifier for the specific marketplace within the sales channel where this order was placed.", "type": "string" }, "marketplaceName": { "description": "The human-readable name of the marketplace where this order was placed.", "type": "string" } } }, "SerialNumberRequirement": { "description": "Whether serial numbers must be provided for this line item.", "type": "object", "properties": { "requirementType": { "description": "The requirement type for this request. \n\n**Possible values**: `REQUIRED`", "type": "string" } } }, "TaxRegistrationAttribute": { "description": "An additional attribute associated with a tax registration.", "type": "object", "properties": { "key": { "description": "The name of the tax registration attribute.\n\n**Possible values**: `TAX_OFFICE`", "type": "string" }, "value": { "description": "The value of the tax registration attribute.", "type": "string" } } }, "TimeWindow": { "type": "object", "description": "Specific time interval defining the start and end times.", "properties": { "startTime": { "$ref": "#/$defs/HourMinute", "description": "The beginning of the time window." }, "endTime": { "$ref": "#/$defs/HourMinute", "description": "The end of the time window." } } } } }