node-red-contrib-rollun-aws-sp-api

{ "swagger": "2.0", "info": { "description": "Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. \n\n_Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don't show up in the response).", "version": "v0", "title": "Selling Partner API for Orders", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" }, "license": { "name": "Apache License 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0" } }, "host": "sellingpartnerapi-na.amazon.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/orders/v0/orders": { "get": { "tags": [ "ordersV0" ], "description": "Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. \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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.", "operationId": "getOrders", "parameters": [ { "name": "CreatedAfter", "in": "query", "description": "Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.\n\n**Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.", "required": false, "type": "string" }, { "name": "CreatedBefore", "in": "query", "description": "Use this date to select orders created before (or at) a specified time. 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.\n\n**Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.", "required": false, "type": "string" }, { "name": "LastUpdatedAfter", "in": "query", "description": "Use this date to select 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](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.\n\n**Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set.", "required": false, "type": "string" }, { "name": "LastUpdatedBefore", "in": "query", "description": "Use this date to select 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](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.\n\n**Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time.", "required": false, "type": "string" }, { "name": "OrderStatuses", "in": "query", "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.)", "required": false, "type": "array", "items": { "type": "string" } }, { "name": "MarketplaceIds", "in": "query", "description": "A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces.\n\nRefer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.", "required": true, "type": "array", "items": { "type": "string" }, "maxItems": 50 }, { "name": "FulfillmentChannels", "in": "query", "description": "A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. \n\n**Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller).", "required": false, "type": "array", "items": { "type": "string" } }, { "name": "PaymentMethods", "in": "query", "description": "A list of payment method values. Use this field to select orders that were paid with the specified payment methods.\n\n**Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS).", "required": false, "type": "array", "items": { "type": "string" } }, { "name": "BuyerEmail", "in": "query", "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.", "required": false, "type": "integer" }, { "name": "EasyShipShipmentStatuses", "in": "query", "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.)", "required": false, "type": "array", "items": { "type": "string" } }, { "name": "ElectronicInvoiceStatuses", "in": "query", "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.)", "required": false, "type": "array", "items": { "type": "string" } }, { "name": "NextToken", "in": "query", "description": "A string token returned in the response of your previous request.", "required": false, "type": "string" }, { "name": "AmazonOrderIds", "in": "query", "description": "A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.", "required": false, "type": "array", "items": { "type": "string" }, "maxItems": 50 }, { "name": "ActualFulfillmentSupplySourceId", "in": "query", "description": "The `sourceId` of the location from where you want the order fulfilled.", "required": false, "type": "string" }, { "name": "IsISPU", "in": "query", "description": "When true, this order is marked to be picked up from a store rather than delivered.", "required": false, "type": "boolean" }, { "name": "StoreChainStoreId", "in": "query", "description": "The store chain store identifier. Linked to a specific store in a store chain.", "required": false, "type": "string" }, { "name": "EarliestDeliveryDateBefore", "in": "query", "description": "Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "required": false, "type": "string" }, { "name": "EarliestDeliveryDateAfter", "in": "query", "description": "Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "required": false, "type": "string" }, { "name": "LatestDeliveryDateBefore", "in": "query", "description": "Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "required": false, "type": "string" }, { "name": "LatestDeliveryDateAfter", "in": "query", "description": "Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/GetOrdersResponse" }, "examples": { "application/json": { "payload": { "NextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4", "Orders": [ { "AmazonOrderId": "902-3159896-1390916", "PurchaseDate": "2017-01-20T19:49:35Z", "LastUpdateDate": "2017-01-20T19:49:35Z", "OrderStatus": "Pending", "FulfillmentChannel": "SellerFulfilled", "NumberOfItemsShipped": 0, "NumberOfItemsUnshipped": 0, "PaymentMethod": "Other", "PaymentMethodDetails": [ "CreditCard", "GiftCerificate" ], "MarketplaceId": "ATVPDKIKX0DER", "ShipmentServiceLevelCategory": "Standard", "OrderType": "StandardOrder", "EarliestShipDate": "2017-01-20T19:51:16Z", "LatestShipDate": "2017-01-25T19:49:35Z", "IsBusinessOrder": false, "IsPrime": false, "IsAccessPointOrder": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, "IsIBA": false, "ShippingAddress": { "Name": "Michigan address", "AddressLine1": "1 Cross St.", "City": "Canton", "StateOrRegion": "MI", "PostalCode": "48817", "CountryCode": "US" }, "BuyerInfo": { "BuyerEmail": "user@example.com", "BuyerName": "John Doe", "BuyerTaxInfo": { "CompanyLegalName": "A Company Name" }, "PurchaseOrderNumber": "1234567890123" } } ] } } }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "CreatedAfter": { "value": "TEST_CASE_200" }, "MarketplaceIds": { "value": [ "ATVPDKIKX0DER" ] } } }, "response": { "payload": { "CreatedBefore": "1.569521782042E9", "Orders": [ { "AmazonOrderId": "902-1845936-5435065", "PurchaseDate": "1970-01-19T03:58:30Z", "LastUpdateDate": "1970-01-19T03:58:32Z", "OrderStatus": "Unshipped", "FulfillmentChannel": "MFN", "SalesChannel": "Amazon.com", "ShipServiceLevel": "Std US D2D Dom", "OrderTotal": { "CurrencyCode": "USD", "Amount": "11.01" }, "NumberOfItemsShipped": 0, "NumberOfItemsUnshipped": 1, "PaymentMethod": "Other", "PaymentMethodDetails": [ "Standard" ], "IsReplacementOrder": false, "MarketplaceId": "ATVPDKIKX0DER", "ShipmentServiceLevelCategory": "Standard", "OrderType": "StandardOrder", "EarliestShipDate": "1970-01-19T03:59:27Z", "LatestShipDate": "1970-01-19T04:05:13Z", "EarliestDeliveryDate": "1970-01-19T04:06:39Z", "LatestDeliveryDate": "1970-01-19T04:15:17Z", "IsBusinessOrder": false, "IsPrime": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, "IsIBA": false, "DefaultShipFromLocationAddress": { "Name": "MFNIntegrationTestMerchant", "AddressLine1": "2201 WESTLAKE AVE", "City": "SEATTLE", "StateOrRegion": "WA", "PostalCode": "98121-2778", "CountryCode": "US", "Phone": "+1 480-386-0930 ext. 73824", "AddressType": "Commercial" }, "FulfillmentInstruction": { "FulfillmentSupplySourceId": "sampleSupplySourceId" }, "IsISPU": false, "IsAccessPointOrder": false, "AutomatedShippingSettings": { "HasAutomatedShippingSettings": false }, "EasyShipShipmentStatus": "PendingPickUp", "ElectronicInvoiceStatus": "NotRequired" }, { "AmazonOrderId": "902-8745147-1934268", "PurchaseDate": "1970-01-19T03:58:30Z", "LastUpdateDate": "1970-01-19T03:58:32Z", "OrderStatus": "Unshipped", "FulfillmentChannel": "MFN", "SalesChannel": "Amazon.com", "ShipServiceLevel": "Std US D2D Dom", "OrderTotal": { "CurrencyCode": "USD", "Amount": "11.01" }, "NumberOfItemsShipped": 0, "NumberOfItemsUnshipped": 1, "PaymentMethod": "Other", "PaymentMethodDetails": [ "Standard" ], "IsReplacementOrder": false, "MarketplaceId": "ATVPDKIKX0DER", "ShipmentServiceLevelCategory": "Standard", "OrderType": "StandardOrder", "EarliestShipDate": "1970-01-19T03:59:27Z", "LatestShipDate": "1970-01-19T04:05:13Z", "EarliestDeliveryDate": "1970-01-19T04:06:39Z", "LatestDeliveryDate": "1970-01-19T04:15:17Z", "IsBusinessOrder": false, "IsPrime": false, "IsAccessPointOrder": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, "IsIBA": false, "EasyShipShipmentStatus": "PendingPickUp", "ElectronicInvoiceStatus": "NotRequired" } ] } } }, { "request": { "parameters": { "CreatedAfter": { "value": "TEST_CASE_200_NEXT_TOKEN" }, "MarketplaceIds": { "value": [ "ATVPDKIKX0DER" ] } } }, "response": { "payload": { "NextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4", "Orders": [ { "AmazonOrderId": "902-3159896-1390916", "PurchaseDate": "2017-01-20T19:49:35Z", "LastUpdateDate": "2017-01-20T19:49:35Z", "OrderStatus": "Pending", "FulfillmentChannel": "SellerFulfilled", "NumberOfItemsShipped": 0, "NumberOfItemsUnshipped": 0, "PaymentMethod": "Other", "PaymentMethodDetails": [ "CreditCard", "GiftCerificate" ], "MarketplaceId": "ATVPDKIKX0DER", "ShipmentServiceLevelCategory": "Standard", "OrderType": "StandardOrder", "EasyShipShipmentStatus": "PendingPickUp", "ElectronicInvoiceStatus": "NotRequired", "EarliestShipDate": "2017-01-20T19:51:16Z", "LatestShipDate": "2017-01-25T19:49:35Z", "IsBusinessOrder": false, "IsPrime": false, "IsAccessPointOrder": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, "IsIBA": false } ] } } }, { "request": { "parameters": { "CreatedAfter": { "value": "TEST_CASE_200_NEXT_TOKEN" }, "MarketplaceIds": { "value": [ "ATVPDKIKX0DER" ] }, "NextToken": { "value": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4" } } }, "response": { "payload": { "Orders": [ { "AmazonOrderId": "902-3159896-1390916", "PurchaseDate": "2017-01-20T19:49:35Z", "LastUpdateDate": "2017-01-20T19:49:35Z", "OrderStatus": "Pending", "FulfillmentChannel": "SellerFulfilled", "NumberOfItemsShipped": 0, "NumberOfItemsUnshipped": 0, "PaymentMethod": "Other", "PaymentMethodDetails": [ "CreditCard", "GiftCerificate" ], "MarketplaceId": "ATVPDKIKX0DER", "ShipmentServiceLevelCategory": "Standard", "OrderType": "StandardOrder", "EasyShipShipmentStatus": "PendingPickUp", "ElectronicInvoiceStatus": "NotRequired", "EarliestShipDate": "2017-01-20T19:51:16Z", "LatestShipDate": "2017-01-25T19:49:35Z", "IsBusinessOrder": false, "IsPrime": false, "IsAccessPointOrder": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, "IsIBA": false } ] } } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/GetOrdersResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "CreatedAfter": { "value": "TEST_CASE_400" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid Input" } ] } } ] } }, "403": { "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/GetOrdersResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/GetOrdersResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/GetOrdersResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/GetOrdersResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/GetOrdersResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } }, "/orders/v0/orders/{orderId}": { "get": { "tags": [ "ordersV0" ], "description": "Returns 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrder", "parameters": [ { "name": "orderId", "in": "path", "description": "An Amazon-defined order identifier, in 3-7-7 format.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/GetOrderResponse" }, "examples": { "application/json": { "payload": { "AmazonOrderId": "902-3159896-1390916", "PurchaseDate": "2017-01-20T19:49:35Z", "LastUpdateDate": "2017-01-20T19:49:35Z", "OrderStatus": "Pending", "FulfillmentChannel": "SellerFulfilled", "NumberOfItemsShipped": 0, "NumberOfItemsUnshipped": 0, "PaymentMethod": "Other", "PaymentMethodDetails": [ "CreditCard", "GiftCerificate" ], "MarketplaceId": "ATVPDKIKX0DER", "ShipmentServiceLevelCategory": "Standard", "OrderType": "StandardOrder", "EarliestShipDate": "2017-01-20T19:51:16Z", "LatestShipDate": "2017-01-25T19:49:35Z", "IsBusinessOrder": false, "IsPrime": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, "IsIBA": false, "DefaultShipFromLocationAddress": { "Name": "MFNIntegrationTestMerchant", "AddressLine1": "2201 WESTLAKE AVE", "City": "SEATTLE", "StateOrRegion": "WA", "PostalCode": "98121-2778", "CountryCode": "US", "Phone": "+1 480-386-0930 ext. 73824", "AddressType": "Commercial" }, "FulfillmentInstruction": { "FulfillmentSupplySourceId": "sampleSupplySourceId" }, "IsISPU": false, "IsAccessPointOrder": false, "ShippingAddress": { "Name": "Michigan address", "AddressLine1": "1 Cross St.", "City": "Canton", "StateOrRegion": "MI", "PostalCode": "48817", "CountryCode": "US" }, "BuyerInfo": { "BuyerEmail": "user@example.com", "BuyerName": "John Doe", "BuyerTaxInfo": { "CompanyLegalName": "A Company Name" }, "PurchaseOrderNumber": "1234567890123" }, "AutomatedShippingSettings": { "HasAutomatedShippingSettings": false } } } }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "orderId": { "value": "TEST_CASE_200" } } }, "response": { "payload": { "AmazonOrderId": "902-1845936-5435065", "PurchaseDate": "1970-01-19T03:58:30Z", "LastUpdateDate": "1970-01-19T03:58:32Z", "OrderStatus": "Unshipped", "FulfillmentChannel": "MFN", "SalesChannel": "Amazon.com", "ShipServiceLevel": "Std US D2D Dom", "OrderTotal": { "CurrencyCode": "USD", "Amount": "11.01" }, "NumberOfItemsShipped": 0, "NumberOfItemsUnshipped": 1, "PaymentMethod": "Other", "PaymentMethodDetails": [ "Standard" ], "IsReplacementOrder": false, "MarketplaceId": "ATVPDKIKX0DER", "ShipmentServiceLevelCategory": "Standard", "OrderType": "StandardOrder", "EarliestShipDate": "1970-01-19T03:59:27Z", "LatestShipDate": "1970-01-19T04:05:13Z", "EarliestDeliveryDate": "1970-01-19T04:06:39Z", "LatestDeliveryDate": "1970-01-19T04:15:17Z", "IsBusinessOrder": false, "IsPrime": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, "IsIBA": false, "DefaultShipFromLocationAddress": { "Name": "MFNIntegrationTestMerchant", "AddressLine1": "2201 WESTLAKE AVE", "City": "SEATTLE", "StateOrRegion": "WA", "PostalCode": "98121-2778", "CountryCode": "US", "Phone": "+1 480-386-0930 ext. 73824", "AddressType": "Commercial" }, "FulfillmentInstruction": { "FulfillmentSupplySourceId": "sampleSupplySourceId" }, "IsISPU": false, "IsAccessPointOrder": false, "AutomatedShippingSettings": { "HasAutomatedShippingSettings": false }, "EasyShipShipmentStatus": "PendingPickUp", "ElectronicInvoiceStatus": "NotRequired" } } }, { "request": { "parameters": { "orderId": { "value": "TEST_CASE_IBA_200" } } }, "response": { "payload": { "AmazonOrderId": "921-3175655-0452641", "PurchaseDate": "2019-05-07T15:42:57.058Z", "LastUpdateDate": "2019-05-08T21:59:59Z", "OrderStatus": "Shipped", "FulfillmentChannel": "AFN", "SalesChannel": "Amazon.de", "ShipServiceLevel": "Standard", "OrderTotal": { "CurrencyCode": "EUR", "Amount": "100.00" }, "NumberOfItemsShipped": 1, "NumberOfItemsUnshipped": 0, "PaymentMethod": "Other", "PaymentMethodDetails": [ "Invoice" ], "IsReplacementOrder": false, "MarketplaceId": "A1PA6795UKMFR9", "ShipmentServiceLevelCategory": "Standard", "OrderType": "StandardOrder", "EarliestShipDate": "1970-01-19T03:59:27Z", "LatestShipDate": "2019-05-08T21:59:59Z", "EarliestDeliveryDate": "2019-05-10T21:59:59Z", "LatestDeliveryDate": "2019-05-12T21:59:59Z", "IsBusinessOrder": true, "IsPrime": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": true, "IsIBA": true, "DefaultShipFromLocationAddress": { "Name": "MFNIntegrationTestMerchant", "AddressLine1": "2201 WESTLAKE AVE", "City": "SEATTLE", "StateOrRegion": "WA", "PostalCode": "98121-2778", "CountryCode": "US", "Phone": "+1 480-386-0930 ext. 73824", "AddressType": "Commercial" }, "FulfillmentInstruction": { "FulfillmentSupplySourceId": "sampleSupplySourceId" }, "IsISPU": false, "IsAccessPointOrder": false, "AutomatedShippingSettings": { "HasAutomatedShippingSettings": false }, "EasyShipShipmentStatus": "PendingPickUp", "ElectronicInvoiceStatus": "NotRequired" } } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/GetOrderResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "orderId": { "value": "TEST_CASE_400" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid Input" } ] } } ] } }, "403": { "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/GetOrderResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/GetOrderResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/GetOrderResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/GetOrderResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/GetOrderResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } }, "/orders/v0/orders/{orderId}/buyerInfo": { "get": { "tags": [ "ordersV0" ], "description": "Returns buyer 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrderBuyerInfo", "parameters": [ { "name": "orderId", "in": "path", "description": "An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/GetOrderBuyerInfoResponse" }, "examples": { "application/json": { "payload": { "AmazonOrderId": "902-3159896-1390916", "BuyerEmail": "user@example.com", "BuyerName": "John Smith", "BuyerTaxInfo": { "CompanyLegalName": "Company Name" }, "PurchaseOrderNumber": "1234567890123" } } }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "orderId": { "value": "TEST_CASE_200" } } }, "response": { "payload": { "AmazonOrderId": "902-1845936-5435065", "BuyerEmail": "fzyrv6gwkhbb15c@example.com", "BuyerName": "MFNIntegrationTestMerchant" } } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/GetOrderBuyerInfoResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "orderId": { "value": "TEST_CASE_400" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid Input" } ] } } ] } }, "403": { "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/GetOrderBuyerInfoResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/GetOrderBuyerInfoResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/GetOrderBuyerInfoResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/GetOrderBuyerInfoResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.",