"description":"The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.",
"description":"Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description":"A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.",
"required":false,
"type":"string"
},
{
"name":"CreatedBefore",
"in":"query",
"description":"A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.",
"required":false,
"type":"string"
},
{
"name":"LastUpdatedAfter",
"in":"query",
"description":"A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.",
"required":false,
"type":"string"
},
{
"name":"LastUpdatedBefore",
"in":"query",
"description":"A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.",
"description":"A list of `OrderStatus` values used to filter the results.\n\n**Possible values:**\n- `PendingAvailability` (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.)\n- `Pending` (The order has been placed but payment has not been authorized.)\n- `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.)\n- `PartiallyShipped` (One or more, but not all, items in the order have been shipped.)\n- `Shipped` (All items in the order have been shipped.)\n- `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.)\n- `Canceled` (The order has been canceled.)\n- `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)",
"description":"A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.\n\nSee the [Selling Partner API Developer Guide](doc:marketplace-ids) for a complete list of marketplaceId values.",
"description":"A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller).",
"description":"A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).",
"description":"The email address of a buyer. Used to select orders that contain the specified email address.",
"required":false,
"type":"string"
},
{
"name":"SellerOrderId",
"in":"query",
"description":"An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.",
"required":false,
"type":"string"
},
{
"name":"MaxResultsPerPage",
"in":"query",
"description":"A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.",
"description":"A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned.\n\n**Possible values:**\n- `PendingSchedule` (The package is awaiting the schedule for pick-up.)\n- `PendingPickUp` (Amazon has not yet picked up the package from the seller.)\n- `PendingDropOff` (The seller will deliver the package to the carrier.)\n- `LabelCanceled` (The seller canceled the pickup.)\n- `PickedUp` (Amazon has picked up the package from the seller.)\n- `DroppedOff` (The package is delivered to the carrier by the seller.)\n- `AtOriginFC` (The packaged is at the origin fulfillment center.)\n- `AtDestinationFC` (The package is at the destination fulfillment center.)\n- `Delivered` (The package has been delivered.)\n- `RejectedByBuyer` (The package has been rejected by the buyer.)\n- `Undeliverable` (The package cannot be delivered.)\n- `ReturningToSeller` (The package was not delivered and is being returned to the seller.)\n- `ReturnedToSeller` (The package was not delivered and was returned to the seller.)\n- `Lost` (The package is lost.)\n- `OutForDelivery` (The package is out for delivery.)\n- `Damaged` (The package was damaged by the carrier.)",
"description":"A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values.\n\n**Possible values:**\n- `NotRequired` (Electronic invoice submission is not required for this order.)\n- `NotFound` (The electronic invoice was not submitted for this order.)\n- `Processing` (The electronic invoice is being processed for this order.)\n- `Errored` (The last submitted electronic invoice was rejected for this order.)\n- `Accepted` (The last submitted electronic invoice was submitted and accepted.)",
"description":"Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Returns the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Returns buyer information for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Returns the shipping address for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Returns detailed order item information for the order that you specify. If NextToken is provided, it's used to retrieve the next page of order items.\n\n__Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Returns buyer information for the order items in the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Update the shipment status for an order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 15 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns regulated information for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Updates (approves or rejects) the verification status of an order containing regulated products.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Returns detailed order items approvals information for the order specified. If NextToken is provided, it's used to retrieve the next page of order items approvals.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.5 | 30 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
"operationId":"getOrderItemsApprovals",
"parameters":[
{
"name":"orderId",
"in":"path",
"description":"An Amazon-defined order identifier, in 3-7-7 format, e.g. 933-1671587-0818628.",
"description":"Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"The frequency of requests was greater than allowed.",
"schema":{
"$ref":"#/definitions/GetOrderApprovalsResponse"
},
"headers":{
"x-amzn-RateLimit-Limit":{
"type":"string",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema":{
"$ref":"#/definitions/GetOrderApprovalsResponse"
},
"headers":{
"x-amzn-RateLimit-Limit":{
"type":"string",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Temporary overloading or maintenance of the server.",
"schema":{
"$ref":"#/definitions/GetOrderApprovalsResponse"
},
"headers":{
"x-amzn-RateLimit-Limit":{
"type":"string",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Update the order items approvals for an order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 15 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId":"updateOrderItemsApprovals",
"parameters":[
{
"name":"orderId",
"in":"path",
"description":"An Amazon-defined order identifier, in 3-7-7 format.",
"required":true,
"type":"string"
},
{
"name":"payload",
"in":"body",
"description":"The request body for the updateOrderItemsApprovals operation.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Updates the shipment confirmation status for a specified order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId":"confirmShipment",
"parameters":[
{
"name":"orderId",
"in":"path",
"description":"An Amazon-defined order identifier, in 3-7-7 format.",
"required":true,
"type":"string"
},
{
"name":"payload",
"in":"body",
"description":"Request body of confirmShipment.",
"required":true,
"schema":{
"$ref":"#/definitions/ConfirmShipmentRequest"
}
}
],
"responses":{
"204":{
"description":"Success.",
"headers":{
"x-amzn-RateLimit-Limit":{
"type":"string",
"description":"Your rate limit (requests per second) for this operation."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"The updated values of the VerificationStatus field.",
"type":"object",
"properties":{
"status":{
"description":"The new verification status of the order.",
"$ref":"#/definitions/VerificationStatus"
},
"externalReviewerId":{
"description":"The identifier for the order's regulated information reviewer.",
"type":"string"
},
"rejectionReasonId":{
"description":"The unique identifier for the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected.",
"description":"A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. All dates must be in ISO 8601 format."
"description":"A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format."
"description":"The date when the order was last updated.\n\n__Note__: LastUpdateDate is returned with an incorrect date for orders that were last updated before 2009-04-01."
"description":"The order has been placed but payment has not been authorized. The order is not ready for shipment. Note that for orders with OrderType = Standard, the initial order status is Pending. For orders with OrderType = Preorder, the initial order status is PendingAvailability, and the order passes into the Pending status when the payment authorization process begins."
},
{
"value":"Unshipped",
"description":"Payment has been authorized and order is ready for shipment, but no items in the order have been shipped."
},
{
"value":"PartiallyShipped",
"description":"One or more (but not all) items in the order have been shipped."
},
{
"value":"Shipped",
"description":"All items in the order have been shipped."
},
{
"value":"Canceled",
"description":"The order was canceled."
},
{
"value":"Unfulfillable",
"description":"The order cannot be fulfilled. This state applies only to Amazon-fulfilled orders that were not placed on Amazon's retail web site."
},
{
"value":"InvoiceUnconfirmed",
"description":"All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer."
},
{
"value":"PendingAvailability",
"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."
"description":"Information about sub-payment methods for a Cash On Delivery (COD) order.\n\n__Note__: For a COD order that is paid for using one sub-payment method, one PaymentExecutionDetailItem object is returned, with PaymentExecutionDetailItem/PaymentMethod = COD. For a COD order that is paid for using multiple sub-payment methods, two or more PaymentExecutionDetailItem objects are returned.",
"description":"The payment method for the order. This property is limited to Cash On Delivery (COD) and Convenience Store (CVS) payment methods. Unless you need the specific COD payment information provided by the PaymentExecutionDetailItem object, we recommend using the PaymentMethodDetails property to get payment method information.",
"description":"An order that contains items for which the selling partner currently has inventory in stock."
},
{
"value":"LongLeadTimeOrder",
"description":"An order that contains items that have a long lead time to ship."
},
{
"value":"Preorder",
"description":"An order that contains items with a release date that is in the future."
},
{
"value":"BackOrder",
"description":"An order that contains items that already have been released in the market but are currently out of stock and will be available in the future."
"description":"The start of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.\n\n__Note__: EarliestShipDate might not be returned for orders placed before February 1, 2013."
"description":"The end of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.\n\n__Note__: LatestShipDate might not be returned for orders placed before February 1, 2013."
"description":"The start of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders."
"description":"The end of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders that do not have a PendingAvailability, Pending, or Canceled status."
"description":"When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, see \"Premium Shipping Options\" in the Seller Central Help for your marketplace."
"description":"Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders."
"description":"When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller."
"description":"When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller."
"description":"The recommended location for the seller to ship the items from. It is calculated at checkout. The seller may or may not choose to ship from this location.",
"description":"When true, this order is marked to be delivered to an Access Point. The access location is chosen by the customer. Access Points include Amazon Hub Lockers, Amazon Hub Counters, and pickup points operated by carriers."
"description":"Contains information regarding the Shipping Settings Automaton program, such as whether the order's shipping settings were generated automatically, and what those settings are.",
"description":"The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout."
"description":"The order is pending approval. Note that the approval might be needed from someone other than the merchant as determined by the RequiresMerchantAction property."
"description":"The content of the field as collected in regulatory form. Note that FileAttachment type fields will contain a URL to download the attachment here."
"description":"The number and value of Amazon Points granted with the purchase of an item.",
"$ref":"#/definitions/PointsGrantedDetail"
},
"ItemPrice":{
"description":"The selling price of the order item. Note that an order item is an item and a quantity. This means that the value of ItemPrice is equal to the selling price of the item multiplied by the quantity ordered. Note that ItemPrice excludes ShippingPrice and GiftWrapPrice.",
"$ref":"#/definitions/Money"
},
"ShippingPrice":{
"description":"The shipping price of the item.",
"$ref":"#/definitions/Money"
},
"ItemTax":{
"description":"The tax on the item price.",
"$ref":"#/definitions/Money"
},
"ShippingTax":{
"description":"The tax on the shipping price.",
"$ref":"#/definitions/Money"
},
"ShippingDiscount":{
"description":"The discount on the shipping price.",
"$ref":"#/definitions/Money"
},
"ShippingDiscountTax":{
"description":"The tax on the discount on the shipping price.",
"$ref":"#/definitions/Money"
},
"PromotionDiscount":{
"description":"The total of all promotional discounts in the offer.",
"$ref":"#/definitions/Money"
},
"PromotionDiscountTax":{
"description":"The tax on the total of all promotional discounts in the offer.",
"description":"Indicates that the selling price is a special price that is available only for Amazon Business orders. For more information about the Amazon Business Seller Program, see the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). \n\nPossible values: BusinessPrice - A special price that is available only for Amazon Business orders."
"description":"The IOSS number for the marketplace. Sellers shipping to the European Union (EU) from outside of the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale."
"description":"The category of deemed reseller. This applies to selling partners that are not based in the EU and is used to help them meet the VAT Deemed Reseller tax laws in the EU and UK.",
"description":"The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout."
"description":"Contains information regarding the Shipping Settings Automation program, such as whether the order's shipping settings were generated automatically, and what those settings are.",
"description":"Approval process required to fulfill Leonardi order items."
}
],
"description":"Defines the approval process types available for order items."
},
"ItemApprovalStatus":{
"type":"string",
"enum":[
"PENDING_SELLING_PARTNER_APPROVAL",
"PROCESSING_SELLING_PARTNER_APPROVAL",
"PENDING_AMAZON_APPROVAL",
"APPROVED",
"APPROVED_WITH_CHANGES",
"DECLINED"
],
"x-docgen-enum-table-extension":[
{
"value":"PENDING_SELLING_PARTNER_APPROVAL",
"description":"Approval process requires an approval action from the selling partner."
},
{
"value":"PROCESSING_SELLING_PARTNER_APPROVAL",
"description":"Amazon is processing the selling partner's approval action."
},
{
"value":"PENDING_AMAZON_APPROVAL",
"description":"Approval process requires an approval action from Amazon."
},
{
"value":"APPROVED",
"description":"All steps of the approval process are complete and the item is approved."
},
{
"value":"APPROVED_WITH_CHANGES",
"description":"All steps of the approval process are complete and the item is approved with some changes. This state is only possible if the approval process type allows item level changes."
},
{
"value":"DECLINED",
"description":"All steps of the approval process are complete and the item is declined."
}
],
"description":"Defines the possible status of an order item approval."
},
"ItemApprovalContext":{
"description":"Generic item approval context. Check the applicable restrictions at the specific approval type schemas.",
"type":"object",
"required":[
"ApprovalType",
"ApprovalStatus"
],
"properties":{
"ApprovalType":{
"$ref":"#/definitions/ItemApprovalType",
"description":"The approval process type required for the order item."
},
"ApprovalStatus":{
"$ref":"#/definitions/ItemApprovalStatus",
"description":"Current status of the order item approval."
"description":"List of additional data elements supporting the approval process. Check the applicable restrictions at the specific approval type schemas."
}
}
},
"ApprovalSupportDataElementList":{
"type":"array",
"items":{
"$ref":"#/definitions/ApprovalSupportDataElement"
},
"description":"List of additional data elements supporting the approval process. Check the applicable restrictions at the specific approval type schemas."
},
"ApprovalSupportDataElement":{
"description":"<Name, Value> tuple to define item approval support data elements.",
"type":"object",
"required":[
"Name",
"Value"
],
"properties":{
"Name":{
"type":"string",
"description":"Name of the approval support element. Allowed names are defined in specific approval types schemas."
},
"Value":{
"type":"string",
"description":"String value of the approval support element."
}
}
},
"ItemApproval":{
"description":"Generic item approval. Check the applicable restrictions at the specific approval type schemas.",
"type":"object",
"required":[
"SequenceId",
"Timestamp",
"Actor",
"ApprovalAction",
"ApprovalActionProcessStatus"
],
"properties":{
"SequenceId":{
"type":"integer",
"description":"Sequence number of the item approval. Each ItemApproval gets its sequenceId automatically from a monotonic increasing function."
},
"Timestamp":{
"type":"string",
"description":"Timestamp when the ItemApproval was recorded by Amazon's internal order approvals system. In ISO 8601 date time format."
},
"Actor":{
"type":"string",
"enum":[
"SELLING_PARTNER",
"AMAZON"
],
"x-docgen-enum-table-extension":[
{
"value":"SELLING_PARTNER",
"description":"High level actor to which the approval actions are assigned when triggered by the selling partner."
},
{
"value":"AMAZON",
"description":"High level actor to which the approval actions are assigned when triggered by Amazon."
}
],
"description":"High level actors involved in the approval process."
},
"Approver":{
"type":"string",
"description":"Person or system that triggers the approval actions on behalf of the actor."
},
"ApprovalAction":{
"$ref":"#/definitions/ItemApprovalAction",
"description":"Approval action that defines the behavior of the ItemApproval."
},
"ApprovalActionProcessStatus":{
"type":"string",
"enum":[
"PROCESSING",
"SUCCESS",
"ERROR"
],
"x-docgen-enum-table-extension":[
{
"value":"PROCESSING",
"description":"Amazon is processing the item approval action triggered by the selling partner."
"description":"An error occurred while processing the item approval action. The approval action is ignored."
}
],
"description":"Status of approval action."
},
"ApprovalActionProcessStatusMessage":{
"type":"string",
"description":"Optional message to communicate optional additional context about the current status of the approval action."
}
}
},
"ItemApprovalAction":{
"description":"This object represents an approval action used by the actors in the order item approval process. Check the applicable restrictions at the specific approval type schemas.",
"type":"object",
"required":[
"ActionType"
],
"properties":{
"ActionType":{
"type":"string",
"enum":[
"APPROVE",
"DECLINE",
"APPROVE_WITH_CHANGES"
],
"x-docgen-enum-table-extension":[
{
"value":"APPROVE",
"description":"Defines the action of approving the order item."
},
{
"value":"DECLINE",
"description":"Defines the action of declining the order item."
},
{
"value":"APPROVE_WITH_CHANGES",
"description":"Defines the action of a conditional approval, i.e. the order item approval is only valid if the required changes are made to the order item."
}
],
"description":"Defines the type of action for the approval."
},
"Comment":{
"type":"string",
"description":"Comment message to provide optional additional context on the approval action."
},
"Changes":{
"type":"object",
"properties":{
"ItemPrice":{
"$ref":"#/definitions/Money",
"description":"Price to be charged to the customer for each unit of the item. If substitutedBy is specified, this value applies to the substitution item."
},
"Quantity":{
"type":"integer",
"description":"Quantity approved. If substitutedBy is specified, this value applies to the substitution item."
},
"SubstitutedBy":{
"$ref":"#/definitions/ItemIdentifier",
"description":"Identifier of the item to substitute this item in the order."
}
},
"description":"Changes required for the approval. Each approval type defines the allowed changes valid sub-set in its specific schema."
}
}
},
"ItemIdentifier":{
"description":"Item identifiers used in the context of approvals operations.",
"type":"object",
"required":[
"IdentifierType",
"Identifier"
],
"properties":{
"IdentifierType":{
"type":"string",
"enum":[
"ASIN",
"SELLER_SKU",
"EXTERNAL_ID"
],
"x-docgen-enum-table-extension":[
{
"value":"ASIN",
"description":"The Amazon Standard Identification Number (ASIN) of the item."
},
{
"value":"SELLER_SKU",
"description":"The seller stock keeping unit (SKU) of the item."
},
{
"value":"EXTERNAL_ID",
"description":"An external id, e.g. EAN or UPC. Approval specific schemas will define the restrictions on the allowed external identifiers."
}
],
"description":"Defines the type of identifiers allowed to specify a substitution."
},
"Identifier":{
"type":"string"
}
}
},
"GetOrderApprovalsResponse":{
"type":"object",
"properties":{
"payload":{
"description":"The payload for the getOrderItemsApprovals operation.",
"$ref":"#/definitions/OrderApprovalsResponse"
},
"errors":{
"description":"One or more unexpected errors occurred during the getOrderItemsApprovals operation.",
"$ref":"#/definitions/ErrorList"
}
},
"description":"The response schema for the getOrderApprovalsItems operation."
},
"OrderApprovalsResponse":{
"type":"object",
"required":[
"OrderItemsApprovalsList"
],
"properties":{
"NextToken":{
"type":"string",
"description":"When present and not empty, pass this string token in the next request to return the next response page."
},
"OrderItemsApprovalsList":{
"type":"array",
"description":"List of OrderItemApprovals.",
"items":{
"$ref":"#/definitions/OrderItemApprovals"
}
}
},
"description":"The order items list with approvals along with the order ID."
},
"OrderItemApprovals":{
"type":"object",
"description":"List of item approvals gathered during the approval process.",
"required":[
"OrderItemId",
"ApprovalType",
"ApprovalStatus",
"ItemApprovals"
],
"properties":{
"OrderItemId":{
"description":"The unique identifier of the order item.",
"type":"string"
},
"ApprovalType":{
"$ref":"#/definitions/ItemApprovalType",
"description":"The approval process type required for the order item."
},
"ApprovalStatus":{
"$ref":"#/definitions/ItemApprovalStatus",
"description":"Current status of the order item approval."
},
"ItemApprovals":{
"type":"array",
"items":{
"$ref":"#/definitions/ItemApproval"
}
}
}
},
"UpdateOrderApprovalsRequest":{
"description":"The request body for the updateOrderItemsApprovals operation.",
"type":"object",
"required":[
"OrderItemsApprovalRequests"
],
"properties":{
"Approver":{
"type":"string",
"description":"Person or system that triggers the approval actions on behalf of the actor."
},
"OrderItemsApprovalRequests":{
"type":"array",
"description":"A list of item approval requests.",
"description":"The unique identifier of the order item.",
"type":"string"
},
"ApprovalAction":{
"$ref":"#/definitions/ItemApprovalAction",
"description":"Approval action that defines the behavior of the ItemApproval."
}
}
},
"UpdateItemsApprovalsErrorResponse":{
"type":"object",
"properties":{
"errors":{
"description":"One or more unexpected errors occurred during the updateOrderItemsApprovals operation.",
"$ref":"#/definitions/ErrorList"
}
},
"description":"The error response schema for the updateOrderItemsApprovals operation."
},
"ConfirmShipmentRequest":{
"type":"object",
"required":[
"marketplaceId",
"packageDetail"
],
"properties":{
"packageDetail":{
"$ref":"#/definitions/PackageDetail"
},
"codCollectionMethod":{
"type":"string",
"description":"The cod collection method, support in JP only. ",
"enum":["DirectPayment"]
},
"marketplaceId":{
"$ref":"#/definitions/MarketplaceId"
}
},
"description":"The request schema for an shipment confirmation."
},
"ConfirmShipmentErrorResponse":{
"type":"object",
"description":"The error response schema for an shipment confirmation.",
"properties":{
"errors":{
"description":"One or more unexpected errors occurred during the confirmShipment operation.",
"$ref":"#/definitions/ErrorList"
}
}
},
"PackageDetail":{
"type":"object",
"description":"Properties of packages",
"required":[
"packageReferenceId",
"carrierCode",
"trackingNumber",
"shipDate",
"orderItems"
],
"properties":{
"packageReferenceId":{
"$ref":"#/definitions/PackageReferenceId"
},
"carrierCode":{
"type":"string",
"description":"Identifies the carrier that will deliver the package. This field is required for all marketplaces, see [reference](https://developer-docs.amazon.com/sp-api/changelog/carriercode-value-required-in-shipment-confirmations-for-br-mx-ca-sg-au-in-jp-marketplaces)."
},
"carrierName":{
"type":"string",
"description":"Carrier Name that will deliver the package. Required when carrierCode is \"Others\" "
},
"shippingMethod":{
"type":"string",
"description":"Ship method to be used for shipping the order."
},
"trackingNumber":{
"type":"string",
"description":"The tracking number used to obtain tracking and delivery information."
},
"shipDate":{
"type":"string",
"description":"The shipping date for the package. Must be in ISO-8601 date/time format.",
"format":"date-time"
},
"shipFromSupplySourceId":{
"type":"string",
"description":"The unique identifier of the supply source."
},
"orderItems":{
"description":"The list of order items and quantities to be updated.",