diff --git a/README.md b/README.md index bfa94f28b..1cf88798d 100644 --- a/README.md +++ b/README.md @@ -277,10 +277,18 @@ $sellerConnector = SellingPartnerApi::seller(/* ... */); ```php $feedsApi = $sellerConnector->feedsV20210630(); ``` +* **Finances API (v2024-06-19)** ([docs](https://developer-docs.amazon.com/sp-api/docs/finances-api-v2024-06-19-reference)) + ```php + $financesApi = $sellerConnector->financesV20240619(); + ``` * **Finances API (v0)** ([docs](https://developer-docs.amazon.com/sp-api/docs/finances-api-reference)) ```php $financesApi = $sellerConnector->financesV0(); ``` +* **Invoices API (v2024-06-19)** ([docs](https://developer-docs.amazon.com/sp-api/docs/invoices-api-v2024-06-19-reference)) + ```php + $invoicesApi = $sellerConnector->invoicesV20240619(); + ``` * **Listings Items API (v2021-08-01)** ([docs](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference)) ```php $listingsItemsApi = $sellerConnector->listingsItemsV20210801(); diff --git a/resources/apis.json b/resources/apis.json index 6d5a4e1cb..89a5c377d 100644 --- a/resources/apis.json +++ b/resources/apis.json @@ -1,432 +1,445 @@ { - "seller": { - "amazon-warehousing-distribution": { - "name": "Amazon Warehousing and Distribution", - "versions": [ - { - "version": "2024-05-09", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json" - } - ] - }, - "application-management": { - "name": "Application Management", - "versions": [ - { - "version": "2023-11-30", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/application-management-api-model/application_2023-11-30.json" - } - ] - }, - "a-plus-content": { - "name": "A Plus Content", - "versions": [ - { - "version": "2020-11-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/aplus-content-api-model/aplusContent_2020-11-01.json" - } - ] - }, - "catalog-items": { - "name": "Catalog Items", - "versions": [ - { - "version": 0, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/catalog-items-api-model/catalogItemsV0.json" - }, - { - "version": "2020-12-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/catalog-items-api-model/catalogItems_2020-12-01.json" - }, - { - "version": "2022-04-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/catalog-items-api-model/catalogItems_2022-04-01.json" - } - ] - }, - "data-kiosk": { - "name": "Data Kiosk", - "versions": [ - { - "version": "2023-11-15", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/data-kiosk-api-model/dataKiosk_2023-11-15.json" - } - ] - }, - "easy-ship": { - "name": "Easy Ship", - "versions": [ - { - "version": "2022-03-23", - "url": "https://github.com/amzn/selling-partner-api-models/raw/main/models/easy-ship-model/easyShip_2022-03-23.json" - } - ] - }, - "fba-inbound-eligibility": { - "name": "FBA Inbound Eligibility", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/fba-inbound-eligibility-api-model/fbaInbound.json" - } - ] - }, - "fba-inbound": { - "name": "FBA Inbound", - "versions": [ - { - "version": 0, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/fulfillment-inbound-api-model/fulfillmentInboundV0.json" - }, - { - "version": "2024-03-20", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/fulfillment-inbound-api-model/fulfillmentInbound_2024-03-20.json" - } - ] - }, - "fba-inventory": { - "name": "FBA Inventory", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/fba-inventory-api-model/fbaInventory.json" - } - ] - }, - "fba-outbound": { - "name": "FBA Outbound", - "versions": [ - { - "version": "2020-07-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json" - } - ] - }, - "feeds": { - "name": "Feeds", - "versions": [ - { - "version": "2021-06-30", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/feeds-api-model/feeds_2021-06-30.json" - } - ] - }, - "finances": { - "name": "Finances", - "versions": [ - { - "version": 0, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/finances-api-model/financesV0.json" - } - ] - }, - "listings-restrictions": { - "name": "Listings Restrictions", - "versions": [ - { - "version": "2021-08-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/listings-restrictions-api-model/listingsRestrictions_2021-08-01.json" - } - ] - }, - "listings-items": { - "name": "Listings Items", - "versions": [ - { - "version": "2020-09-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/listings-items-api-model/listingsItems_2020-09-01.json" - }, - { - "version": "2021-08-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/listings-items-api-model/listingsItems_2021-08-01.json" - } - ] - }, - "merchant-fulfillment": { - "name": "Merchant Fulfillment", - "versions": [ - { - "version": 0, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/merchant-fulfillment-api-model/merchantFulfillmentV0.json" - } - ] - }, - "messaging": { - "name": "Messaging", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/messaging-api-model/messaging.json" - } - ] - }, - "notifications": { - "name": "Notifications", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/notifications-api-model/notifications.json" - } - ] - }, - "orders": { - "name": "Orders", - "versions": [ - { - "version": 0, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/orders-api-model/ordersV0.json" - } - ] - }, - "product-fees": { - "name": "Product Fees", - "versions": [ - { - "version": 0, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/product-fees-api-model/productFeesV0.json" - } - ] - }, - "product-pricing": { - "name": "Product Pricing", - "versions": [ - { - "version": 0, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/product-pricing-api-model/productPricingV0.json" - }, - { - "version": "2022-05-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/product-pricing-api-model/productPricing_2022-05-01.json" - } - ] - }, - "product-type-definitions": { - "name": "Product Type Definitions", - "versions": [ - { - "version": "2020-09-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/product-type-definitions-api-model/definitionsProductTypes_2020-09-01.json" - } - ] - }, - "replenishment": { - "name": "Replenishment", - "versions": [ - { - "version": "2022-11-07", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/replenishment-api-model/replenishment-2022-11-07.json" - } - ] - }, - "reports": { - "name": "Reports", - "versions": [ - { - "version": "2021-06-30", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/reports-api-model/reports_2021-06-30.json" - } - ] - }, - "sales": { - "name": "Sales", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/sales-api-model/sales.json" - } - ] - }, - "sellers": { - "name": "Sellers", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/sellers-api-model/sellers.json" - } - ] - }, - "services": { - "name": "Services", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/services-api-model/services.json" - } - ] - }, - "shipment-invoicing": { - "name": "Shipment Invoicing", - "versions": [ - { - "version": 0, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/shipment-invoicing-api-model/shipmentInvoicingV0.json" - } - ] - }, - "shipping": { - "name": "Shipping", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/shipping-api-model/shipping.json", - "deprecated": true - }, - { - "version": 2, - "url": "https://developer-docs.amazon.com/amazon-shipping/docs/shipping-api-v2-model", - "selector": "code[data-lang='json']" - } - ] - }, - "solicitations": { - "name": "Solicitations", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/solicitations-api-model/solicitations.json" - } - ] - }, - "supply-sources": { - "name": "Supply Sources", - "versions": [ - { - "version": "2020-07-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/supply-sources-api-model/supplySources_2020-07-01.json" - } - ] - }, - "tokens": { - "name": "Tokens", - "versions": [ - { - "version": "2021-03-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/tokens-api-model/tokens_2021-03-01.json" - } - ] - }, - "transfers": { - "name": "Transfers", - "versions": [ - { - "version": "2024-06-01", - "url": "https://developer-docs.amazon.com/sp-api/docs/transfers-api-v2024-06-01-model", - "selector": "code[data-lang='json']" - } - ] - }, - "uploads": { - "name": "Uploads", - "versions": [ - { - "version": "2020-11-01", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/uploads-api-model/uploads_2020-11-01.json" - } - ] - } - }, - "vendor": { - "direct-fulfillment-inventory": { - "name": "Direct Fulfillment Inventory", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-inventory-api-model/vendorDirectFulfillmentInventoryV1.json" - } - ] - }, - "direct-fulfillment-orders": { - "name": "Direct Fulfillment Orders", - "versions": [ - { - "version": "2021-12-28", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrders_2021-12-28.json" - }, - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrdersV1.json" - } - ] - }, - "direct-fulfillment-payment": { - "name": "Direct Fulfillment Payment", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-payments-api-model/vendorDirectFulfillmentPaymentsV1.json" - } - ] - }, - "direct-fulfillment-sandbox": { - "name": "Direct Fulfillment Sandbox", - "versions": [ - { - "version": "2021-10-28", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-sandbox-test-data-api-model/vendorDirectFulfillmentSandboxData_2021-10-28.json" - } - ] - }, - "direct-fulfillment-shipping": { - "name": "Direct Fulfillment Shipping", - "versions": [ - { - "version": "2021-12-28", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-shipping-api-model/vendorDirectFulfillmentShipping_2021-12-28.json" - }, - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-shipping-api-model/vendorDirectFulfillmentShippingV1.json" - } - ] - }, - "direct-fulfillment-transactions": { - "name": "Direct Fulfillment Transactions", - "versions": [ - { - "version": "2021-12-28", - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-transactions-api-model/vendorDirectFulfillmentTransactions_2021-12-28.json" - }, - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-transactions-api-model/vendorDirectFulfillmentTransactionsV1.json" - } - ] - }, - "invoices": { - "name": "Invoices", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-invoices-api-model/vendorInvoices.json" - } - ] - }, - "orders": { - "name": "Orders", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-orders-api-model/vendorOrders.json" - } - ] - }, - "shipments": { - "name": "Shipments", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-shipments-api-model/vendorShipments.json" - } - ] - }, - "transaction-status": { - "name": "Transaction Status", - "versions": [ - { - "version": 1, - "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-transaction-status-api-model/vendorTransactionStatus.json" + "seller": { + "amazon-warehousing-distribution": { + "name": "Amazon Warehousing and Distribution", + "versions": [ + { + "version": "2024-05-09", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json" + } + ] + }, + "application-management": { + "name": "Application Management", + "versions": [ + { + "version": "2023-11-30", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/application-management-api-model/application_2023-11-30.json" + } + ] + }, + "a-plus-content": { + "name": "A Plus Content", + "versions": [ + { + "version": "2020-11-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/aplus-content-api-model/aplusContent_2020-11-01.json" + } + ] + }, + "catalog-items": { + "name": "Catalog Items", + "versions": [ + { + "version": 0, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/catalog-items-api-model/catalogItemsV0.json" + }, + { + "version": "2020-12-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/catalog-items-api-model/catalogItems_2020-12-01.json" + }, + { + "version": "2022-04-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/catalog-items-api-model/catalogItems_2022-04-01.json" + } + ] + }, + "data-kiosk": { + "name": "Data Kiosk", + "versions": [ + { + "version": "2023-11-15", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/data-kiosk-api-model/dataKiosk_2023-11-15.json" + } + ] + }, + "easy-ship": { + "name": "Easy Ship", + "versions": [ + { + "version": "2022-03-23", + "url": "https://github.com/amzn/selling-partner-api-models/raw/main/models/easy-ship-model/easyShip_2022-03-23.json" + } + ] + }, + "fba-inbound-eligibility": { + "name": "FBA Inbound Eligibility", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/fba-inbound-eligibility-api-model/fbaInbound.json" + } + ] + }, + "fba-inbound": { + "name": "FBA Inbound", + "versions": [ + { + "version": 0, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/fulfillment-inbound-api-model/fulfillmentInboundV0.json" + }, + { + "version": "2024-03-20", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/fulfillment-inbound-api-model/fulfillmentInbound_2024-03-20.json" + } + ] + }, + "fba-inventory": { + "name": "FBA Inventory", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/fba-inventory-api-model/fbaInventory.json" + } + ] + }, + "fba-outbound": { + "name": "FBA Outbound", + "versions": [ + { + "version": "2020-07-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json" + } + ] + }, + "feeds": { + "name": "Feeds", + "versions": [ + { + "version": "2021-06-30", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/feeds-api-model/feeds_2021-06-30.json" + } + ] + }, + "finances": { + "name": "Finances", + "versions": [ + { + "version": "2024-06-19", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/refs/heads/main/models/finances-api-model/finances_2024-06-19.json" + }, + { + "version": 0, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/finances-api-model/financesV0.json" + } + ] + }, + "invoices": { + "name": "Invoices", + "versions": [ + { + "version": "2024-06-19", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/refs/heads/main/models/invoices-api-model/InvoicesApiModel_2024-06-19.json" + } + ] + }, + "listings-restrictions": { + "name": "Listings Restrictions", + "versions": [ + { + "version": "2021-08-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/listings-restrictions-api-model/listingsRestrictions_2021-08-01.json" + } + ] + }, + "listings-items": { + "name": "Listings Items", + "versions": [ + { + "version": "2020-09-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/listings-items-api-model/listingsItems_2020-09-01.json" + }, + { + "version": "2021-08-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/listings-items-api-model/listingsItems_2021-08-01.json" + } + ] + }, + "merchant-fulfillment": { + "name": "Merchant Fulfillment", + "versions": [ + { + "version": 0, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/merchant-fulfillment-api-model/merchantFulfillmentV0.json" + } + ] + }, + "messaging": { + "name": "Messaging", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/messaging-api-model/messaging.json" + } + ] + }, + "notifications": { + "name": "Notifications", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/notifications-api-model/notifications.json" + } + ] + }, + "orders": { + "name": "Orders", + "versions": [ + { + "version": 0, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/orders-api-model/ordersV0.json" + } + ] + }, + "product-fees": { + "name": "Product Fees", + "versions": [ + { + "version": 0, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/product-fees-api-model/productFeesV0.json" + } + ] + }, + "product-pricing": { + "name": "Product Pricing", + "versions": [ + { + "version": 0, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/product-pricing-api-model/productPricingV0.json" + }, + { + "version": "2022-05-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/product-pricing-api-model/productPricing_2022-05-01.json" + } + ] + }, + "product-type-definitions": { + "name": "Product Type Definitions", + "versions": [ + { + "version": "2020-09-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/product-type-definitions-api-model/definitionsProductTypes_2020-09-01.json" + } + ] + }, + "replenishment": { + "name": "Replenishment", + "versions": [ + { + "version": "2022-11-07", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/replenishment-api-model/replenishment-2022-11-07.json" + } + ] + }, + "reports": { + "name": "Reports", + "versions": [ + { + "version": "2021-06-30", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/reports-api-model/reports_2021-06-30.json" + } + ] + }, + "sales": { + "name": "Sales", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/sales-api-model/sales.json" + } + ] + }, + "sellers": { + "name": "Sellers", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/sellers-api-model/sellers.json" + } + ] + }, + "services": { + "name": "Services", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/services-api-model/services.json" + } + ] + }, + "shipment-invoicing": { + "name": "Shipment Invoicing", + "versions": [ + { + "version": 0, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/shipment-invoicing-api-model/shipmentInvoicingV0.json" + } + ] + }, + "shipping": { + "name": "Shipping", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/shipping-api-model/shipping.json", + "deprecated": true + }, + { + "version": 2, + "url": "https://developer-docs.amazon.com/amazon-shipping/docs/shipping-api-v2-model", + "selector": "code[data-lang='json']" + } + ] + }, + "solicitations": { + "name": "Solicitations", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/solicitations-api-model/solicitations.json" + } + ] + }, + "supply-sources": { + "name": "Supply Sources", + "versions": [ + { + "version": "2020-07-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/supply-sources-api-model/supplySources_2020-07-01.json" + } + ] + }, + "tokens": { + "name": "Tokens", + "versions": [ + { + "version": "2021-03-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/tokens-api-model/tokens_2021-03-01.json" + } + ] + }, + "transfers": { + "name": "Transfers", + "versions": [ + { + "version": "2024-06-01", + "url": "https://developer-docs.amazon.com/sp-api/docs/transfers-api-v2024-06-01-model", + "selector": "code[data-lang='json']" + } + ] + }, + "uploads": { + "name": "Uploads", + "versions": [ + { + "version": "2020-11-01", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/uploads-api-model/uploads_2020-11-01.json" + } + ] + } + }, + "vendor": { + "direct-fulfillment-inventory": { + "name": "Direct Fulfillment Inventory", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-inventory-api-model/vendorDirectFulfillmentInventoryV1.json" + } + ] + }, + "direct-fulfillment-orders": { + "name": "Direct Fulfillment Orders", + "versions": [ + { + "version": "2021-12-28", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrders_2021-12-28.json" + }, + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrdersV1.json" + } + ] + }, + "direct-fulfillment-payment": { + "name": "Direct Fulfillment Payment", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-payments-api-model/vendorDirectFulfillmentPaymentsV1.json" + } + ] + }, + "direct-fulfillment-sandbox": { + "name": "Direct Fulfillment Sandbox", + "versions": [ + { + "version": "2021-10-28", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-sandbox-test-data-api-model/vendorDirectFulfillmentSandboxData_2021-10-28.json" + } + ] + }, + "direct-fulfillment-shipping": { + "name": "Direct Fulfillment Shipping", + "versions": [ + { + "version": "2021-12-28", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-shipping-api-model/vendorDirectFulfillmentShipping_2021-12-28.json" + }, + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-shipping-api-model/vendorDirectFulfillmentShippingV1.json" + } + ] + }, + "direct-fulfillment-transactions": { + "name": "Direct Fulfillment Transactions", + "versions": [ + { + "version": "2021-12-28", + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-transactions-api-model/vendorDirectFulfillmentTransactions_2021-12-28.json" + }, + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-direct-fulfillment-transactions-api-model/vendorDirectFulfillmentTransactionsV1.json" + } + ] + }, + "invoices": { + "name": "Invoices", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-invoices-api-model/vendorInvoices.json" + } + ] + }, + "orders": { + "name": "Orders", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-orders-api-model/vendorOrders.json" + } + ] + }, + "shipments": { + "name": "Shipments", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-shipments-api-model/vendorShipments.json" + } + ] + }, + "transaction-status": { + "name": "Transaction Status", + "versions": [ + { + "version": 1, + "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/main/models/vendor-transaction-status-api-model/vendorTransactionStatus.json" + } + ] } - ] } - } } diff --git a/resources/models/raw/seller/amazon-warehousing-distribution/v2024-05-09.json b/resources/models/raw/seller/amazon-warehousing-distribution/v2024-05-09.json index 59a6fefd3..8def7e3a1 100644 --- a/resources/models/raw/seller/amazon-warehousing-distribution/v2024-05-09.json +++ b/resources/models/raw/seller/amazon-warehousing-distribution/v2024-05-09.json @@ -1,8 +1,8 @@ { "openapi": "3.0.1", "info": { - "title": "The Selling Partner API for AWD", - "description": "The Selling Partner API for Amazon Warehousing and Distribution (AWD).", + "title": "The Selling Partner API for Amazon Warehousing and Distribution", + "description": "The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory. ", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" @@ -36,6 +36,39 @@ "minLength": 1, "type": "string" } + }, + { + "name": "skuQuantities", + "in": "query", + "description": "If equal to `SHOW`, the response includes the shipment SKU quantity details.\n\nDefaults to `HIDE`, in which case the response does not contain SKU quantities", + "schema": { + "type": "string", + "enum": [ + "SHOW", + "HIDE" + ], + "x-docgen-enum-table-extension": [ + { + "description": "Show the additional SKU quantity details.", + "value": "SHOW" + }, + { + "description": "Hide the additional SKU quantity details.", + "value": "HIDE" + } + ] + }, + "example": "SHOW", + "x-docgen-enum-table-extension": [ + { + "description": "Show the additional SKU quantity details.", + "value": "SHOW" + }, + { + "description": "Hide the additional SKU quantity details.", + "value": "HIDE" + } + ] } ], "responses": { @@ -134,6 +167,19 @@ ], "shipmentId": "TestShipmentId", "shipmentStatus": "CREATED", + "shipmentSkuQuantities": [ + { + "sku": "testPen", + "expectedQuantity": { + "quantity": 2, + "unitOfMeasurement": "CASE" + }, + "receivedQuantity": { + "quantity": 0, + "unitOfMeasurement": "CASE" + } + } + ], "updatedAt": "2023-06-07T12:12:09.061Z" } } @@ -326,13 +372,13 @@ "tags": [ "awd" ], - "description": "Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "listInboundShipments", "parameters": [ { "name": "sortBy", "in": "query", - "description": "Field to sort results by. Required if `sortOrder` is provided.", + "description": "Field to sort results by. By default, the response will be sorted by UPDATED_AT.", "schema": { "type": "string", "enum": [ @@ -341,22 +387,22 @@ ], "x-docgen-enum-table-extension": [ { - "description": "Sort by `Updated at`timestamp.", + "description": "Sort by the time of update.", "value": "UPDATED_AT" }, { - "description": "Sort by `Created at` timestamp.", + "description": "Sort by the time of creation.", "value": "CREATED_AT" } ] }, "x-docgen-enum-table-extension": [ { - "description": "Sort by `Updated at`timestamp.", + "description": "Sort by the time of update.", "value": "UPDATED_AT" }, { - "description": "Sort by `Created at` timestamp.", + "description": "Sort by the time of creation.", "value": "CREATED_AT" } ] @@ -364,7 +410,7 @@ { "name": "sortOrder", "in": "query", - "description": "Sort the response in `ASCENDING` or `DESCENDING` order.", + "description": "Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.", "schema": { "type": "string", "enum": [ @@ -878,6 +924,7 @@ "inventory": [ { "totalOnhandQuantity": 20, + "totalInboundQuantity": 10, "sku": "100TestSKU1Pen", "inventoryDetails": { "availableDistributableQuantity": 10, @@ -886,6 +933,7 @@ }, { "totalOnhandQuantity": 20, + "totalInboundQuantity": 5, "sku": "2U-BKEX-VW4D", "inventoryDetails": { "availableDistributableQuantity": 10, @@ -1180,7 +1228,7 @@ ], "x-docgen-enum-table-extension": [ { - "description": "Standard Carrier Alpha Code. Ref: https://help.cbp.gov/s/article/Article-572?language=en_US.", + "description": "Standard Carrier Alpha Code. Refer to [What is a Standard Carrier Alpha Code](https://www.help.cbp.gov/s/article/Article-1420?language=en_US) for more information.", "value": "SCAC" } ] @@ -1435,6 +1483,13 @@ "type": "string", "description": "Unique shipment ID." }, + "shipmentSkuQuantities": { + "type": "array", + "description": "Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW.", + "items": { + "$ref": "#/components/schemas/SkuQuantity" + } + }, "shipmentStatus": { "$ref": "#/components/schemas/InboundShipmentStatus" }, @@ -1624,6 +1679,11 @@ "type": "string", "description": "The seller or merchant SKU." }, + "totalInboundQuantity": { + "type": "integer", + "description": "Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Center", + "format": "int64" + }, "totalOnhandQuantity": { "type": "integer", "description": "Total quantity that is present in AWD distribution centers.", @@ -1769,10 +1829,6 @@ "attributes": { "type": "array", "description": "Attributes for this instance of the product. For example, already-prepped, or other attributes that distinguish the product beyond the SKU.", - "example": { - "name": "TestAttribute", - "value": "TestAttributeValue" - }, "items": { "$ref": "#/components/schemas/ProductAttribute" } @@ -1826,6 +1882,45 @@ } ] }, + "SkuQuantitiesVisibility": { + "type": "string", + "description": "Enum to specify if returned shipment should include SKU quantity details", + "example": "SHOW", + "enum": [ + "SHOW", + "HIDE" + ], + "x-docgen-enum-table-extension": [ + { + "description": "Show the additional SKU quantity details", + "value": "SHOW" + }, + { + "description": "Hide the additional SKU quantity details", + "value": "HIDE" + } + ] + }, + "SkuQuantity": { + "required": [ + "expectedQuantity", + "sku" + ], + "type": "object", + "properties": { + "expectedQuantity": { + "$ref": "#/components/schemas/InventoryQuantity" + }, + "receivedQuantity": { + "$ref": "#/components/schemas/InventoryQuantity" + }, + "sku": { + "type": "string", + "description": "The merchant stock keeping unit" + } + }, + "description": "Quantity details for a SKU as part of a shipment" + }, "SortOrder": { "type": "string", "description": "Sort order for a collection of items. For example, order or shipment.", diff --git a/resources/models/raw/seller/application-management/v2023-11-30.json b/resources/models/raw/seller/application-management/v2023-11-30.json index df89d243f..ae2c41af4 100644 --- a/resources/models/raw/seller/application-management/v2023-11-30.json +++ b/resources/models/raw/seller/application-management/v2023-11-30.json @@ -46,7 +46,7 @@ "content": {} }, "400": { - "description": "The application has not enrolled for programmatic rotations. Please visit your developer console to enroll.", + "description": "Application is not enrolled for rotation notification. Please update application notification preference in Developer console.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", diff --git a/resources/models/raw/seller/catalog-items/v2022-04-01.json b/resources/models/raw/seller/catalog-items/v2022-04-01.json index 1ab6f0e5d..e112b5d6a 100644 --- a/resources/models/raw/seller/catalog-items/v2022-04-01.json +++ b/resources/models/raw/seller/catalog-items/v2022-04-01.json @@ -24,7 +24,7 @@ "tags": [ "catalog" ], - "description": "Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.\n\n**Usage Plans:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 5 |\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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.\n\n**Usage Plans:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "searchCatalogItems", "parameters": [ { @@ -1768,7 +1768,7 @@ "tags": [ "catalog" ], - "description": "Retrieves details for an item in the Amazon catalog.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 5 |\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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Retrieves details for an item in the Amazon catalog.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getCatalogItem", "parameters": [ { diff --git a/resources/models/raw/seller/fba-inbound/v0.json b/resources/models/raw/seller/fba-inbound/v0.json index d02951749..a798a1b13 100644 --- a/resources/models/raw/seller/fba-inbound/v0.json +++ b/resources/models/raw/seller/fba-inbound/v0.json @@ -4102,8 +4102,7 @@ } } } - }, - "deprecated": true + } } }, "/fba/inbound/v0/shipments/{shipmentId}/items": { @@ -4362,8 +4361,7 @@ } } } - }, - "deprecated": true + } } }, "/fba/inbound/v0/shipmentItems": { @@ -4718,8 +4716,7 @@ } } } - }, - "deprecated": true + } } } }, diff --git a/resources/models/raw/seller/fba-inventory/v1.json b/resources/models/raw/seller/fba-inventory/v1.json index c5fa44856..891f07987 100644 --- a/resources/models/raw/seller/fba-inventory/v1.json +++ b/resources/models/raw/seller/fba-inventory/v1.json @@ -24,7 +24,7 @@ "tags": [ "fbaInventory" ], - "description": "Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:\n\n- All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted.\n- When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified.\n- When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored.\n- When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.\n\nNote: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.\n\nUsage Plan:\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\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 than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.", + "description": "Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:\n\n- All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted.\n- When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified.\n- When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored.\n- When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.\n\nNote: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\nUsage Plan:\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).", "operationId": "getInventorySummaries", "parameters": [ { @@ -1040,6 +1040,13 @@ "totalQuantity": { "type": "integer", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." + }, + "stores": { + "type": "array", + "description": "A list of seller-enrolled stores that apply to this seller SKU.", + "items": { + "type": "string" + } } }, "description": "Inventory summary for a specific item." diff --git a/resources/models/raw/seller/fba-outbound/v2020-07-01.json b/resources/models/raw/seller/fba-outbound/v2020-07-01.json index c5f3e9cce..61cb2611b 100644 --- a/resources/models/raw/seller/fba-outbound/v2020-07-01.json +++ b/resources/models/raw/seller/fba-outbound/v2020-07-01.json @@ -24,7 +24,7 @@ "tags": [ "fbaOutbound" ], - "description": "Returns a list of fulfillment order previews based on shipping criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of fulfillment order previews based on shipping criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFulfillmentPreview", "requestBody": { "description": "GetFulfillmentPreviewRequest parameter", @@ -267,7 +267,7 @@ "tags": [ "fbaOutbound" ], - "description": "Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "deliveryOffers", "requestBody": { "description": "GetDeliveryOffersRequest parameter", @@ -474,7 +474,7 @@ "tags": [ "fbaOutbound" ], - "description": "Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)", + "description": "Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)", "operationId": "listAllFulfillmentOrders", "parameters": [ { @@ -723,7 +723,7 @@ "tags": [ "fbaOutbound" ], - "description": "Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)", + "description": "Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)", "operationId": "createFulfillmentOrder", "requestBody": { "description": "CreateFulfillmentOrderRequest parameter", @@ -911,7 +911,7 @@ "tags": [ "fbaOutbound" ], - "description": "Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getPackageTrackingDetails", "parameters": [ { @@ -1142,7 +1142,7 @@ "tags": [ "fbaOutbound" ], - "description": "Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "listReturnReasonCodes", "parameters": [ { @@ -1407,7 +1407,7 @@ "tags": [ "fbaOutbound" ], - "description": "Creates a fulfillment return.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Creates a fulfillment return.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "createFulfillmentReturn", "parameters": [ { @@ -1640,7 +1640,7 @@ "tags": [ "fbaOutbound" ], - "description": "Returns the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFulfillmentOrder", "parameters": [ { @@ -1917,7 +1917,7 @@ "tags": [ "fbaOutbound" ], - "description": "Updates and/or requests shipment for a fulfillment order with an order hold on it.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Updates and/or requests shipment for a fulfillment order with an order hold on it.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "updateFulfillmentOrder", "parameters": [ { @@ -2117,7 +2117,7 @@ "tags": [ "fbaOutbound" ], - "description": "Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "cancelFulfillmentOrder", "parameters": [ { @@ -2488,7 +2488,7 @@ "tags": [ "fbaOutbound" ], - "description": "Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeatures", "parameters": [ { @@ -2692,7 +2692,7 @@ "tags": [ "fbaOutbound" ], - "description": "Returns a list of inventory items that are eligible for the fulfillment feature you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..", + "description": "Returns a list of inventory items that are eligible for the fulfillment feature you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..", "operationId": "getFeatureInventory", "parameters": [ { @@ -2720,6 +2720,15 @@ "schema": { "type": "string" } + }, + { + "name": "queryStartDate", + "in": "query", + "description": "A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ", + "schema": { + "type": "string", + "format": "date-time" + } } ], "responses": { @@ -2927,7 +2936,7 @@ "tags": [ "fbaOutbound" ], - "description": "Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn't eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn't eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeatureSKU", "parameters": [ { @@ -4174,6 +4183,9 @@ }, "lockerDetails": { "$ref": "#/components/schemas/LockerDetails" + }, + "deliveryInformation": { + "$ref": "#/components/schemas/DeliveryInformation" } }, "description": "Package information for a shipment in a fulfillment order." @@ -4526,32 +4538,6 @@ }, "description": "A physical address with varying degrees of precision. A more precise address can provide more accurate results than country code and postal code alone." }, - "DeliveryQuantity": { - "required": [ - "amount", - "unitOfMeasure" - ], - "type": "object", - "properties": { - "unitOfMeasure": { - "type": "string", - "description": "The unit of measure for the amount.", - "enum": [ - "Each" - ], - "x-docgen-enum-table-extension": [ - { - "value": "Each", - "description": "Specifies an integer count of units." - } - ] - }, - "amount": { - "$ref": "#/components/schemas/Decimal" - } - }, - "description": "A quantity based on unit of measure." - }, "DateRange": { "required": [ "earliest", @@ -4727,7 +4713,43 @@ "description": "Indicates the locker access code" } }, - "description": "The locker details, if provided can be used to access locker delivery box." + "description": "The locker details, which you can use to access the locker delivery box." + }, + "DeliveryInformation": { + "type": "object", + "properties": { + "deliveryDocumentList": { + "$ref": "#/components/schemas/DeliveryDocumentList" + }, + "dropOffLocation": { + "$ref": "#/components/schemas/DropOffLocation" + } + }, + "description": "The delivery information for the package. This information is available after the package is delivered." + }, + "DeliveryDocumentList": { + "type": "array", + "description": "A list of delivery documents for a package.", + "items": { + "$ref": "#/components/schemas/DeliveryDocument" + } + }, + "DeliveryDocument": { + "required": [ + "documentType" + ], + "type": "object", + "properties": { + "documentType": { + "type": "string", + "description": "The delivery document type. Values are `SIGNATURE` and `DELIVERY_IMAGE`." + }, + "url": { + "type": "string", + "description": "A URL that you can use to download the document. This URL has a `Content-Type` header. Note that the URL expires after one hour. To get a new URL, you must call the API again." + } + }, + "description": "A delivery document for a package." }, "NotificationEmailList": { "type": "array", diff --git a/resources/models/raw/seller/feeds/v2021-06-30.json b/resources/models/raw/seller/feeds/v2021-06-30.json index 88b6063a3..d231a03e0 100644 --- a/resources/models/raw/seller/feeds/v2021-06-30.json +++ b/resources/models/raw/seller/feeds/v2021-06-30.json @@ -24,7 +24,7 @@ "tags": [ "feeds" ], - "description": "Returns feed details for the feeds that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns feed details for the feeds that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeeds", "parameters": [ { @@ -392,7 +392,7 @@ "tags": [ "feeds" ], - "description": "Creates a feed. Upload the contents of the feed document before calling this operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0083 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Creates a feed. Upload the contents of the feed document before calling this operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0083 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).\n\nThe rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#post-feeds2021-06-30feeds) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api).", "operationId": "createFeed", "requestBody": { "description": "Information required to create the feed.", @@ -646,7 +646,7 @@ "tags": [ "feeds" ], - "description": "Returns feed details (including the resultDocumentId, if available) for the feed that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeed", "parameters": [ { @@ -889,7 +889,7 @@ "tags": [ "feeds" ], - "description": "Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeeds) operations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "cancelFeed", "parameters": [ { @@ -1120,7 +1120,7 @@ "tags": [ "feeds" ], - "description": "Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#createfeed) operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "createFeedDocument", "requestBody": { "description": "Specifies the content type for the createFeedDocument operation.", @@ -1364,7 +1364,7 @@ "tags": [ "feeds" ], - "description": "Returns the information required for retrieving a feed document's contents.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns the information required for retrieving a feed document's contents.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeedDocument", "parameters": [ { diff --git a/resources/models/raw/seller/finances/v0.json b/resources/models/raw/seller/finances/v0.json index c06e7ff3d..da94bfcb3 100644 --- a/resources/models/raw/seller/finances/v0.json +++ b/resources/models/raw/seller/finances/v0.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "Selling Partner API for Finances", - "description": "The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.", + "description": "The Selling Partner API for Finances provides financial information that is relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. ", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" @@ -21,25 +21,25 @@ "paths": { "/finances/v0/financialEventGroups": { "get": { - "description": "Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events.\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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events.\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 can have higher rate and burst values than 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).", "operationId": "listFinancialEventGroups", "parameters": [ { "name": "MaxResultsPerPage", "in": "query", - "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.", + "description": "The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", - "default": 100 + "default": 10 } }, { "name": "FinancialEventGroupStartedBefore", "in": "query", - "description": "A date used for selecting financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned.", + "description": "A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned.", "schema": { "type": "string", "format": "date-time" @@ -48,7 +48,7 @@ { "name": "FinancialEventGroupStartedAfter", "in": "query", - "description": "A date used for selecting financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be no later than two minutes before the request was submitted.", + "description": "A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.", "schema": { "type": "string", "format": "date-time" @@ -57,7 +57,7 @@ { "name": "NextToken", "in": "query", - "description": "A string token returned in the response of your previous request.", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", "schema": { "type": "string" } @@ -66,6 +66,20 @@ "responses": { "200": { "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -124,6 +138,20 @@ }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -203,12 +231,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -227,12 +249,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -251,12 +267,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -272,13 +282,13 @@ }, "/finances/v0/financialEventGroups/{eventGroupId}/financialEvents": { "get": { - "description": "Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events.\n\n**Note:** This operation will only retrieve group's data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned.\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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events.\n\n**Note:** This operation only retrieves a group's data for the past two years. A request for data spanning more than two years produces an empty response.\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 can have higher rate and burst values than 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).", "operationId": "listFinancialEventsByGroupId", "parameters": [ { "name": "MaxResultsPerPage", "in": "query", - "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.", + "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.", "schema": { "maximum": 100, "minimum": 1, @@ -290,7 +300,7 @@ { "name": "PostedAfter", "in": "query", - "description": "A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.", + "description": "The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.", "schema": { "type": "string", "format": "date-time" @@ -299,7 +309,7 @@ { "name": "PostedBefore", "in": "query", - "description": "A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two minutes.", + "description": "The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.\n\nThe date-time must be later than `PostedAfter` and more than two minutes before the requestd was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter.\n\n**Default:** Two minutes before the time of the request.", "schema": { "type": "string", "format": "date-time" @@ -317,7 +327,7 @@ { "name": "NextToken", "in": "query", - "description": "A string token returned in the response of your previous request.", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", "schema": { "type": "string" } @@ -326,6 +336,20 @@ "responses": { "200": { "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -698,6 +722,20 @@ }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -777,12 +815,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -801,12 +833,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -825,12 +851,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -846,7 +866,7 @@ }, "/finances/v0/orders/{orderId}/financialEvents": { "get": { - "description": "Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events.\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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events.\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 can have higher rate and burst values than 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).", "operationId": "listFinancialEventsByOrderId", "parameters": [ { @@ -861,7 +881,7 @@ { "name": "MaxResultsPerPage", "in": "query", - "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.", + "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.", "schema": { "maximum": 100, "minimum": 1, @@ -873,7 +893,7 @@ { "name": "NextToken", "in": "query", - "description": "A string token returned in the response of your previous request.", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", "schema": { "type": "string" } @@ -882,6 +902,20 @@ "responses": { "200": { "description": "Financial Events successfully retrieved.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -1032,6 +1066,20 @@ }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -1111,12 +1159,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1135,12 +1177,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1159,12 +1195,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1180,13 +1210,13 @@ }, "/finances/v0/financialEvents": { "get": { - "description": "Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don't show up in responses until in they are released.\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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events.\n\n**Note:** in `ListFinancialEvents`, deferred events don't show up in responses until in they are released.\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 can have higher rate and burst values than 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).", "operationId": "listFinancialEvents", "parameters": [ { "name": "MaxResultsPerPage", "in": "query", - "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.", + "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.", "schema": { "maximum": 100, "minimum": 1, @@ -1198,7 +1228,7 @@ { "name": "PostedAfter", "in": "query", - "description": "A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.", + "description": "The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.", "schema": { "type": "string", "format": "date-time" @@ -1207,7 +1237,7 @@ { "name": "PostedBefore", "in": "query", - "description": "A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.", + "description": "The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.\n\nThe date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter.\n\n**Default:** Two minutes before the time of the request.", "schema": { "type": "string", "format": "date-time" @@ -1216,7 +1246,7 @@ { "name": "NextToken", "in": "query", - "description": "A string token returned in the response of your previous request.", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", "schema": { "type": "string" } @@ -1225,6 +1255,20 @@ "responses": { "200": { "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -1371,6 +1415,20 @@ }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -1450,12 +1508,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1474,12 +1526,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1498,12 +1544,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1525,7 +1565,7 @@ "properties": { "TransactionType": { "type": "string", - "description": "Indicates the type of transaction.\n\nExample: \"Disbursed to Amazon Gift Card balance\"" + "description": "The type of transaction. For example, \"Disbursed to Amazon Gift Card balance\"." }, "PostedDate": { "$ref": "#/components/schemas/Date" @@ -1552,7 +1592,7 @@ "properties": { "AdjustmentType": { "type": "string", - "description": "The type of adjustment.\n\nPossible values:\n\n* FBAInventoryReimbursement - An FBA inventory reimbursement to a seller's account. This occurs if a seller's inventory is damaged.\n\n* ReserveEvent - A reserve event that is generated at the time of a settlement period closing. This occurs when some money from a seller's account is held back.\n\n* PostageBilling - The amount paid by a seller for shipping labels.\n\n* PostageRefund - The reimbursement of shipping labels purchased for orders that were canceled or refunded.\n\n* LostOrDamagedReimbursement - An Amazon Easy Ship reimbursement to a seller's account for a package that we lost or damaged.\n\n* CanceledButPickedUpReimbursement - An Amazon Easy Ship reimbursement to a seller's account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace.\n\n* ReimbursementClawback - An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace.\n\n* SellerRewards - An award credited to a seller's account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace." + "description": "The type of adjustment.\n\nPossible values:\n\n* `FBAInventoryReimbursement`: An FBA inventory reimbursement to a seller's account. This occurs if a seller's inventory is damaged.\n* `ReserveEvent`: A reserve event that is generated at the time a settlement period closes. This occurs when some money from a seller's account is held back.\n* `PostageBilling`: The amount paid by a seller for shipping labels.\n* `PostageRefund`: The reimbursement of shipping labels purchased for orders that were canceled or refunded.\n* `LostOrDamagedReimbursement`: An Amazon Easy Ship reimbursement to a seller's account for a package that we lost or damaged.\n* `CanceledButPickedUpReimbursement`: An Amazon Easy Ship reimbursement to a seller's account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace.\n* `ReimbursementClawback`: An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace.\n* `SellerRewards`: An award credited to a seller's account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace." }, "PostedDate": { "$ref": "#/components/schemas/Date" @@ -1578,7 +1618,7 @@ "properties": { "Quantity": { "type": "string", - "description": "Represents the number of units in the seller's inventory when the AdustmentType is FBAInventoryReimbursement." + "description": "Represents the number of units in the seller's inventory when the `AdjustmentType` is `FBAInventoryReimbursement`." }, "PerUnitAmount": { "$ref": "#/components/schemas/Currency" @@ -1629,11 +1669,11 @@ }, "MarketplaceId": { "type": "string", - "description": "An encrypted, Amazon-defined marketplace identifier." + "description": "The Amazon-defined marketplace identifier." }, "TransactionType": { "type": "string", - "description": "Indicates the type of transaction. \n\nPossible values:\n\n* Charge - For an affordability promotion expense.\n\n* Refund - For an affordability promotion expense reversal." + "description": "The type of transaction. \n\nPossible values:\n\n* `Charge`: an affordability promotion expense.\n* `Refund`: an affordability promotion expense reversal." }, "BaseExpense": { "$ref": "#/components/schemas/Currency" @@ -1661,7 +1701,8 @@ } }, "BigDecimal": { - "type": "number" + "type": "number", + "description": "A signed decimal number." }, "ChargeComponent": { "type": "object", @@ -1674,7 +1715,7 @@ "$ref": "#/components/schemas/Currency" } }, - "description": "A charge on the seller's account.\n\nPossible values:\n\n* Principal - The selling price of the order item, equal to the selling price of the item multiplied by the quantity ordered.\n\n* Tax - The tax collected by the seller on the Principal.\n\n* MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal.\n\n* MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge.\n\n* MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge.\n\n* MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges.\n\n* Discount - The promotional discount for an order item.\n\n* TaxDiscount - The tax amount deducted for promotional rebates.\n\n* CODItemCharge - The COD charge for an order item.\n\n* CODItemTaxCharge - The tax collected by the seller on a CODItemCharge.\n\n* CODOrderCharge - The COD charge for an order.\n\n* CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge.\n\n* CODShippingCharge - Shipping charges for a COD order.\n\n* CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge.\n\n* ShippingCharge - The shipping charge.\n\n* ShippingTax - The tax collected by the seller on a ShippingCharge.\n\n* Goodwill - The amount given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience.\n\n* Giftwrap - The gift wrap charge.\n\n* GiftwrapTax - The tax collected by the seller on a Giftwrap charge.\n\n* RestockingFee - The charge applied to the buyer when returning a product in certain categories.\n\n* ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event we are at fault.\n\n* PointsFee - The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction.\n\n* GenericDeduction - A generic bad debt deduction.\n\n* FreeReplacementReturnShipping - The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item.\n\n* PaymentMethodFee - The fee collected for certain payment methods in certain marketplaces.\n\n* ExportCharge - The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program.\n\n* SAFE-TReimbursement - The SAFE-T claim amount for the item.\n\n* TCS-CGST - Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST).\n\n* TCS-SGST - Tax Collected at Source for State Goods and Services Tax (SGST).\n\n* TCS-IGST - Tax Collected at Source for Integrated Goods and Services Tax (IGST).\n\n* TCS-UTGST - Tax Collected at Source for Union Territories Goods and Services Tax (UTGST)." + "description": "A charge on the seller's account.\n\nPossible values:\n\n* `Principal`: The selling price of the order item, which is equal to the selling price of the item multiplied by the quantity ordered.\n\n* `Tax`: The tax on the principal that is collected by the seller.\n\n* `MarketplaceFacilitatorTax-Principal`: The tax that is withheld on the principal.\n\n* `MarketplaceFacilitatorTax-Shipping`: The tax that is withheld on the `ShippingCharge`.\n\n* `MarketplaceFacilitatorTax-Giftwrap`: The tax that is withheld on the Giftwrap charge.\n\n* `MarketplaceFacilitatorTax-Other`: The tax that is withheld on other miscellaneous charges.\n\n* `Discount`: The promotional discount for an order item.\n\n* `TaxDiscount`: The tax that is deducted for promotional rebates.\n\n* `CODItemCharge`: The COD charge for an order item.\n\n* `CODItemTaxCharge`: The tax that is collected by the seller on a `CODItemCharge`.\n\n* `CODOrderCharge`: The COD charge for an order.\n\n* `CODOrderTaxCharge`: The tax that is collected by the seller on a `CODOrderCharge`.\n\n* `CODShippingCharge`: Shipping charges for a COD order.\n\n* `CODShippingTaxCharge`: The tax that is collected by the seller on a `CODShippingCharge`.\n\n* `ShippingCharge`: The shipping charge.\n\n* `ShippingTax`: The tax that is collected by the seller on a `ShippingCharge`.\n\n* `Goodwill`: The amount of money that is given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience.\n\n* `Giftwrap`: The gift wrap charge.\n\n* `GiftwrapTax`: The tax that is collected by the seller on a gift wrap charge.\n\n* `RestockingFee`: The charge that is applied to the buyer when returning a product in certain categories.\n\n* `ReturnShipping`: The amount of money that is given to the buyer to compensate for shipping the item back if we are at fault.\n\n* `PointsFee`: The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction.\n\n* `GenericDeduction`: A generic bad debt deduction.\n\n* `FreeReplacementReturnShipping`: The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item.\n\n* `PaymentMethodFee`: The fee that is collected for certain payment methods in certain marketplaces.\n\n* `ExportCharge`: The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program.\n\n* `SAFE-TReimbursement`: The SAFE-T claim amount for the item.\n\n* `TCS-CGST`: Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST).\n\n* `TCS-SGST`: Tax Collected at Source for State Goods and Services Tax (SGST).\n\n* `TCS-IGST`: Tax Collected at Source for Integrated Goods and Services Tax (IGST).\n\n* `TCS-UTGST`: Tax Collected at Source for Union Territories Goods and Services Tax (UTGST)." }, "ChargeComponentList": { "type": "array", @@ -1715,11 +1756,11 @@ }, "ReasonCode": { "type": "string", - "description": "The reason given for a charge refund.\n\nExample: `SubscriptionFeeCorrection`" + "description": "The reason given for a charge refund. For example, `SubscriptionFeeCorrection`." }, "ReasonCodeDescription": { "type": "string", - "description": "A description of the Reason Code. \n\nExample: `SubscriptionFeeCorrection`" + "description": "A description of the Reason Code. For example, `SubscriptionFeeCorrection`." }, "ChargeRefundTransactions": { "$ref": "#/components/schemas/ChargeRefundTransactions" @@ -1811,6 +1852,7 @@ }, "Date": { "type": "string", + "description": "A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", "format": "date-time" }, "DebtRecoveryEvent": { @@ -1818,7 +1860,7 @@ "properties": { "DebtRecoveryType": { "type": "string", - "description": "The debt recovery type.\n\nPossible values:\n\n* DebtPayment\n\n* DebtPaymentFailure\n\n*DebtAdjustment" + "description": "The debt recovery type.\n\nPossible values:\n\n* `DebtPayment`\n* `DebtPaymentFailure`\n* `DebtAdjustment`" }, "RecoveryAmount": { "$ref": "#/components/schemas/Currency" @@ -1872,7 +1914,7 @@ "properties": { "DirectPaymentType": { "type": "string", - "description": "The type of payment.\n\nPossible values:\n\n* StoredValueCardRevenue - The amount that is deducted from the seller's account because the seller received money through a stored value card.\n\n* StoredValueCardRefund - The amount that Amazon returns to the seller if the order that is bought using a stored value card is refunded.\n\n* PrivateLabelCreditCardRevenue - The amount that is deducted from the seller's account because the seller received money through a private label credit card offered by Amazon.\n\n* PrivateLabelCreditCardRefund - The amount that Amazon returns to the seller if the order that is bought using a private label credit card offered by Amazon is refunded.\n\n* CollectOnDeliveryRevenue - The COD amount that the seller collected directly from the buyer.\n\n* CollectOnDeliveryRefund - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded." + "description": "The type of payment.\n\nPossible values:\n\n* `StoredValueCardRevenue` - The amount that is deducted from the seller's account because the seller received money through a stored value card.\n\n* `StoredValueCardRefund` - The amount that Amazon returns to the seller if the order that is purchased using a stored value card is refunded.\n\n* `PrivateLabelCreditCardRevenue` - The amount that is deducted from the seller's account because the seller received money through a private label credit card offered by Amazon.\n\n* `PrivateLabelCreditCardRefund` - The amount that Amazon returns to the seller if the order that is purchased using a private label credit card offered by Amazon is refunded.\n\n* `CollectOnDeliveryRevenue` - The COD amount that the seller collected directly from the buyer.\n\n* `CollectOnDeliveryRefund` - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded." }, "DirectPaymentAmount": { "$ref": "#/components/schemas/Currency" @@ -1889,7 +1931,7 @@ }, "FailedAdhocDisbursementEventList": { "type": "array", - "description": "A list of `FailedAdhocDisbursementEvent`s.", + "description": "A list of `FailedAdhocDisbursementEvent`.", "items": { "$ref": "#/components/schemas/FailedAdhocDisbursementEvent" } @@ -1899,7 +1941,7 @@ "properties": { "FundsTransfersType": { "type": "string", - "description": "The type of fund transfer. \n\nExample \"Refund\"" + "description": "The type of fund transfer. For example, `Refund`." }, "TransferId": { "type": "string", @@ -1911,11 +1953,11 @@ }, "PaymentDisbursementType": { "type": "string", - "description": "The type of payment for disbursement. \n\nExample `CREDIT_CARD`" + "description": "The type of payment for disbursement. For example, `CREDIT_CARD`." }, "Status": { "type": "string", - "description": "The status of the failed `AdhocDisbursement`. \n\nExample `HARD_DECLINED`" + "description": "The status of the failed `AdhocDisbursement`. For example, `HARD_DECLINED`." }, "TransferAmount": { "$ref": "#/components/schemas/Currency" @@ -1981,7 +2023,7 @@ }, "ProcessingStatus": { "type": "string", - "description": "The processing status of the financial event group indicates whether the balance of the financial event group is settled.\n\nPossible values:\n\n* Open\n\n* Closed" + "description": "The processing status of the financial event group indicates whether the balance of the financial event group is settled.\n\nPossible values:\n\n* `Open`\n* `Closed`" }, "FundTransferStatus": { "type": "string", @@ -2126,7 +2168,7 @@ "$ref": "#/components/schemas/CapacityReservationBillingEventList" } }, - "description": "Contains all information related to a financial event." + "description": "All the information that is related to a financial event." }, "ImagingServicesFeeEvent": { "type": "object", @@ -2166,7 +2208,7 @@ "$ref": "#/components/schemas/FinancialEventGroupList" } }, - "description": "The payload for the listFinancialEventGroups operation." + "description": "The payload for the `listFinancialEventGroups` operation." }, "ListFinancialEventGroupsResponse": { "type": "object", @@ -2178,7 +2220,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the listFinancialEventGroups operation." + "description": "The response schema for the `listFinancialEventGroups` operation." }, "ListFinancialEventsPayload": { "type": "object", @@ -2191,7 +2233,7 @@ "$ref": "#/components/schemas/FinancialEvents" } }, - "description": "The payload for the listFinancialEvents operation." + "description": "The payload for the `listFinancialEvents` operation." }, "ListFinancialEventsResponse": { "type": "object", @@ -2203,7 +2245,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the listFinancialEvents operation." + "description": "The response schema for the `listFinancialEvents` operation." }, "LoanServicingEvent": { "type": "object", @@ -2213,7 +2255,7 @@ }, "SourceBusinessEventType": { "type": "string", - "description": "The type of event.\n\nPossible values:\n\n* LoanAdvance\n\n* LoanPayment\n\n* LoanRefund" + "description": "The type of event.\n\nPossible values:\n\n* `LoanAdvance`\n\n* `LoanPayment`\n\n* `LoanRefund`" } }, "description": "A loan advance, loan payment, or loan refund." @@ -2230,7 +2272,7 @@ "properties": { "TransactionType": { "type": "string", - "description": "The type of network item swap.\n\nPossible values:\n\n* NetCo - A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace.\n\n* ComminglingVAT - A commingling VAT transaction. Available only in the UK, Spain, France, Germany, and Italy marketplaces." + "description": "The type of network item swap.\n\nPossible values:\n\n* `NetCo`: A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace.\n\n* `ComminglingVAT`: A commingling VAT transaction. Available only in the Spain, UK, France, Germany, and Italy marketplaces." }, "PostedDate": { "$ref": "#/components/schemas/Date" @@ -2293,7 +2335,7 @@ }, "PaymentAmountType": { "type": "string", - "description": "The type of payment.\n\nPossible values:\n\n* Sales" + "description": "The type of payment.\n\nPossible values:\n\n* `Sales`" }, "AmountDescription": { "type": "string", @@ -2301,11 +2343,11 @@ }, "FulfillmentChannel": { "type": "string", - "description": "The fulfillment channel.\n\nPossible values:\n\n* AFN - Amazon Fulfillment Network (Fulfillment by Amazon)\n\n* MFN - Merchant Fulfillment Network (self-fulfilled)" + "description": "The fulfillment channel.\n\nPossible values:\n\n* `AFN`: Amazon Fulfillment Network (Fulfillment by Amazon)\n\n* `MFN`: Merchant Fulfillment Network (self-fulfilled)" }, "StoreName": { "type": "string", - "description": "The store name where the event occurred." + "description": "The name of the store where the event occurred." } }, "description": "An event related to the seller's Pay with Amazon account." @@ -2325,11 +2367,11 @@ }, "transactionType": { "type": "string", - "description": "Indicates if the transaction is for a charge or a refund.\n\nPossible values:\n\n* charge - Charge\n\n* refund - Refund" + "description": "Indicates if the transaction is for a charge or a refund.\n\nPossible values:\n\n* `charge`\n\n* `refund`" }, "invoiceId": { "type": "string", - "description": "Identifier for the invoice that the transaction appears in." + "description": "The identifier for the invoice that includes the transaction." }, "baseValue": { "$ref": "#/components/schemas/Currency" @@ -2382,7 +2424,7 @@ }, "MerchantOrderId": { "type": "string", - "description": "The merchant removal orderId." + "description": "The merchant removal `orderId`." }, "OrderId": { "type": "string", @@ -2390,7 +2432,11 @@ }, "TransactionType": { "type": "string", - "description": "The type of removal order.\n\nPossible values:\n\n* WHOLESALE_LIQUIDATION" + "description": "The type of removal order.\n\nPossible values:\n\n* `WHOLESALE_LIQUIDATION`" + }, + "StoreName": { + "type": "string", + "description": "The name of the store where the event occurred." }, "RemovalShipmentItemList": { "$ref": "#/components/schemas/RemovalShipmentItemList" @@ -2414,7 +2460,7 @@ }, "TaxCollectionModel": { "type": "string", - "description": "The tax collection model applied to the item.\n\nPossible values:\n\n* MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n\n* Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon." + "description": "The tax collection model that is applied to the item.\n\nPossible values:\n\n* `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n* `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon." }, "FulfillmentNetworkSKU": { "type": "string", @@ -2442,7 +2488,7 @@ }, "RemovalShipmentItemList": { "type": "array", - "description": "A list of information about removal shipment items.", + "description": "A list of `RemovalShipmentItem`.", "items": { "$ref": "#/components/schemas/RemovalShipmentItem" } @@ -2467,11 +2513,11 @@ }, "TransactionType": { "type": "string", - "description": "The type of removal order.\n\nPossible values:\n\n* WHOLESALE_LIQUIDATION." + "description": "The type of removal order.\n\nPossible values:\n\n* `WHOLESALE_LIQUIDATION`." }, "RemovalShipmentItemAdjustmentList": { "type": "array", - "description": "A comma-delimited list of Removal shipmentItemAdjustment details for FBA inventory.", + "description": "A comma-delimited list of `RemovalShipmentItemAdjustment` details for FBA inventory.", "items": { "$ref": "#/components/schemas/RemovalShipmentItemAdjustment" } @@ -2481,7 +2527,7 @@ }, "RemovalShipmentAdjustmentEventList": { "type": "array", - "description": "A comma-delimited list of Removal shipmentAdjustment details for FBA inventory.", + "description": "A comma-delimited list of `RemovalShipmentAdjustment` details for FBA inventory.", "items": { "$ref": "#/components/schemas/RemovalShipmentAdjustmentEvent" } @@ -2495,7 +2541,7 @@ }, "TaxCollectionModel": { "type": "string", - "description": "The tax collection model applied to the item.\n\nPossible values:\n\n* MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n\n* Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon." + "description": "The tax collection model that is applied to the item.\n\nPossible values:\n\n* `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n* `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon." }, "FulfillmentNetworkSKU": { "type": "string", @@ -2503,7 +2549,7 @@ }, "AdjustedQuantity": { "type": "integer", - "description": "Adjusted quantity of removal shipmentItemAdjustment items.", + "description": "Adjusted quantity of `RemovalShipmentItemAdjustment` items.", "format": "int32" }, "RevenueAdjustment": { @@ -2527,11 +2573,11 @@ }, "RentalEventType": { "type": "string", - "description": "The type of rental event.\n\nPossible values:\n\n* RentalCustomerPayment-Buyout - Transaction type that represents when the customer wants to buy out a rented item.\n\n* RentalCustomerPayment-Extension - Transaction type that represents when the customer wants to extend the rental period.\n\n* RentalCustomerRefund-Buyout - Transaction type that represents when the customer requests a refund for the buyout of the rented item.\n\n* RentalCustomerRefund-Extension - Transaction type that represents when the customer requests a refund over the extension on the rented item.\n\n* RentalHandlingFee - Transaction type that represents the fee that Amazon charges sellers who rent through Amazon.\n\n* RentalChargeFailureReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a failed charge.\n\n* RentalLostItemReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a lost item." + "description": "The type of rental event.\n\nPossible values:\n\n* `RentalCustomerPayment-Buyout`: A transaction type that represents when the customer wants to buy out a rented item.\n\n* `RentalCustomerPayment-Extension`: A transaction type that represents when the customer wants to extend the rental period.\n\n* `RentalCustomerRefund-Buyout`: A transaction type that represents when the customer requests a refund for the buyout of the rented item.\n\n* `RentalCustomerRefund-Extension`: A transaction type that represents when the customer requests a refund over the extension on the rented item.\n\n* `RentalHandlingFee`: A transaction type that represents the fee that Amazon charges sellers who rent through Amazon.\n\n* `RentalChargeFailureReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a failed charge.\n\n* `RentalLostItemReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a lost item." }, "ExtensionLength": { "type": "integer", - "description": "The number of days that the buyer extended an already rented item. This value is only returned for RentalCustomerPayment-Extension and RentalCustomerRefund-Extension events.", + "description": "The number of days that the buyer extended an already rented item. This value is only returned for `RentalCustomerPayment-Extension` and `RentalCustomerRefund-Extension` events.", "format": "int32" }, "PostedDate": { @@ -2571,7 +2617,7 @@ "properties": { "RetrochargeEventType": { "type": "string", - "description": "The type of event.\n\nPossible values:\n\n* Retrocharge\n\n* RetrochargeReversal" + "description": "The type of event.\n\nPossible values:\n\n* `Retrocharge`\n\n* `RetrochargeReversal`" }, "AmazonOrderId": { "type": "string", @@ -2598,7 +2644,7 @@ }, "RetrochargeEventList": { "type": "array", - "description": "A list of information about Retrocharge or RetrochargeReversal events.", + "description": "A list of information about `Retrocharge` or `RetrochargeReversal` events.", "items": { "$ref": "#/components/schemas/RetrochargeEvent" } @@ -2628,7 +2674,7 @@ }, "SAFETReimbursementEventList": { "type": "array", - "description": "A list of SAFETReimbursementEvents.", + "description": "A list of `SAFETReimbursementEvent`.", "items": { "$ref": "#/components/schemas/SAFETReimbursementEvent" } @@ -2652,7 +2698,7 @@ }, "SAFETReimbursementItemList": { "type": "array", - "description": "A list of SAFETReimbursementItems.", + "description": "A list of `SAFETReimbursementItem`.", "items": { "$ref": "#/components/schemas/SAFETReimbursementItem" } @@ -2673,11 +2719,11 @@ }, "eventType": { "type": "string", - "description": "The type of event: SellerDealComplete." + "description": "The type of event: `SellerDealComplete`." }, "feeType": { "type": "string", - "description": "The type of fee: RunLightningDealFee." + "description": "The type of fee: `RunLightningDealFee`." }, "feeAmount": { "$ref": "#/components/schemas/Currency" @@ -2760,6 +2806,10 @@ "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." + }, + "StoreName": { + "type": "string", + "description": "The name of the store where the event occurred." } }, "description": "A service fee on the seller's account." @@ -2786,6 +2836,10 @@ "type": "string", "description": "The name of the marketplace where the event occurred." }, + "StoreName": { + "type": "string", + "description": "The name of the store where the event occurred." + }, "OrderChargeList": { "$ref": "#/components/schemas/ChargeComponentList" }, @@ -2936,7 +2990,7 @@ }, "SolutionProviderCreditEventList": { "type": "array", - "description": "A list of information about solution provider credits.", + "description": "A list of `SolutionProviderCreditEvent`.", "items": { "$ref": "#/components/schemas/SolutionProviderCreditEvent" } @@ -2951,7 +3005,7 @@ "$ref": "#/components/schemas/Date" } }, - "description": "Period which taxwithholding on seller's account is calculated." + "description": "The period during which tax withholding on a seller's account is calculated." }, "TaxWithholdingEvent": { "type": "object", @@ -2969,11 +3023,11 @@ "$ref": "#/components/schemas/TaxWithholdingPeriod" } }, - "description": "A TaxWithholding event on seller's account." + "description": "A tax withholding event on a seller's account." }, "TaxWithholdingEventList": { "type": "array", - "description": "A list of `TaxWithholding` events.", + "description": "A list of tax withholding events.", "items": { "$ref": "#/components/schemas/TaxWithholdingEvent" } @@ -2983,7 +3037,7 @@ "properties": { "TaxCollectionModel": { "type": "string", - "description": "The tax collection model applied to the item.\n\nPossible values:\n\n* MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n\n* Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon." + "description": "The tax collection model applied to the item.\n\nPossible values:\n\n* `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n* `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon." }, "TaxesWithheld": { "$ref": "#/components/schemas/ChargeComponentList" @@ -3064,7 +3118,7 @@ "properties": { "TransactionType": { "type": "string", - "description": "Indicates the type of transaction.\n\nExample: 'Other Support Service fees'" + "description": "The transaction type. For example, 'Other Support Service fees'" }, "PostedDate": { "$ref": "#/components/schemas/Date" @@ -3084,7 +3138,7 @@ "properties": { "TransactionType": { "type": "string", - "description": "Indicates the type of transaction. For example, FBA Inventory Fee" + "description": "The transaction type. For example, FBA Inventory Fee." }, "PostedDate": { "$ref": "#/components/schemas/Date" diff --git a/resources/models/raw/seller/finances/v2024-06-19.json b/resources/models/raw/seller/finances/v2024-06-19.json new file mode 100644 index 000000000..1c78a00d8 --- /dev/null +++ b/resources/models/raw/seller/finances/v2024-06-19.json @@ -0,0 +1,900 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "The Selling Partner API for Finances", + "description": "The Selling Partner API for Finances provides financial information relevant to a seller's business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.", + "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" + }, + "version": "2024-06-19" + }, + "servers": [ + { + "url": "https://sellingpartnerapi-na.amazon.com/" + } + ], + "paths": { + "/finances/2024-06-19/transactions": { + "get": { + "description": "Returns transactions for the given parameters. Orders from the last 48 hours might not be included in financial events.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than 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).", + "operationId": "listTransactions", + "parameters": [ + { + "name": "postedAfter", + "in": "query", + "description": "The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.", + "required": true, + "schema": { + "type": "string", + "format": "date-time" + }, + "example": "2023-01-12" + }, + { + "name": "postedBefore", + "in": "query", + "description": "The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.\n\nThe date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty.\n\n**Default:** Two minutes before the time of the request.", + "schema": { + "type": "string", + "format": "date-time" + }, + "example": "2023-02-12" + }, + { + "name": "marketplaceId", + "in": "query", + "description": "The ID of the marketplace from which you want to retrieve transactions.", + "schema": { + "type": "string" + }, + "example": "ATIV93840DER" + }, + { + "name": "nextToken", + "in": "query", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", + "schema": { + "type": "string" + }, + "example": "jehgri34yo7jr9e8f984tr9i4o" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListTransactionsResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "postedAfter": { + "value": "2023-03-07" + }, + "nextToken": { + "value": "jehgri34yo7jr9e8f984tr9i4o" + } + } + }, + "response": { + "nextToken": "Next token value", + "transactions": [ + { + "sellingPartnerMetadata": { + "sellingPartnerId": "A3TH9S8BH6GOGM", + "accountType": "PAYABLE", + "marketplaceId": "ATIV93840DER" + }, + "relatedIdentifiers": [ + { + "relatedIdentifierName": "ORDER_ID", + "relatedIdentifierValue": "8129762527551" + } + ], + "transactionType": "Shipment", + "postedDate": "2020-07-14T03:35:13.214Z", + "totalAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + } + } + ] + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "postedBefore": { + "value": "2022-03-07" + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Start date cannot be null", + "details": "Start date cannot be null" + } + ] + } + } + ] + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "ListTransactionsResponse": { + "type": "object", + "properties": { + "nextToken": { + "type": "string", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages." + }, + "transactions": { + "$ref": "#/components/schemas/Transactions" + } + }, + "description": "The response schema for the `listTransactions` operation." + }, + "Transactions": { + "type": "array", + "description": "A list of transactions within the specified time period.", + "items": { + "$ref": "#/components/schemas/Transaction" + } + }, + "Transaction": { + "type": "object", + "properties": { + "sellingPartnerMetadata": { + "$ref": "#/components/schemas/SellingPartnerMetadata" + }, + "relatedIdentifiers": { + "$ref": "#/components/schemas/RelatedIdentifiers" + }, + "transactionType": { + "type": "string", + "description": "The type of transaction.\n\n**Possible value:** `Shipment`" + }, + "transactionId": { + "type": "string", + "description": "The unique identifier of the transaction." + }, + "transactionStatus": { + "type": "string", + "description": "The status of the transaction. \n\n**Possible values:**\n\n* `Deferred`\n* `Released`" + }, + "description": { + "type": "string", + "description": "Describes the reasons for the transaction.\n\n**Example:** 'Order Payment', 'Refund Order'" + }, + "postedDate": { + "$ref": "#/components/schemas/Date" + }, + "totalAmount": { + "$ref": "#/components/schemas/Currency" + }, + "marketplaceDetails": { + "$ref": "#/components/schemas/MarketplaceDetails" + }, + "items": { + "$ref": "#/components/schemas/Items" + }, + "contexts": { + "$ref": "#/components/schemas/Contexts" + }, + "breakdowns": { + "$ref": "#/components/schemas/Breakdowns" + } + }, + "description": "All the information related to a transaction.", + "example": { + "sellingPartnerMetadata": { + "sellingPartnerId": "XXXXXXXXXXXXXX", + "accountType": "PAYABLE", + "marketplaceId": "ATVPDKIKX0DER" + }, + "relatedIdentifiers": [ + { + "relatedIdentifierName": "ORDER_ID", + "relatedIdentifierValue": "8129762527551" + } + ], + "transactionType": "Shipment", + "transactionId": "b1qD0oAliFkLiqRyGbmeT0DoS2Z2kHzi7TZ92z-vARI", + "transactionStatus": "Released", + "description": "Order Payment", + "postedDate": "2020-07-14T03:35:13.214Z", + "totalAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "marketplaceDetails": { + "marketplaceId": "ATVPDKIKX0DER", + "marketplaceName": "Amazon.com" + }, + "items": [ + { + "description": "Item title", + "totalAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "relatedIdentifiers": [ + { + "itemRelatedIdentifierName": "ORDER_ADJUSTMENT_ITEM_ID", + "itemRelatedIdentifierValue": "81297625-121-27551" + } + ], + "breakdowns": [ + { + "breakdownType": "Product Charges", + "breakdownAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "breakdowns": [ + { + "breakdownType": "Principle", + "breakdownAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "breakdowns": [] + } + ] + } + ], + "contexts": [ + { + "contextType": "ProductContext", + "asin": "B07FGXZQZ1", + "sku": "sku-12", + "quantityShipped": 1, + "fulfillmentNetwork": "MFN" + } + ] + } + ], + "breakdowns": { + "breakdowns": [ + { + "breakdownType": "Sales", + "breakdownAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "breakdowns": [ + { + "breakdownType": "Product Charges", + "breakdownAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "breakdowns": [] + } + ] + } + ] + }, + "contexts": [ + { + "contextType": "AmazonPayContext", + "storeName": "Store 1", + "orderType": "Order Type", + "channel": "MFN" + } + ] + } + }, + "BigDecimal": { + "type": "number", + "description": "A signed decimal number." + }, + "Currency": { + "type": "object", + "properties": { + "currencyCode": { + "type": "string", + "description": "The three-digit currency code in ISO 4217 format." + }, + "currencyAmount": { + "$ref": "#/components/schemas/BigDecimal" + } + }, + "description": "A currency type and amount." + }, + "SellingPartnerMetadata": { + "type": "object", + "properties": { + "sellingPartnerId": { + "type": "string", + "description": "A unique seller identifier." + }, + "accountType": { + "type": "string", + "description": "The type of account in the transaction." + }, + "marketplaceId": { + "type": "string", + "description": "The identifier of the marketplace where the transaction occurred." + } + }, + "description": "Metadata that describes the seller." + }, + "RelatedIdentifier": { + "type": "object", + "properties": { + "relatedIdentifierName": { + "type": "string", + "description": "An enumerated set of related business identifier names.", + "enum": [ + "ORDER_ID", + "SHIPMENT_ID", + "EVENT_GROUP_ID", + "REFUND_ID", + "INVOICE_ID", + "DISBURSEMENT_ID", + "TRANSFER_ID", + "DEFERRED_TRANSACTION_ID" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ORDER_ID", + "description": "The `OrderId` that is associated with the transaction." + }, + { + "value": "SHIPMENT_ID", + "description": "The `ShipmentId` that is associated with the transaction." + }, + { + "value": "EVENT_GROUP_ID", + "description": "The identifier that is associated with the transaction's financial event group." + }, + { + "value": "REFUND_ID", + "description": "The `RefundId` that is associated with the transaction." + }, + { + "value": "INVOICE_ID", + "description": "The `InvoiceId` that is associated with the transaction." + }, + { + "value": "DISBURSEMENT_ID", + "description": "The disbursement ID for Amazon's bank transfer." + }, + { + "value": "TRANSFER_ID", + "description": "The `TransferId` associated with the transaction." + }, + { + "value": "DEFERRED_TRANSACTION_ID", + "description": "The transaction ID for the related deferred transaction" + } + ] + }, + "relatedIdentifierValue": { + "type": "string", + "description": "Corresponding value of `RelatedIdentifierName`." + } + }, + "description": "Related business identifier of the transaction." + }, + "RelatedIdentifiers": { + "type": "array", + "description": "Related business identifiers of the transaction.", + "items": { + "$ref": "#/components/schemas/RelatedIdentifier" + } + }, + "Date": { + "type": "string", + "description": "A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", + "format": "date-time" + }, + "MarketplaceDetails": { + "type": "object", + "properties": { + "marketplaceId": { + "type": "string", + "description": "The identifier of the marketplace where the transaction occured." + }, + "marketplaceName": { + "type": "string", + "description": "The name of the marketplace where the transaction occurred. For example: `Amazon.com`,`Amazon.in`" + } + }, + "description": "Information about the marketplace where the transaction occurred.", + "example": { + "marketplaceId": "ATVPDKIKX0DER", + "marketplaceName": "Amazon.com" + } + }, + "Items": { + "type": "array", + "description": "A list of items in the transaction.", + "items": { + "$ref": "#/components/schemas/Item" + } + }, + "Item": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the items in a transaction." + }, + "relatedIdentifiers": { + "$ref": "#/components/schemas/ItemRelatedIdentifiers" + }, + "totalAmount": { + "$ref": "#/components/schemas/Currency" + }, + "breakdowns": { + "$ref": "#/components/schemas/Breakdowns" + }, + "contexts": { + "$ref": "#/components/schemas/Contexts" + } + }, + "description": "Additional information about the items in a transaction." + }, + "ItemRelatedIdentifier": { + "type": "object", + "properties": { + "itemRelatedIdentifierName": { + "type": "string", + "description": "Enumerated set of related item identifier names for the item.", + "enum": [ + "ORDER_ADJUSTMENT_ITEM_ID", + "COUPON_ID", + "REMOVAL_SHIPMENT_ITEM_ID", + "TRANSACTION_ID" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ORDER_ADJUSTMENT_ITEM_ID", + "description": "An Amazon-defined order adjustment identifier defined for refunds, guarantee claims, and chargeback events." + }, + { + "value": "COUPON_ID", + "description": "An identifier for a coupon that is applied to a transaction." + }, + { + "value": "REMOVAL_SHIPMENT_ITEM_ID", + "description": "An identifier for an item in a removal shipment." + }, + { + "value": "TRANSACTION_ID", + "description": "The transaction ID of the item." + } + ] + }, + "itemRelatedIdentifierValue": { + "type": "string", + "description": "Corresponding value to `ItemRelatedIdentifierName`." + } + }, + "description": "Related business identifiers of the item.", + "example": { + "itemRelatedIdentifierName": "ORDER_ADJUSTMENT_ITEM_ID", + "itemRelatedIdentifierValue": "OAI-123456789" + } + }, + "ItemRelatedIdentifiers": { + "type": "array", + "description": "Related business identifiers of the item in the transaction.", + "items": { + "$ref": "#/components/schemas/ItemRelatedIdentifier" + } + }, + "Breakdowns": { + "type": "array", + "description": "A list of breakdowns that provide details on how the total amount is calculated for the transaction.", + "items": { + "$ref": "#/components/schemas/Breakdown" + } + }, + "Breakdown": { + "type": "object", + "properties": { + "breakdownType": { + "type": "string", + "description": "The type of charge." + }, + "breakdownAmount": { + "$ref": "#/components/schemas/Currency" + }, + "breakdowns": { + "$ref": "#/components/schemas/Breakdown" + } + }, + "description": "Details about the movement of money in the financial transaction. Breakdowns are further categorized into breakdown types, breakdown amounts, and further breakdowns." + }, + "Contexts": { + "type": "array", + "description": "A list of additional information about the item.", + "items": { + "$ref": "#/components/schemas/Context" + } + }, + "Context": { + "description": "Additional Information about the item.", + "allOf": [ + { + "required": [ + "contextType" + ], + "type": "object", + "properties": { + "contextType": { + "type": "string" + } + } + }, + { + "$ref": "#/components/schemas/AmazonPayContext" + }, + { + "$ref": "#/components/schemas/ProductContext" + }, + { + "$ref": "#/components/schemas/PaymentsContext" + }, + { + "$ref": "#/components/schemas/DeferredContext" + }, + { + "$ref": "#/components/schemas/TimeRangeContext" + } + ] + }, + "ProductContext": { + "type": "object", + "properties": { + "asin": { + "type": "string", + "description": "The Amazon Standard Identification Number (ASIN) of the item." + }, + "sku": { + "type": "string", + "description": "The Stock Keeping Unit (SKU) of the item." + }, + "quantityShipped": { + "type": "integer", + "description": "The quantity of the item shipped.", + "format": "int32" + }, + "fulfillmentNetwork": { + "type": "string", + "description": "The fulfillment network of the item." + } + }, + "description": "Additional information related to the product.", + "example": { + "asin": "B07FGXZQZ1", + "sku": "sku-12", + "quantityShipped": 1, + "fulfillmentNetwork": "MFN" + } + }, + "AmazonPayContext": { + "type": "object", + "properties": { + "storeName": { + "type": "string", + "description": "The name of the store that is related to the transaction." + }, + "orderType": { + "type": "string", + "description": "The transaction's order type." + }, + "channel": { + "type": "string", + "description": "Channel details of related transaction." + } + }, + "description": "Additional information related to Amazon Pay.", + "example": { + "storeName": "Store 1", + "orderType": "Order Type", + "channel": "MFN" + } + }, + "PaymentsContext": { + "type": "object", + "properties": { + "paymentType": { + "type": "string", + "description": "The type of payment." + }, + "paymentMethod": { + "type": "string", + "description": "The method of payment." + }, + "paymentReference": { + "type": "string", + "description": "The reference number of the payment." + }, + "paymentDate": { + "$ref": "#/components/schemas/Date" + } + }, + "description": "Additional information related to payments-related transactions.", + "example": { + "paymentType": "Debit Card", + "paymentMethod": "BANK", + "paymentReference": "XXXXX123", + "paymentDate": "2020-07-14T03:35:13.214Z" + } + }, + "DeferredContext": { + "type": "object", + "properties": { + "deferralReason": { + "type": "string", + "description": "Deferral policy applied on the transaction.\n\n**Examples:** `B2B`,`DD7`" + }, + "maturityDate": { + "$ref": "#/components/schemas/Date" + }, + "deferralStatus": { + "type": "string", + "description": "The status of the transaction. For example, `HOLD`,`RELEASE`." + } + }, + "description": "Additional information related to deferred transactions.", + "example": { + "deferralReason": "B2B", + "maturityDate": "2024-07-14T00:00:00Z", + "deferralStatus": "HOLD" + } + }, + "TimeRangeContext": { + "type": "object", + "properties": { + "startTime": { + "$ref": "#/components/schemas/Date" + }, + "endTime": { + "$ref": "#/components/schemas/Date" + } + }, + "description": "Additional information that is related to the time range of the transaction.", + "example": { + "startTime": "2020-07-14T03:35:13.214Z", + "endTime": "2020-07-14T03:35:13.214Z" + } + }, + "ErrorList": { + "required": [ + "errors" + ], + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "The error responses that are returned when the request is unsuccessful.", + "items": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "A list of error responses returned when a request is unsuccessful." + }, + "Error": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An error code that identifies the type of error that occurred." + }, + "message": { + "type": "string", + "description": "A message that describes the error condition." + }, + "details": { + "type": "string", + "description": "Additional details that can help the caller understand or fix the issue." + } + }, + "description": "An error response returned when the request is unsuccessful." + } + } + }, + "x-original-swagger-version": "2.0" +} \ No newline at end of file diff --git a/resources/models/raw/seller/invoices/v2024-06-19.json b/resources/models/raw/seller/invoices/v2024-06-19.json new file mode 100644 index 000000000..592b0fef4 --- /dev/null +++ b/resources/models/raw/seller/invoices/v2024-06-19.json @@ -0,0 +1,2656 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "The Selling Partner API for Invoices.", + "description": "Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.", + "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" + }, + "version": "2024-06-19" + }, + "servers": [ + { + "url": "https://sellingpartnerapi-na.amazon.com/" + } + ], + "paths": { + "/tax/invoices/2024-06-19/attributes": { + "get": { + "tags": [ + "invoices" + ], + "description": "Returns marketplace-dependent schemas and their respective set of possible values.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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 indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoicesAttributes", + "parameters": [ + { + "name": "marketplaceId", + "in": "query", + "description": "The marketplace identifier.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoicesAttributesResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + } + } + }, + "response": { + "invoicesAttributes": { + "invoiceStatusOptions": [ + { + "description": "The government authorized the invoice.", + "value": "AUTHORIZED" + }, + { + "description": "The government rejected the invoice.", + "value": "REJECTED" + }, + { + "description": "The invoice is canceled.", + "value": "CANCELED" + } + ], + "invoiceTypeOptions": [], + "transactionIdentifierNameOptions": [], + "transactionTypeOptions": [] + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": {} + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required parameter: 'marketplaceId'", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + }, + "/tax/invoices/2024-06-19/documents/{invoicesDocumentId}": { + "get": { + "tags": [ + "invoices" + ], + "description": "Returns the invoice document's ID and URL. Use the URL to download the ZIP file, which contains the invoices from the corresponding `createInvoicesExport` request.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 1 |\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 indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoicesDocument", + "parameters": [ + { + "name": "invoicesDocumentId", + "in": "path", + "description": "The export document identifier.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoicesDocumentResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "invoicesDocumentId": { + "value": "18c598f5-75db-4c1a-bd3e-4c64b36781c5" + } + } + }, + "response": { + "invoicesDocument": { + "invoicesDocumentId": "18c598f5-75db-4c1a-bd3e-4c64b36781c5", + "invoicesDocumentUrl": "https://invoicesdocumentbucket.s3.eu-east-1.amazonaws.com/18c598f5-75db-4c1a-bd3e-4c64b36781c5.xml?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=&X-Amz-Date=20240710T171315Z&X-Amz-Expires=300&X-Amz-Signature=&X-Amz-SignedHeaders=host" + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": {} + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required parameter 'invoiceId'", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + }, + "/tax/invoices/2024-06-19/exports": { + "get": { + "tags": [ + "invoices" + ], + "description": "Returns invoice exports details for exports that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.1 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoicesExports", + "parameters": [ + { + "name": "marketplaceId", + "in": "query", + "description": "The returned exports match the specified marketplace.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dateStart", + "in": "query", + "description": "The earliest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 30 days ago.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "nextToken", + "in": "query", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "The maximum number of invoices to return in a single call.\n\nMinimum: 1\n\nMaximum: 100", + "schema": { + "type": "integer" + } + }, + { + "name": "dateEnd", + "in": "query", + "description": "The latest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default value is the time of the request.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "status", + "in": "query", + "description": "Return exports matching the status specified. ", + "schema": { + "type": "string", + "enum": [ + "REQUESTED", + "PROCESSING", + "DONE", + "ERROR" + ], + "x-docgen-enum-table-extension": [ + { + "description": "The export request was created, but has not started yet.", + "value": "REQUESTED" + }, + { + "description": "The export request is being processed", + "value": "PROCESSING" + }, + { + "description": "The export request is finished with success. Use the document IDs to download the output documents.", + "value": "DONE" + }, + { + "description": "The export request resulted in an error. Check the `errorMessage` attribute for more details.", + "value": "ERROR" + } + ] + }, + "x-docgen-enum-table-extension": [ + { + "description": "The export request was created, but has not started yet.", + "value": "REQUESTED" + }, + { + "description": "The export request is being processed", + "value": "PROCESSING" + }, + { + "description": "The export request is finished with success. Use the document IDs to download the output documents.", + "value": "DONE" + }, + { + "description": "The export request resulted in an error. Check the `errorMessage` attribute for more details.", + "value": "ERROR" + } + ] + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoicesExportsResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "dateEnd": { + "value": "2024-07-10T23:59:59.000Z" + }, + "dateStart": { + "value": "2024-07-10T00:00:00.000Z" + }, + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + }, + "pageSize": { + "value": 1 + }, + "status": { + "value": "DONE" + } + } + }, + "response": { + "exports": [ + { + "errorMessage": "", + "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef", + "generateExportFinishedAt": "2024-07-10T16:00:00.000Z", + "generateExportStartedAt": "2024-07-10T15:00:00.000Z", + "invoicesDocumentIds": [ + "18c598f5-75db-4c1a-bd3e-4c64b36781c5" + ], + "status": "DONE" + } + ], + "nextToken": "WTtGLzlBkat22iOI5C1yrpSPqMpz9UHYxdvm5U4DqEVJL5hqxv9xMuXe3eg35i17" + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + }, + "nextToken": { + "value": "WTtGLzlBkat22iOI5C1yrpSPqMpz9UHYxdvm5U4DqEVJL5hqxv9xMuXe3eg35i17" + }, + "status": { + "value": "DONE" + } + } + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Specifying nextToken with any other parameters will cause the request to fail.", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + }, + "post": { + "tags": [ + "invoices" + ], + "description": "Creates an invoice export request.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.167 | 1 |\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 indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "createInvoicesExport", + "requestBody": { + "description": "Information required to create the export request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExportInvoicesRequest" + } + } + }, + "required": true + }, + "responses": { + "202": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExportInvoicesResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "body": { + "value": { + "dateEnd": "2024-07-30T23:59:59", + "dateStart": "2024-07-01T00:00:00", + "externalInvoiceId": "1283743", + "fileFormat": "XML", + "invoiceType": "SYMBOLIC_RETURN", + "marketplaceId": "A2Q3Y263D00KWC", + "series": "32", + "statuses": [ + "AUTHORIZED" + ], + "transactionIdentifier": { + "name": "BUSINESS_TRANSACTION_ID", + "id": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + }, + "transactionType": "CUSTOMER_SALES" + } + } + } + }, + "response": { + "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef" + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": {} + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required attribute(s): 'marketplaceId'.", + "message": "Request has missing or invalid parameters and cannot be parsed." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/tax/invoices/2024-06-19/exports/{exportId}": { + "get": { + "tags": [ + "invoices" + ], + "description": "Returns invoice export details (including the `exportDocumentId`, if available) for the export that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoicesExport", + "parameters": [ + { + "name": "exportId", + "in": "path", + "description": "The unique identifier for the export.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoicesExportResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "exportId": { + "value": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef" + } + } + }, + "response": { + "export": { + "errorMessage": "", + "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef", + "generateExportFinishedAt": "2024-07-10T16:00:00.000Z", + "generateExportStartedAt": "2024-07-10T15:00:00.000Z", + "invoicesDocumentIds": [ + "18c598f5-75db-4c1a-bd3e-4c64b36781c5" + ], + "status": "DONE" + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": {} + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required parameter 'exportId'", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + }, + "/tax/invoices/2024-06-19/invoices": { + "get": { + "tags": [ + "invoices" + ], + "description": "Returns invoice details for the invoices that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.1 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoices", + "parameters": [ + { + "name": "transactionIdentifierName", + "in": "query", + "description": "The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options.", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "The maximum number of invoices you want to return in a single call.\n\nMinimum: 1\n\nMaximum: 200", + "schema": { + "type": "integer" + } + }, + { + "name": "dateEnd", + "in": "query", + "description": "The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the current date-time.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "marketplaceId", + "in": "query", + "description": "The response includes only the invoices that match the specified marketplace.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "transactionType", + "in": "query", + "description": "The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options.", + "schema": { + "type": "string" + } + }, + { + "name": "transactionIdentifierId", + "in": "query", + "description": "The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field.", + "schema": { + "type": "string" + } + }, + { + "name": "dateStart", + "in": "query", + "description": "The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "series", + "in": "query", + "description": "Return invoices with the specified series number.", + "schema": { + "type": "string" + } + }, + { + "name": "nextToken", + "in": "query", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "Sort the invoices in the response in ascending or descending order.", + "schema": { + "type": "string", + "enum": [ + "DESC", + "ASC" + ], + "x-docgen-enum-table-extension": [ + { + "description": "Sort in descending order.", + "value": "DESC" + }, + { + "description": "Sort in ascending order.", + "value": "ASC" + } + ] + }, + "x-docgen-enum-table-extension": [ + { + "description": "Sort in descending order.", + "value": "DESC" + }, + { + "description": "Sort in ascending order.", + "value": "ASC" + } + ] + }, + { + "name": "invoiceType", + "in": "query", + "description": "The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options.", + "schema": { + "type": "string" + } + }, + { + "name": "statuses", + "in": "query", + "description": "A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options.\n\nMin count: 1", + "style": "form", + "explode": false, + "schema": { + "minItems": 1, + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "externalInvoiceId", + "in": "query", + "description": "Return invoices that match this external ID. This is typically the Government Invoice ID.", + "schema": { + "type": "string" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "The attribute by which you want to sort the invoices in the response.", + "schema": { + "type": "string", + "enum": [ + "START_DATE_TIME" + ], + "x-docgen-enum-table-extension": [ + { + "description": "Sort by date time.", + "value": "START_DATE_TIME" + } + ] + }, + "x-docgen-enum-table-extension": [ + { + "description": "Sort by date time.", + "value": "START_DATE_TIME" + } + ] + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoicesResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "dateEnd": { + "value": "2024-07-20T23:59:59" + }, + "dateStart": { + "value": "2024-07-01T00:00:00" + }, + "invoiceType": { + "value": "SYMBOLIC_RETURN" + }, + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + }, + "pageSize": { + "value": 1 + }, + "sortBy": { + "value": "START_DATE_TIME" + }, + "sortOrder": { + "value": "DESC" + }, + "transactionIdentifierId": { + "value": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + }, + "transactionIdentifierName": { + "value": "BUSINESS_TRANSACTION_ID" + }, + "transactionType": { + "value": "CUSTOMER_SALES" + } + } + }, + "response": { + "invoices": [ + { + "date": "2024-07-10T15:00:00.000Z", + "errorCode": "", + "externalInvoiceId": "1283743", + "govResponse": "", + "id": "ad5b9dcd-6981-4dc4-a3d7-dd2568298a94", + "invoiceType": "SYMBOLIC_RETURN", + "series": "32", + "status": "AUTHORIZED", + "transactionIds": [ + { + "name": "BUSINESS_TRANSACTION_ID", + "id": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + } + ], + "transactionType": "CUSTOMER_SALES" + } + ], + "nextToken": "WTtGLzlBkat22iOI5C1yrpSPqMpz9UHYxdvm5U4DqEVJL5hqxv9xMuXe3eg35i17" + } + }, + { + "request": { + "parameters": { + "externalInvoiceId": { + "value": "1283743" + }, + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + }, + "series": { + "value": "32" + } + } + }, + "response": { + "invoices": [ + { + "date": "2024-07-10T15:00:00.000Z", + "errorCode": "", + "externalInvoiceId": "1283743", + "govResponse": "", + "id": "ad5b9dcd-6981-4dc4-a3d7-dd2568298a94", + "invoiceType": "SYMBOLIC_RETURN", + "series": "32", + "status": "AUTHORIZED", + "transactionIds": [ + { + "name": "BUSINESS_TRANSACTION_ID", + "id": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + } + ], + "transactionType": "CUSTOMER_SALES" + } + ], + "nextToken": "WTtGLzlBkat22iOI5C1yrpSPqMpz9UHYxdvm5U4DqEVJL5hqxv9xMuXe3eg35i17" + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + }, + "nextToken": { + "value": "WTtGLzlBkat22iOI5C1yrpSPqMpz9UHYxdvm5U4DqEVJL5hqxv9xMuXe3eg35i17" + }, + "statuses": { + "value": [ + "REJECTED" + ] + } + } + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Specifying nextToken with any other parameters will cause the request to fail.", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + }, + "/tax/invoices/2024-06-19/invoices/{invoiceId}": { + "get": { + "tags": [ + "invoices" + ], + "description": "Returns invoice data for the specified invoice. This operation returns only a subset of the invoices data; refer to the response definition to get all the possible attributes.\nTo get the full invoice, use the `createInvoicesExport` operation to start an export request.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoice", + "parameters": [ + { + "name": "marketplaceId", + "in": "query", + "description": "The marketplace from which you want the invoice.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "invoiceId", + "in": "path", + "description": "The invoice identifier.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoiceResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "invoiceId": { + "value": "ad5b9dcd-6981-4dc4-a3d7-dd2568298a94" + }, + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + } + } + }, + "response": { + "invoice": { + "date": "2024-07-10T15:00:00.000Z", + "errorCode": "", + "externalInvoiceId": "1283743", + "govResponse": "", + "id": "ad5b9dcd-6981-4dc4-a3d7-dd2568298a94", + "invoiceType": "CUSTOMER_SALES", + "series": "32", + "status": "AUTHORIZED", + "transactionIds": [ + { + "name": "BUSINESS_TRANSACTION_ID", + "id": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + } + ], + "transactionType": "CUSTOMER_SALES_SYMBOLIC" + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + } + } + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required parameter 'invoiceId'", + "message": "Invalid Request." + } + ] + } + }, + { + "request": { + "parameters": { + "invoiceId": { + "value": "ad5b9dcd-6981-4dc4-a3d7-dd2568298a94" + } + } + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required parameter 'marketplaceId'", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "AttributeOption": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the attribute value." + }, + "value": { + "type": "string", + "description": "The possible values for the attribute option." + } + }, + "description": "The definition of the attribute option." + }, + "Error": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An error code that identifies the type of error that occurred." + }, + "details": { + "type": "string", + "description": "Additional details that can help the caller understand or fix the issue." + }, + "message": { + "type": "string", + "description": "A message that describes the error condition." + } + }, + "description": "The error response that is returned when the request is unsuccessful." + }, + "Export": { + "type": "object", + "properties": { + "errorMessage": { + "type": "string", + "description": "When the export generation fails, this attribute contains a description of the error." + }, + "exportId": { + "type": "string", + "description": "The export identifier." + }, + "generateExportFinishedAt": { + "type": "string", + "description": "The date and time when the export generation finished. Vales are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", + "format": "date-time" + }, + "generateExportStartedAt": { + "type": "string", + "description": "The date and time when the export generation started. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", + "format": "date-time" + }, + "invoicesDocumentIds": { + "type": "array", + "description": "The identifier for the export documents. To get the information required to retrieve the export document's contents, pass each ID in the `getInvoicesDocument` operation.\n\nThis list is empty until the status is `DONE`.", + "items": { + "type": "string" + } + }, + "status": { + "$ref": "#/components/schemas/ExportStatus" + } + }, + "description": "Detailed information about the export." + }, + "ExportInvoicesRequest": { + "required": [ + "marketplaceId" + ], + "type": "object", + "properties": { + "dateEnd": { + "type": "string", + "description": "The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the time of the request.", + "format": "date" + }, + "dateStart": { + "type": "string", + "description": "The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request.", + "format": "date" + }, + "externalInvoiceId": { + "type": "string", + "description": "The external ID of the invoices you want included in the response." + }, + "fileFormat": { + "$ref": "#/components/schemas/FileFormat" + }, + "invoiceType": { + "type": "string", + "description": "The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options." + }, + "marketplaceId": { + "type": "string", + "description": "The ID of the marketplace from which you want the invoices." + }, + "series": { + "type": "string", + "description": "The series number of the invoices you want included in the response." + }, + "statuses": { + "minItems": 1, + "type": "array", + "description": "A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options.\n\nMin count: 1", + "items": { + "type": "string" + } + }, + "transactionIdentifier": { + "$ref": "#/components/schemas/TransactionIdentifier" + }, + "transactionType": { + "type": "string", + "description": "The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options" + } + }, + "description": "The information required to create the export request.", + "example": { + "dateEnd": "2024-07-30T23:59:59", + "dateStart": "2024-07-01T00:00:00", + "externalInvoiceId": "1283743", + "fileFormat": "XML", + "invoiceType": "SYMBOLIC_RETURN", + "marketplaceId": "A2Q3Y263D00KWC", + "series": "32", + "statuses": [ + "AUTHORIZED" + ], + "transactionIdentifier": { + "name": "BUSINESS_TRANSACTION_ID", + "id": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + }, + "transactionType": "CUSTOMER_SALES" + } + }, + "ExportInvoicesResponse": { + "type": "object", + "properties": { + "exportId": { + "type": "string", + "description": "The export identifier." + } + }, + "description": "Success." + }, + "ExportStatus": { + "type": "string", + "description": "The current status of the request.", + "enum": [ + "REQUESTED", + "PROCESSING", + "DONE", + "ERROR" + ], + "x-docgen-enum-table-extension": [ + { + "description": "The export request was created, but has not yet started.", + "value": "REQUESTED" + }, + { + "description": "The export request is being processed.", + "value": "PROCESSING" + }, + { + "description": "The export request has finished successfully. Use the document IDs to download the output documents.", + "value": "DONE" + }, + { + "description": "The export request resulted in an error. Refer to the `errorMessage` attribute for more information.", + "value": "ERROR" + } + ] + }, + "FileFormat": { + "type": "string", + "description": "Supported invoice file extensions.", + "enum": [ + "XML" + ], + "x-docgen-enum-table-extension": [ + { + "description": "The invoice file is in XML format.", + "value": "XML" + } + ] + }, + "GetInvoiceResponse": { + "type": "object", + "properties": { + "invoice": { + "$ref": "#/components/schemas/Invoice" + } + }, + "description": "Success." + }, + "GetInvoicesAttributesResponse": { + "type": "object", + "properties": { + "invoicesAttributes": { + "$ref": "#/components/schemas/InvoicesAttributes" + } + }, + "description": "Success." + }, + "GetInvoicesDocumentResponse": { + "type": "object", + "properties": { + "invoicesDocument": { + "$ref": "#/components/schemas/InvoicesDocument" + } + }, + "description": "Success." + }, + "GetInvoicesExportResponse": { + "type": "object", + "properties": { + "export": { + "$ref": "#/components/schemas/Export" + } + }, + "description": "Success." + }, + "GetInvoicesExportsResponse": { + "type": "object", + "properties": { + "exports": { + "maxItems": 100, + "type": "array", + "description": "A list of exports.", + "items": { + "$ref": "#/components/schemas/Export" + } + }, + "nextToken": { + "type": "string", + "description": "This token is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getInvoices` operation and include this token with the previous call parameters." + } + }, + "description": "Success." + }, + "GetInvoicesResponse": { + "type": "object", + "properties": { + "invoices": { + "maxItems": 100, + "type": "array", + "description": "A list of invoices.", + "items": { + "$ref": "#/components/schemas/Invoice" + } + }, + "nextToken": { + "type": "string", + "description": "This token is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getInvoices` operation and include this token with the previous call parameters." + } + }, + "description": "Success." + }, + "Invoice": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "The date and time the invoice is issued. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", + "format": "date-time" + }, + "errorCode": { + "type": "string", + "description": "If the invoice is in an error state, this attribute displays the error code." + }, + "externalInvoiceId": { + "type": "string", + "description": "The invoice identifier that is used by an external party. This is typically the government agency that authorized the invoice." + }, + "govResponse": { + "type": "string", + "description": "The response message from the government authority when there is an error during invoice issuance." + }, + "id": { + "type": "string", + "description": "The invoice identifier." + }, + "invoiceType": { + "type": "string", + "description": "The classification of the invoice type. This varies across marketplaces. Use the `getInvoicesAttributes` operation to check `invoiceType` options." + }, + "series": { + "type": "string", + "description": "Use this identifier in conjunction with `externalInvoiceId` to identify invoices from the same seller." + }, + "status": { + "type": "string", + "description": "The invoice status classification. Use the `getInvoicesAttributes` operation to check invoice status options." + }, + "transactionIds": { + "type": "array", + "description": "List with identifiers for the transactions associated to the invoice.", + "items": { + "$ref": "#/components/schemas/TransactionIdentifier" + } + }, + "transactionType": { + "type": "string", + "description": "Classification of the transaction that originated this invoice. Use the `getInvoicesAttributes` operation to check `transactionType` options." + } + }, + "description": "Provides detailed information about an invoice." + }, + "InvoicesAttributes": { + "type": "object", + "properties": { + "invoiceStatusOptions": { + "type": "array", + "description": "A list of all the options that are available for the invoice status attribute.", + "items": { + "$ref": "#/components/schemas/AttributeOption" + } + }, + "invoiceTypeOptions": { + "type": "array", + "description": "A list of all the options that are available for the invoice type attribute.", + "items": { + "$ref": "#/components/schemas/AttributeOption" + } + }, + "transactionIdentifierNameOptions": { + "type": "array", + "description": "A list of all the options that are available for the transaction identifier name attribute.", + "items": { + "$ref": "#/components/schemas/AttributeOption" + } + }, + "transactionTypeOptions": { + "type": "array", + "description": "A list of all the options that are available for the transaction type attribute.", + "items": { + "$ref": "#/components/schemas/AttributeOption" + } + } + }, + "description": "An object that contains the invoice attributes definition." + }, + "InvoicesDocument": { + "type": "object", + "properties": { + "invoicesDocumentId": { + "type": "string", + "description": "The identifier of the export document." + }, + "invoicesDocumentUrl": { + "type": "string", + "description": "A pre-signed URL that you can use to download the invoices document in zip format. This URL expires after 30 seconds." + } + }, + "description": "An object that contains the `documentId` and an S3 pre-signed URL that you can use to download the specified file." + }, + "TransactionIdentifier": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The transaction identifier name. Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options." + }, + "id": { + "type": "string", + "description": "The transaction identifier." + } + }, + "description": "The identifier for a transaction." + }, + "ErrorList": { + "required": [ + "errors" + ], + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of errors.", + "items": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "A list of error responses that are returned when a request is unsuccessful." + } + } + }, + "x-original-swagger-version": "2.0" +} \ No newline at end of file diff --git a/resources/models/raw/seller/listings-items/v2021-08-01.json b/resources/models/raw/seller/listings-items/v2021-08-01.json index 33ebf7996..374f53d00 100644 --- a/resources/models/raw/seller/listings-items/v2021-08-01.json +++ b/resources/models/raw/seller/listings-items/v2021-08-01.json @@ -53,6 +53,7 @@ "style": "form", "explode": false, "schema": { + "maxItems": 1, "type": "array", "items": { "type": "string" @@ -169,6 +170,10 @@ "price": { "currencyCode": "USD", "amount": "100.00" + }, + "audience": { + "value": "ALL", + "displayName": "Sell on Amazon" } } ], @@ -299,6 +304,10 @@ "price": { "currencyCode": "USD", "amount": "100.00" + }, + "audience": { + "value": "ALL", + "displayName": "Sell on Amazon" } } ], @@ -608,6 +617,7 @@ "style": "form", "explode": false, "schema": { + "maxItems": 1, "type": "array", "items": { "type": "string" @@ -656,7 +666,7 @@ "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", - "description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog." + "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ] }, @@ -664,7 +674,7 @@ "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", - "description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog." + "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ] }, @@ -1023,6 +1033,7 @@ "style": "form", "explode": false, "schema": { + "maxItems": 1, "type": "array", "items": { "type": "string" @@ -1275,6 +1286,7 @@ "style": "form", "explode": false, "schema": { + "maxItems": 1, "type": "array", "items": { "type": "string" @@ -1323,7 +1335,7 @@ "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", - "description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog." + "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ] }, @@ -1331,7 +1343,7 @@ "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", - "description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog." + "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ] }, @@ -1648,217 +1660,1481 @@ }, "x-codegen-request-body-name": "body" } - } - }, - "components": { - "schemas": { - "Error": { - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "An error code that identifies the type of error that occurred." - }, - "message": { - "type": "string", - "description": "A message that describes the error condition." - }, - "details": { - "type": "string", - "description": "Additional details that can help the caller understand or fix the issue." - } - }, - "description": "Error response returned when the request is unsuccessful." - }, - "ErrorList": { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Error" - } - } - }, - "description": "A list of error responses returned when a request is unsuccessful." - }, - "Item": { - "required": [ - "sku" + }, + "/listings/2021-08-01/items/{sellerId}": { + "get": { + "tags": [ + "listings" ], - "type": "object", - "properties": { - "sku": { - "type": "string", - "description": "A selling partner provided identifier for an Amazon listing." - }, - "summaries": { - "$ref": "#/components/schemas/ItemSummaries" - }, - "attributes": { - "$ref": "#/components/schemas/ItemAttributes" - }, - "issues": { - "$ref": "#/components/schemas/ItemIssues" - }, - "offers": { - "$ref": "#/components/schemas/ItemOffers" - }, - "fulfillmentAvailability": { - "type": "array", - "description": "The fulfillment availability for the listings item.", - "items": { - "$ref": "#/components/schemas/FulfillmentAvailability" - } - }, - "procurement": { - "type": "array", - "description": "The vendor procurement information for the listings item.", - "items": { - "$ref": "#/components/schemas/ItemProcurement" + "description": "Search for and return list of listings items and respective details for a selling partner.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 5 |\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": "searchListingsItems", + "parameters": [ + { + "name": "sellerId", + "in": "path", + "description": "A selling partner identifier, such as a merchant account or vendor code.", + "required": true, + "schema": { + "type": "string" } - } - }, - "description": "A listings item." - }, - "ItemSummaries": { - "type": "array", - "description": "Summary details of a listings item.", - "items": { - "$ref": "#/components/schemas/ItemSummaryByMarketplace" - } - }, - "ItemSummaryByMarketplace": { - "required": [ - "asin", - "createdDate", - "itemName", - "lastUpdatedDate", - "marketplaceId", - "productType", - "status" - ], - "type": "object", - "properties": { - "marketplaceId": { - "type": "string", - "description": "A marketplace identifier. Identifies the Amazon marketplace for the listings item." }, - "asin": { - "type": "string", - "description": "Amazon Standard Identification Number (ASIN) of the listings item." + { + "name": "marketplaceIds", + "in": "query", + "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", + "required": true, + "style": "form", + "explode": false, + "schema": { + "maxItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "example": "ATVPDKIKX0DER" }, - "productType": { - "type": "string", - "description": "The Amazon product type of the listings item." + { + "name": "identifiers", + "in": "query", + "description": "A comma-delimited list of product identifiers to search for listings items by. \n\n**Note**: \n1. Required when `identifiersType` is provided.", + "style": "form", + "explode": false, + "schema": { + "maxItems": 20, + "type": "array", + "items": { + "type": "string" + } + }, + "example": "GM-ZDPI-9B4E" }, - "conditionType": { - "type": "string", - "description": "Identifies the condition of the listings item.", - "enum": [ - "new_new", - "new_open_box", - "new_oem", - "refurbished_refurbished", - "used_like_new", - "used_very_good", - "used_good", - "used_acceptable", - "collectible_like_new", - "collectible_very_good", - "collectible_good", - "collectible_acceptable", - "club_club" - ], + { + "name": "identifiersType", + "in": "query", + "description": "Type of product identifiers to search for listings items by. \n\n**Note**: \n1. Required when `identifiers` is provided.", + "schema": { + "type": "string", + "enum": [ + "ASIN", + "EAN", + "GTIN", + "ISBN", + "JAN", + "MINSAN", + "SKU", + "UPC" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ASIN", + "description": "Amazon Standard Identification Number." + }, + { + "value": "EAN", + "description": "European Article Number." + }, + { + "value": "GTIN", + "description": "Global Trade Item Number." + }, + { + "value": "ISBN", + "description": "International Standard Book Number." + }, + { + "value": "JAN", + "description": "Japanese Article Number." + }, + { + "value": "MINSAN", + "description": "Minsan Code." + }, + { + "value": "SKU", + "description": "Stock Keeping Unit, a seller-specified identifier for an Amazon listing." + }, + { + "value": "UPC", + "description": "Universal Product Code." + } + ] + }, + "example": "SKU", "x-docgen-enum-table-extension": [ { - "value": "new_new", - "description": "New." - }, - { - "value": "new_open_box", - "description": "New - Open Box." - }, - { - "value": "new_oem", - "description": "New - OEM." - }, - { - "value": "refurbished_refurbished", - "description": "Refurbished." - }, - { - "value": "used_like_new", - "description": "Used - Like New." - }, - { - "value": "used_very_good", - "description": "Used - Very Good." + "value": "ASIN", + "description": "Amazon Standard Identification Number." }, { - "value": "used_good", - "description": "Used - Good." + "value": "EAN", + "description": "European Article Number." }, { - "value": "used_acceptable", - "description": "Used - Acceptable." + "value": "GTIN", + "description": "Global Trade Item Number." }, { - "value": "collectible_like_new", - "description": "Collectible - Like New." + "value": "ISBN", + "description": "International Standard Book Number." }, { - "value": "collectible_very_good", - "description": "Collectible - Very Good." + "value": "JAN", + "description": "Japanese Article Number." }, { - "value": "collectible_good", - "description": "Collectible - Good." + "value": "MINSAN", + "description": "Minsan Code." }, { - "value": "collectible_acceptable", - "description": "Collectible - Acceptable." + "value": "SKU", + "description": "Stock Keeping Unit, a seller-specified identifier for an Amazon listing." }, { - "value": "club_club", - "description": "Club." + "value": "UPC", + "description": "Universal Product Code." } ] }, - "status": { - "type": "array", - "description": "Statuses that apply to the listings item.", - "items": { - "type": "string", - "enum": [ - "BUYABLE", - "DISCOVERABLE" - ], - "x-docgen-enum-table-extension": [ - { - "value": "BUYABLE", - "description": "The listings item can be purchased by shoppers. This status does not apply to vendor listings." - }, - { - "value": "DISCOVERABLE", - "description": "The listings item is visible to shoppers." - } - ] - } + { + "name": "pageSize", + "in": "query", + "description": "Number of results to be returned per page.", + "schema": { + "maximum": 20, + "type": "integer", + "default": 10 + }, + "example": 9 }, - "fnSku": { - "type": "string", - "description": "The fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item." + { + "name": "pageToken", + "in": "query", + "description": "A token to fetch a certain page when there are multiple pages worth of results.", + "schema": { + "type": "string" + }, + "example": "sdlkj234lkj234lksjdflkjwdflkjsfdlkj234234234234" }, - "itemName": { - "type": "string", + { + "name": "includedData", + "in": "query", + "description": "A comma-delimited list of data sets to include in the response. Default: summaries.", + "style": "form", + "explode": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "summaries", + "attributes", + "issues", + "offers", + "fulfillmentAvailability", + "procurement" + ], + "x-docgen-enum-table-extension": [ + { + "value": "summaries", + "description": "Summary details of the listing item." + }, + { + "value": "attributes", + "description": "JSON object containing structured listing item attribute data keyed by attribute name." + }, + { + "value": "issues", + "description": "Issues associated with the listing item." + }, + { + "value": "offers", + "description": "Current offers for the listing item." + }, + { + "value": "fulfillmentAvailability", + "description": "Fulfillment availability details for the listing item." + }, + { + "value": "procurement", + "description": "Vendor procurement details for the listing item. " + } + ] + }, + "default": "[\"summaries\"]" + }, + "example": "summaries" + }, + { + "name": "issueLocale", + "in": "query", + "description": "A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale.", + "schema": { + "type": "string" + }, + "example": "en_US" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ItemSearchResults" + }, + "example": { + "numberOfResults": 3, + "pagination": { + "nextToken": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234", + "previousToken": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d" + }, + "items": [ + { + "sku": "GM-ZDPI-9B4E", + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "asin": "B071VG5N9D", + "productType": "LUGGAGE", + "conditionType": "new_new", + "status": [ + "BUYABLE" + ], + "itemName": "Hardside Carry-On Spinner Suitcase Luggage", + "createdDate": "2021-02-01T00:00:00Z", + "lastUpdatedDate": "2021-03-01T00:00:00Z", + "mainImage": { + "link": "https://www.example.com/luggage.png", + "height": 500, + "width": 500 + } + } + ], + "attributes": { + "total_hdmi_ports": [ + { + "value": 4, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "resolution": [ + { + "language_tag": "en_US", + "value": "4K", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_weight": [ + { + "unit": "pounds", + "value": 107.6, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "product_subcategory": [ + { + "value": "50400120", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "bullet_point": [ + { + "language_tag": "en_US", + "value": "SMART TV WITH UNIVERSAL GUIDE: Simple on-screen Guide is an easy way to find streaming content and live TV shows", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "100% COLOR VOLUME WITH QUANTUM DOTS: Powered by Quantum dots, Samsung\u2019s 4K QLED TV offers over a billion shades of brilliant color and 100% color volume for exceptional depth of detail that will draw you in to the picture for the best 4K TV experience", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "QUANTUM PROCESSOR 4K: Intelligently powered processor instantly upscales content to 4K for sharp detail and refined color", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "QUANTUM HDR 4X: 4K depth of detail with high dynamic range powered by HDR10+ delivers the lightest to darkest colors, scene by scene, for amazing picture realism", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "AMBIENT MODE: Customizes and complements your living space by turning a blank screen of this big screen TV into enticing visuals including d\u00e9cor, info, photos and artwork", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "SMART TV FEATURES: OneRemote to control all compatible devices, Bixby voice command, on-screen universal guide, SmartThings to control compatible home appliances and devices, smart speaker expandability with Alexa and Google Assistant compatibility, and more", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_dimensions": [ + { + "width": { + "unit": "inches", + "value": 72.4 + }, + "length": { + "unit": "inches", + "value": 2.4 + }, + "height": { + "unit": "inches", + "value": 41.4 + }, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "brand": [ + { + "language_tag": "en_US", + "value": "SAMSUNG", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "generic_keyword": [ + { + "language_tag": "en_US", + "value": "oled 65 inch smart tv qled 75 inch tv 85 inch 4k tv smart tv 4k tv 65 inch qled 82 inch tv 8k tv oled 65 smart tv qled 65 inch 80 inch tv 4k 4k tv shield tv 2018", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "q9fn qled 2018 oled 4k 4k oled toshiba antenna dvd player outdoor tv kitchen tv fire tv firetv hdtv hd tv android shield tv gaming deals tv ears dvr speakers digital tv antenna tv android tv frame mount", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "4k hdr tv 70 tv shield tv 90 inch tv gaming tv 75 tv 65 inch 4k tv tv 65 inch smart tv 4k 65 inch 4k tv 65 inch 4k tv 4k tv uhd tv uhd tv 4k", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "smart tv 4k tv tv tv oled tv 65 inch smart tv 4k tv 65 inch smart tv shield tv 2018 tv 4k oled tv 65 4k tv 4k smart tv 4k hdr tv shield tv gaming tv 65 inch 4k tv tv 65 inch smart tv 4k 65 inch 4k tv 65 inch 4k tv 4k tv uhd tv uhd tv 4k", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "control_method": [ + { + "value": "voice", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_package_dimensions": [ + { + "length": { + "unit": "centimeters", + "value": 26.67 + }, + "width": { + "unit": "centimeters", + "value": 121.92 + }, + "height": { + "unit": "centimeters", + "value": 203.2 + }, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "image_aspect_ratio": [ + { + "language_tag": "en_US", + "value": "16:9", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "part_number": [ + { + "value": "QN82Q60RAFXZA", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "includes_remote": [ + { + "value": true, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "style": [ + { + "language_tag": "en_US", + "value": "TV only", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_type_name": [ + { + "language_tag": "en_US", + "value": "TV", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "battery": [ + { + "cell_composition": [ + { + "value": "alkaline" + } + ], + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "image_contrast_ratio": [ + { + "language_tag": "en_US", + "value": "QLED 4K", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "manufacturer": [ + { + "language_tag": "en_US", + "value": "Samsung", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "number_of_boxes": [ + { + "value": 1, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "total_usb_ports": [ + { + "value": 2, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "model_number": [ + { + "value": "QN82Q60RAFXZA", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "supplier_declared_dg_hz_regulation": [ + { + "value": "not_applicable", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "num_batteries": [ + { + "quantity": 2, + "type": "aaa", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "california_proposition_65": [ + { + "compliance_type": "on_product_combined_cancer_reproductive", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "compliance_type": "chemical", + "chemical_names": [ + "di_2_ethylhexyl_phthalate_dehp" + ], + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "display": [ + { + "resolution_maximum": [ + { + "unit": "pixels", + "language_tag": "en_US", + "value": "3840 x 2160" + } + ], + "size": [ + { + "unit": "inches", + "value": 82 + } + ], + "type": [ + { + "language_tag": "en_US", + "value": "QLED" + } + ], + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_name": [ + { + "language_tag": "en_US", + "value": "Samsung QN82Q60RAFXZA Flat 82-Inch QLED 4K Q60 Series (2019) Ultra HD Smart TV with HDR and Alexa Compatibility", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "list_price": [ + { + "currency": "USD", + "value": 3799.99, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "batteries_required": [ + { + "value": false, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "includes_rechargable_battery": [ + { + "value": false, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "product_site_launch_date": [ + { + "value": "2019-03-11T08:00:01.000Z", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "product_category": [ + { + "value": "50400100", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "batteries_included": [ + { + "value": false, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "connectivity_technology": [ + { + "language_tag": "en_US", + "value": "Bluetooth", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "USB", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Wireless", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "HDMI", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "included_components": [ + { + "language_tag": "en_US", + "value": "QLED Standard Smart Remote", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Power Cable", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Stand", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Samsung Smart Control", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "specification_met": [ + { + "language_tag": "en_US", + "value": "", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "parental_control_technology": [ + { + "value": "V-Chip", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "power_consumption": [ + { + "unit": "watts", + "value": 120, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "cpsia_cautionary_statement": [ + { + "value": "no_warning_applicable", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_type_keyword": [ + { + "value": "qled-televisions", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "number_of_items": [ + { + "value": 1, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "warranty_description": [ + { + "language_tag": "en_US", + "value": "1 year manufacturer", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "max_resolution": [ + { + "unit": "pixels", + "value": 8.3, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "color": [ + { + "language_tag": "en_US", + "value": "Black", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "screen_surface_description": [ + { + "language_tag": "en_US", + "value": "Flat", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_package_weight": [ + { + "unit": "kilograms", + "value": 62.142, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "speaker_type": [ + { + "language_tag": "en_US", + "value": "2CH", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "supported_internet_services": [ + { + "language_tag": "en_US", + "value": "Amazon Instant Video", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "YouTube", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Netflix", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Hulu", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Browser", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "tuner_technology": [ + { + "language_tag": "en_US", + "value": "Analog Tuner", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "controller_type": [ + { + "language_tag": "en_US", + "value": "SmartThings", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Voice Control", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "special_feature": [ + { + "language_tag": "en_US", + "value": "100% Color Volume with Quantum Dot; Quantum Processor 4K; Ambient Mode; Quantum HDR 4X; Real Game Enhancer", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "wireless_communication_technology": [ + { + "language_tag": "en_US", + "value": "Wi-Fi::Wi-Fi Direct::Bluetooth", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "model_year": [ + { + "value": 2019, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "power_source_type": [ + { + "language_tag": "en_US", + "value": "Corded Electric", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "street_date": [ + { + "value": "2019-03-21T00:00:01Z", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "mounting_type": [ + { + "language_tag": "en_US", + "value": "Table Mount", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Wall Mount", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "refresh_rate": [ + { + "unit": "hertz", + "language_tag": "en_US", + "value": "120", + "marketplace_id": "ATVPDKIKX0DER" + } + ] + }, + "offers": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "offerType": "B2C", + "price": { + "currencyCode": "USD", + "amount": "100.00" + } + } + ], + "fulfillmentAvailability": [ + { + "fulfillmentChannelCode": "DEFAULT", + "quantity": 100 + } + ], + "issues": [ + { + "code": "90220", + "message": "'size' is required but not supplied.", + "severity": "ERROR", + "attributeNames": [ + "size" + ], + "categories": [ + "MISSING_ATTRIBUTE" + ] + }, + { + "code": "18027", + "message": "We believe the main image has text, logo, graphic or watermark which is not permitted for this product type. Please submit a compliant image to lift the suppression. Also refer to Product image requirements.", + "severity": "ERROR", + "categories": [ + "INVALID_IMAGE" + ], + "enforcements": { + "actions": [ + { + "action": "SEARCH_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT_UNTIL_EXPIRY_DATE", + "expiryDate": "2025-05-28T00:36:48.914Z" + } + } + }, + { + "code": "99300", + "message": "Product Detail Page Rules Violation (Inaccurate information on product detail page)", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "ATTRIBUTE_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT" + } + } + }, + { + "code": "18155", + "message": "The 'minimum price' is greater than the selling price (excluding shipping) for the listing. Please review and update your price and/or minimum price.", + "severity": "ERROR", + "categories": [ + "INVALID_PRICE" + ], + "enforcements": { + "actions": [ + { + "action": "LISTING_SUPPRESSED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + }, + { + "code": "18742", + "message": "Restricted Products Policy Violation", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "CATALOG_ITEM_REMOVED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + } + ] + } + ] + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "identifiersType": { + "value": "SKU" + }, + "identifiers": { + "value": [ + "GM-ZDPI-9B4E", + "HW-ZDPI-9B4E", + "TC-ZDPI-9B4E" + ] + }, + "marketplaceIds": { + "value": [ + "ATVPDKIKX0DER" + ] + }, + "includedData": { + "value": [ + "summaries", + "offers", + "fulfillmentAvailability", + "issues" + ] + }, + "pageSize": { + "value": 1 + } + } + }, + "response": { + "numberOfResults": 3, + "pagination": { + "nextToken": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234", + "previousToken": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d" + }, + "items": [ + { + "sku": "GM-ZDPI-9B4E", + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "asin": "B071VG5N9D", + "productType": "LUGGAGE", + "conditionType": "new_new", + "status": [ + "BUYABLE" + ], + "itemName": "Hardside Carry-On Spinner Suitcase Luggage", + "createdDate": "2021-02-01T00:00:00Z", + "lastUpdatedDate": "2021-03-01T00:00:00Z", + "mainImage": { + "link": "https://www.example.com/luggage.png", + "height": 500, + "width": 500 + } + } + ], + "offers": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "offerType": "B2C", + "price": { + "currencyCode": "USD", + "amount": "100.00" + } + } + ], + "fulfillmentAvailability": [ + { + "fulfillmentChannelCode": "DEFAULT", + "quantity": 100 + } + ], + "issues": [ + { + "code": "90220", + "message": "'size' is required but not supplied.", + "severity": "ERROR", + "attributeNames": [ + "size" + ], + "categories": [ + "MISSING_ATTRIBUTE" + ] + }, + { + "code": "18027", + "message": "We believe the main image has text, logo, graphic or watermark which is not permitted for this product type. Please submit a compliant image to lift the suppression. Also refer to Product image requirements.", + "severity": "ERROR", + "categories": [ + "INVALID_IMAGE" + ], + "enforcements": { + "actions": [ + { + "action": "SEARCH_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT_UNTIL_EXPIRY_DATE", + "expiryDate": "2025-05-28T00:36:48.914Z" + } + } + }, + { + "code": "99300", + "message": "Product Detail Page Rules Violation (Inaccurate information on product detail page)", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "ATTRIBUTE_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT" + } + } + }, + { + "code": "18155", + "message": "The 'minimum price' is greater than the selling price (excluding shipping) for the listing. Please review and update your price and/or minimum price.", + "severity": "ERROR", + "categories": [ + "INVALID_PRICE" + ], + "enforcements": { + "actions": [ + { + "action": "LISTING_SUPPRESSED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + }, + { + "code": "18742", + "message": "Restricted Products Policy Violation", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "CATALOG_ITEM_REMOVED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + } + ] + } + ] + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "sellerId": { + "value": "SellerId" + }, + "marketplaceIds": { + "value": [ + "invalid" + ] + } + } + }, + "response": { + "errors": [ + { + "code": "BAD_REQUEST", + "message": "Invalid input", + "details": "Invalid input" + } + ] + } + } + ] + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "Error": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An error code that identifies the type of error that occurred." + }, + "message": { + "type": "string", + "description": "A message that describes the error condition." + }, + "details": { + "type": "string", + "description": "Additional details that can help the caller understand or fix the issue." + } + }, + "description": "Error response returned when the request is unsuccessful." + }, + "ErrorList": { + "required": [ + "errors" + ], + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "A list of error responses returned when a request is unsuccessful." + }, + "ItemSearchResults": { + "required": [ + "items", + "numberOfResults" + ], + "type": "object", + "properties": { + "numberOfResults": { + "type": "integer", + "description": "The total number of selling partner listings items found for the search criteria (only results up to the page count limit will be returned per request regardless of the number found).\n\nNote: The maximum number of items (SKUs) that can be returned and paged through is 1000." + }, + "pagination": { + "$ref": "#/components/schemas/Pagination" + }, + "items": { + "type": "array", + "description": "A list of listings items.", + "items": { + "$ref": "#/components/schemas/Item" + } + } + }, + "description": "Selling partner listings items and search related metadata." + }, + "Item": { + "required": [ + "sku" + ], + "type": "object", + "properties": { + "sku": { + "type": "string", + "description": "A selling partner provided identifier for an Amazon listing." + }, + "summaries": { + "$ref": "#/components/schemas/ItemSummaries" + }, + "attributes": { + "$ref": "#/components/schemas/ItemAttributes" + }, + "issues": { + "$ref": "#/components/schemas/ItemIssues" + }, + "offers": { + "$ref": "#/components/schemas/ItemOffers" + }, + "fulfillmentAvailability": { + "type": "array", + "description": "The fulfillment availability for the listings item.", + "items": { + "$ref": "#/components/schemas/FulfillmentAvailability" + } + }, + "procurement": { + "type": "array", + "description": "The vendor procurement information for the listings item.", + "items": { + "$ref": "#/components/schemas/ItemProcurement" + } + } + }, + "description": "A listings item." + }, + "ItemSummaries": { + "type": "array", + "description": "Summary details of a listings item.", + "items": { + "$ref": "#/components/schemas/ItemSummaryByMarketplace" + } + }, + "ItemSummaryByMarketplace": { + "required": [ + "asin", + "createdDate", + "itemName", + "lastUpdatedDate", + "marketplaceId", + "productType", + "status" + ], + "type": "object", + "properties": { + "marketplaceId": { + "type": "string", + "description": "A marketplace identifier. Identifies the Amazon marketplace for the listings item." + }, + "asin": { + "type": "string", + "description": "Amazon Standard Identification Number (ASIN) of the listings item." + }, + "productType": { + "type": "string", + "description": "The Amazon product type of the listings item." + }, + "conditionType": { + "type": "string", + "description": "Identifies the condition of the listings item.", + "enum": [ + "new_new", + "new_open_box", + "new_oem", + "refurbished_refurbished", + "used_like_new", + "used_very_good", + "used_good", + "used_acceptable", + "collectible_like_new", + "collectible_very_good", + "collectible_good", + "collectible_acceptable", + "club_club" + ], + "x-docgen-enum-table-extension": [ + { + "value": "new_new", + "description": "New." + }, + { + "value": "new_open_box", + "description": "New - Open Box." + }, + { + "value": "new_oem", + "description": "New - OEM." + }, + { + "value": "refurbished_refurbished", + "description": "Refurbished." + }, + { + "value": "used_like_new", + "description": "Used - Like New." + }, + { + "value": "used_very_good", + "description": "Used - Very Good." + }, + { + "value": "used_good", + "description": "Used - Good." + }, + { + "value": "used_acceptable", + "description": "Used - Acceptable." + }, + { + "value": "collectible_like_new", + "description": "Collectible - Like New." + }, + { + "value": "collectible_very_good", + "description": "Collectible - Very Good." + }, + { + "value": "collectible_good", + "description": "Collectible - Good." + }, + { + "value": "collectible_acceptable", + "description": "Collectible - Acceptable." + }, + { + "value": "club_club", + "description": "Club." + } + ] + }, + "status": { + "type": "array", + "description": "Statuses that apply to the listings item.", + "items": { + "type": "string", + "enum": [ + "BUYABLE", + "DISCOVERABLE" + ], + "x-docgen-enum-table-extension": [ + { + "value": "BUYABLE", + "description": "The listings item can be purchased by shoppers. This status does not apply to vendor listings." + }, + { + "value": "DISCOVERABLE", + "description": "The listings item is visible to shoppers." + } + ] + } + }, + "fnSku": { + "type": "string", + "description": "The fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item." + }, + "itemName": { + "type": "string", "description": "The name or title associated with an Amazon catalog item." }, "createdDate": { @@ -2089,6 +3365,9 @@ }, "points": { "$ref": "#/components/schemas/Points" + }, + "audience": { + "$ref": "#/components/schemas/Audience" } }, "description": "Offer details of a listings item for an Amazon marketplace." @@ -2156,6 +3435,21 @@ }, "description": "The number of Amazon Points offered with the purchase of an item, and their monetary value. Note that the `Points` element is only returned in Japan (JP)." }, + "Audience": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Name of the audience an offer is applicable to. \n\nCommon values: \n\n* 'ALL' - Standard offer audience for buyers on Amazon retail websites. \n\n* 'B2B' - Offer audience for Amazon Business website buyers.", + "example": "ALL" + }, + "displayName": { + "type": "string", + "description": "Localized display name for the audience." + } + }, + "description": "Buyer segment or program this offer is applicable to." + }, "PatchOperation": { "required": [ "op", @@ -2337,6 +3631,20 @@ } }, "description": "Identity attributes associated with the item in the Amazon catalog for the indicated Amazon marketplace." + }, + "Pagination": { + "type": "object", + "properties": { + "nextToken": { + "type": "string", + "description": "A token that can be used to fetch the next page." + }, + "previousToken": { + "type": "string", + "description": "A token that can be used to fetch the previous page." + } + }, + "description": "When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there will be no `nextToken` key in the pagination object." } } }, diff --git a/resources/models/raw/seller/orders/v0.json b/resources/models/raw/seller/orders/v0.json index 7969c5adf..c762583c1 100644 --- a/resources/models/raw/seller/orders/v0.json +++ b/resources/models/raw/seller/orders/v0.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "Selling Partner API for Orders", - "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. The Orders API supports orders that are two years old or less. Orders more than two years old will not show in the API response.\n\n**Note:** The Orders API supports orders from 2016 and after for the JP, AU, and SG marketplaces.", + "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).", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" @@ -24,13 +24,13 @@ "tags": [ "ordersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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": "A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in ISO 8601 format.\n\n**Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. You could specify `CreatedBefore` but not provide `LastUpdatedAfter` or `LastUpdatedBefore` when `CreatedAfter` is specified.", + "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.", "schema": { "type": "string" } @@ -38,7 +38,7 @@ { "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.\n\n**Note**: `CreatedBefore` is optional when `CreatedAfter` is specified. But if specified, `CreatedBefore` should be equal to or after the `CreatedAfter` date and at least 2 minutes before the current time.", + "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.", "schema": { "type": "string" } @@ -46,7 +46,7 @@ { "name": "LastUpdatedAfter", "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.\n\n**Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is specified. But if specified, `LastUpdatedBefore` should be equal to or after the `LastUpdatedAfter` date and at least 2 minutes before current time.", + "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.", "schema": { "type": "string" } @@ -54,7 +54,7 @@ { "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.\n\n**Note**: LastUpdatedBefore is optional when LastUpdatedAfter is set. But if specified, LastUpdatedBefore should be equal to or after the LastUpdatedAfter date and at least 2 minutes before current time.", + "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.", "schema": { "type": "string" } @@ -75,7 +75,7 @@ { "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.", + "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, "style": "form", "explode": false, @@ -90,7 +90,7 @@ { "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` (Fulfillment by Amazon); `MFN` (Fulfilled by the seller).", + "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).", "style": "form", "explode": false, "schema": { @@ -103,7 +103,7 @@ { "name": "PaymentMethods", "in": "query", - "description": "A list of payment method values. Used to select orders paid using the specified payment methods.\n\n**Possible values**: `COD` (Cash on delivery); `CVS` (Convenience store payment); `Other` (Any payment method other than `COD` or `CVS`).", + "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).", "style": "form", "explode": false, "schema": { @@ -124,7 +124,7 @@ { "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.", + "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.", "schema": { "type": "string" } @@ -174,7 +174,7 @@ { "name": "AmazonOrderIds", "in": "query", - "description": "A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.", + "description": "A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.", "style": "form", "explode": false, "schema": { @@ -188,7 +188,7 @@ { "name": "ActualFulfillmentSupplySourceId", "in": "query", - "description": "Denotes the recommended sourceId where the order should be fulfilled from.", + "description": "The `sourceId` of the location from where you want the order fulfilled.", "schema": { "type": "string" } @@ -212,7 +212,7 @@ { "name": "EarliestDeliveryDateBefore", "in": "query", - "description": "A date used for selecting orders with a earliest delivery date before (or at) a specified time. The date must be in ISO 8601 format.", + "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.", "schema": { "type": "string" } @@ -220,7 +220,7 @@ { "name": "EarliestDeliveryDateAfter", "in": "query", - "description": "A date used for selecting orders with a earliest delivery date after (or at) a specified time. The date must be in ISO 8601 format.", + "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.", "schema": { "type": "string" } @@ -228,7 +228,7 @@ { "name": "LatestDeliveryDateBefore", "in": "query", - "description": "A date used for selecting orders with a latest delivery date before (or at) a specified time. The date must be in ISO 8601 format.", + "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.", "schema": { "type": "string" } @@ -236,7 +236,7 @@ { "name": "LatestDeliveryDateAfter", "in": "query", - "description": "A date used for selecting orders with a latest delivery date after (or at) a specified time. The date must be in ISO 8601 format.", + "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.", "schema": { "type": "string" } @@ -679,7 +679,7 @@ "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 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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": [ { @@ -1059,7 +1059,7 @@ "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 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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": [ { @@ -1277,7 +1277,7 @@ "tags": [ "ordersV0" ], - "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.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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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.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": "getOrderAddress", "parameters": [ { @@ -1505,7 +1505,7 @@ "tags": [ "ordersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "getOrderItems", "parameters": [ { @@ -1848,7 +1848,7 @@ "tags": [ "ordersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "getOrderItemsBuyerInfo", "parameters": [ { @@ -2088,7 +2088,7 @@ "tags": [ "shipment" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "updateShipmentStatus", "parameters": [ { @@ -2181,7 +2181,7 @@ "errors": [ { "code": "InvalidInput", - "message": "Marketplace id is not defined", + "message": "Marketplace ID is not defined", "details": "1001" } ] @@ -2331,7 +2331,7 @@ "tags": [ "ordersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "getOrderRegulatedInfo", "parameters": [ { @@ -2526,6 +2526,191 @@ } } } + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-2592119-3531015" + } + } + }, + "response": { + "payload": { + "AmazonOrderId": "902-2592119-3531015", + "RequiresDosageLabel": false, + "RegulatedInformation": { + "Fields": [ + { + "FieldId": "pets_rx_scName", + "FieldLabel": "Pet name", + "FieldType": "Text", + "FieldValue": "Woofer" + }, + { + "FieldId": "pets_rx_scType", + "FieldLabel": "Pet type", + "FieldType": "Text", + "FieldValue": "Dog" + }, + { + "FieldId": "pets_rx_scBreed", + "FieldLabel": "Pet breed", + "FieldType": "Text", + "FieldValue": "Husky" + }, + { + "FieldId": "pets_rx_scGender", + "FieldLabel": "Pet gender", + "FieldType": "Text", + "FieldValue": "Female" + }, + { + "FieldId": "pets_rx_scDateOfBirth", + "FieldLabel": "Pet Birth Date", + "FieldType": "Text", + "FieldValue": "2016-05-01" + }, + { + "FieldId": "pets_rx_scWeight", + "FieldLabel": "Weight", + "FieldType": "Text", + "FieldValue": "12" + }, + { + "FieldId": "pets_rx_scWeightUnit", + "FieldLabel": "Weight Unit", + "FieldType": "Text", + "FieldValue": "Pound" + }, + { + "FieldId": "pets_rx_scHasAllergies", + "FieldLabel": "Does your pet have allergies?", + "FieldType": "Text", + "FieldValue": "False" + }, + { + "FieldId": "pets_rx_scTakesAdditionalMedications", + "FieldLabel": "Is your pet on any other medication?", + "FieldType": "Text", + "FieldValue": "False" + }, + { + "FieldId": "pets_rx_scHasOtherProblems", + "FieldLabel": "Any pet health problems?", + "FieldType": "Text", + "FieldValue": "False" + }, + { + "FieldId": "pets_rx_scSourceClinicId", + "FieldLabel": "Source Clinic ID", + "FieldType": "Text", + "FieldValue": "Clinic-1234" + }, + { + "FieldId": "pets_rx_scVetClinicName", + "FieldLabel": "Vet Clinic Name", + "FieldType": "Text", + "FieldValue": "Test Clinic" + }, + { + "FieldId": "pets_rx_scVetClinicCity", + "FieldLabel": "Vet Clinic City", + "FieldType": "Text", + "FieldValue": "Seattle" + }, + { + "FieldId": "pets_rx_scVetClinicState", + "FieldLabel": "Vet Clinic State", + "FieldType": "Text", + "FieldValue": "WA" + }, + { + "FieldId": "pets_rx_scVetClinicZipCode", + "FieldLabel": "Vet Clinic Zip Code", + "FieldType": "Text", + "FieldValue": "98000" + }, + { + "FieldId": "pets_rx_scVetClinicPhoneNumber", + "FieldLabel": "Vet Clinic Phone Number", + "FieldType": "Text", + "FieldValue": "2060000000" + } + ] + }, + "RegulatedOrderVerificationStatus": { + "Status": "Pending", + "RequiresMerchantAction": true, + "ValidRejectionReasons": [ + { + "RejectionReasonId": "pets_rx_sc_incorrect_product", + "RejectionReasonDescription": "Canceled order due to veterinarian indicating wrong product ordered" + }, + { + "RejectionReasonId": "pets_rx_sc_no_vcpr", + "RejectionReasonDescription": "Canceled order due to veterinarian indicating they do not have you as their client" + }, + { + "RejectionReasonId": "pets_rx_sc_visit_required", + "RejectionReasonDescription": "Canceled order due to veterinarian indicating they need to see your pet for an appointment" + }, + { + "RejectionReasonId": "pets_rx_sc_wrx_required", + "RejectionReasonDescription": "Canceled order due to veterinarian policy requiring you pick up a written prescription and mail to pharmacy" + }, + { + "RejectionReasonId": "pets_rx_sc_other", + "RejectionReasonDescription": "Canceled order due to prescription denied - contact your vetinarian" + }, + { + "RejectionReasonId": "pets_rx_sc_therapy_change", + "RejectionReasonDescription": "Canceled order due to a change in therapy, follow up with your veterinarian" + }, + { + "RejectionReasonId": "pets_rx_sc_wrong_weight", + "RejectionReasonDescription": "Canceled order due to incorrect pet weight on file, update weight and replace order or order correct product" + }, + { + "RejectionReasonId": "pets_rx_sc_early_refill", + "RejectionReasonDescription": "Canceled due to refilling prescription order too soon" + }, + { + "RejectionReasonId": "pets_rx_sc_wrong_species", + "RejectionReasonDescription": "Canceled due to ordering for wrong pet species, replace order for correct product" + }, + { + "RejectionReasonId": "pets_rx_sc_duplicate", + "RejectionReasonDescription": "Canceled due to duplicate order identified" + }, + { + "RejectionReasonId": "pets_rx_sc_invalid_rx", + "RejectionReasonDescription": "Canceled due to not receiving a valid prescription" + }, + { + "RejectionReasonId": "pets_rx_sc_address_validation_error", + "RejectionReasonDescription": "Canceled due to a non-verified address, correct address and replace order" + }, + { + "RejectionReasonId": "pets_rx_sc_no_clinic_match", + "RejectionReasonDescription": "Canceled due to no valid clinic match, provide complete and accurate details for vet clinic and replace order" + }, + { + "RejectionReasonId": "pets_rx_sc_pharmacist_canceled", + "RejectionReasonDescription": "Order canceled by pharmacy" + } + ], + "ValidVerificationDetails": [ + { + "VerificationDetailType": "prescriptionDetail", + "ValidVerificationStatuses": [ + "Approved" + ] + } + ] + } + } + } } ] } @@ -2677,7 +2862,7 @@ "tags": [ "ordersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "updateVerificationStatus", "parameters": [ { @@ -2739,6 +2924,34 @@ } }, "response": {} + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "externalReviewerId": "reviewer1234", + "verificationDetails": { + "prescriptionDetail": { + "prescriptionId": "Rx-1234", + "expirationDate": "2024-01-01T00:00:00Z", + "writtenQuantity": 3, + "totalRefillsAuthorized": 10, + "usageInstructions": "Take one per day by mouth with food", + "refillsRemaining": 10, + "clinicId": "ABC-1234" + } + } + } + } + } + } + }, + "response": {} } ] } @@ -2820,6 +3033,80 @@ } ] } + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "status": "Rejected", + "rejectionReasonId": "shield_pom_vps_reject_incorrect_weight", + "verificationDetails": { + "prescriptionDetail": { + "prescriptionId": "Rx-1234", + "expirationDate": "2024-01-01T00:00:00Z", + "writtenQuantity": 3, + "totalRefillsAuthorized": 10, + "usageInstructions": "Take one per day by mouth with food", + "refillsRemaining": 10, + "clinicId": "ABC-1234" + } + } + } + } + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Verification Detail `prescriptionDetail` is not supported when order is in Rejected status." + }, + { + "code": "InvalidInput", + "message": "Missing request parameter: externalReviewerId." + } + ] + } + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "externalReviewerId": "reviewer1234", + "verificationDetails": { + "prescriptionDetail": { + "prescriptionId": "Rx-1234", + "expirationDate": "2024-01-01T00:00:00Z", + "writtenQuantity": 3, + "totalRefillsAuthorized": 10, + "usageInstructions": "Take one per day by mouth with food", + "refillsRemaining": 10 + } + } + } + } + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Missing required parameter(s) from prescriptionDetail value: clinicId" + } + ] + } } ] } @@ -2965,7 +3252,7 @@ "tags": [ "ordersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "confirmShipment", "parameters": [ { @@ -2979,7 +3266,7 @@ } ], "requestBody": { - "description": "The request body of the `confirmShipment` operation.", + "description": "Request body of `confirmShipment`.", "content": { "application/json": { "schema": { @@ -3267,8 +3554,7 @@ }, "UpdateVerificationStatusRequestBody": { "required": [ - "externalReviewerId", - "status" + "externalReviewerId" ], "type": "object", "properties": { @@ -3277,11 +3563,14 @@ }, "externalReviewerId": { "type": "string", - "description": "The identifier for the order's regulated information reviewer." + "description": "The identifier of the order's regulated information reviewer." }, "rejectionReasonId": { "type": "string", - "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": "The unique identifier of the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected." + }, + "verificationDetails": { + "$ref": "#/components/schemas/VerificationDetails" } }, "description": "The updated values of the `VerificationStatus` field." @@ -3321,7 +3610,7 @@ "properties": { "orderItemId": { "type": "string", - "description": "The unique identifier of the order item." + "description": "The order item's unique identifier." }, "quantity": { "type": "integer", @@ -3447,11 +3736,11 @@ }, "LastUpdatedBefore": { "type": "string", - "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": "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. All dates must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "CreatedBefore": { "type": "string", - "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": "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." } }, "description": "A list of orders along with additional information to make subsequent API calls." @@ -3486,7 +3775,7 @@ }, "LastUpdateDate": { "type": "string", - "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 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." }, "OrderStatus": { "type": "string", @@ -3504,7 +3793,7 @@ "x-docgen-enum-table-extension": [ { "value": "Pending", - "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." + "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", @@ -3532,13 +3821,13 @@ }, { "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": "This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date for the item is in the future. The order is not ready for shipment." } ] }, "FulfillmentChannel": { "type": "string", - "description": "Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN).", + "description": "Whether the order was fulfilled by Amazon (`AFN`) or by the seller (`MFN`).", "enum": [ "MFN", "AFN" @@ -3556,15 +3845,15 @@ }, "SalesChannel": { "type": "string", - "description": "The sales channel of the first item in the order." + "description": "The sales channel for the first item in the order." }, "OrderChannel": { "type": "string", - "description": "The order channel of the first item in the order." + "description": "The order channel for the first item in the order." }, "ShipServiceLevel": { "type": "string", - "description": "The shipment service level of the order." + "description": "The order's shipment service level." }, "OrderTotal": { "$ref": "#/components/schemas/Money" @@ -3582,7 +3871,7 @@ }, "PaymentMethod": { "type": "string", - "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": "The payment method for the order. This property is limited to COD and 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.", "enum": [ "COD", "CVS", @@ -3612,7 +3901,7 @@ }, "ShipmentServiceLevelCategory": { "type": "string", - "description": "The shipment service level category of the order.\n\n**Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, `Standard`." + "description": "The shipment service level category for the order.\n\n**Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, and `Standard`." }, "EasyShipShipmentStatus": { "$ref": "#/components/schemas/EasyShipShipmentStatus" @@ -3623,7 +3912,7 @@ }, "OrderType": { "type": "string", - "description": "The type of the order.", + "description": "The order's type.", "enum": [ "StandardOrder", "LongLeadTimeOrder", @@ -3656,19 +3945,19 @@ }, "EarliestShipDate": { "type": "string", - "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 start of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders.\n\n__Note__: `EarliestShipDate` might not be returned for orders placed before February 1, 2013." }, "LatestShipDate": { "type": "string", - "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 end of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders.\n\n__Note__: `LatestShipDate` might not be returned for orders placed before February 1, 2013." }, "EarliestDeliveryDate": { "type": "string", - "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 start of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders." }, "LatestDeliveryDate": { "type": "string", - "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": "The end of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders that do not have a `PendingAvailability`, `Pending`, or `Canceled` status." }, "IsBusinessOrder": { "type": "boolean", @@ -3680,15 +3969,15 @@ }, "IsPremiumOrder": { "type": "boolean", - "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": "When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, refer to \"Premium Shipping Options\" in the Seller Central Help for your marketplace." }, "IsGlobalExpressEnabled": { "type": "boolean", - "description": "When true, the order is a GlobalExpress order." + "description": "When true, the order is a `GlobalExpress` order." }, "ReplacedOrderId": { "type": "string", - "description": "The order ID value for the order that is being replaced. Returned only if `IsReplacementOrder` = true." + "description": "The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true." }, "IsReplacementOrder": { "type": "boolean", @@ -3696,11 +3985,11 @@ }, "PromiseResponseDueDate": { "type": "string", - "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": "Indicates the date by which the seller must respond to the buyer with an estimated ship date. Only returned for Sourcing on Demand orders." }, "IsEstimatedShipDateSet": { "type": "boolean", - "description": "When true, the estimated ship date is specified for the order. Returned only for Sourcing on Demand orders." + "description": "When true, the estimated ship date is set for the order. Only returned for Sourcing on Demand orders." }, "IsSoldByAB": { "type": "boolean", @@ -3723,11 +4012,11 @@ "x-docgen-enum-table-extension": [ { "value": "INDIVIDUAL", - "description": "Buyer should be issued an individual invoice." + "description": "Issues an individual invoice to the buyer." }, { "value": "BUSINESS", - "description": "Buyer should be issued a business invoice. Tax information is available in `BuyerTaxInformation` structure." + "description": "Issues a business invoice to the buyer. Tax information is available in `BuyerTaxInformation`." } ] }, @@ -3798,7 +4087,7 @@ }, "PurchaseOrderNumber": { "type": "string", - "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 purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } }, "description": "Buyer information for an order." @@ -3856,14 +4145,21 @@ }, "ReviewDate": { "type": "string", - "description": "The date the order was reviewed. In ISO 8601 date time format." + "description": "The date the order was reviewed. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format." }, "ExternalReviewerId": { "type": "string", "description": "The identifier for the order's regulated information reviewer." + }, + "ValidVerificationDetails": { + "type": "array", + "description": "A list of valid verification details that may be provided and the criteria required for when the verification detail can be provided.", + "items": { + "$ref": "#/components/schemas/ValidVerificationDetail" + } } }, - "description": "The verification status of the order along with associated approval or rejection metadata." + "description": "The verification status of the order, along with associated approval or rejection metadata." }, "RejectionReason": { "required": [ @@ -3881,7 +4177,84 @@ "description": "The description of this rejection reason." } }, - "description": "The reason for rejecting the order's regulated information. Not present if the order isn't rejected." + "description": "The reason for rejecting the order's regulated information. This is only present if the order is rejected." + }, + "PrescriptionDetail": { + "required": [ + "clinicId", + "expirationDate", + "prescriptionId", + "refillsRemaining", + "totalRefillsAuthorized", + "usageInstructions", + "writtenQuantity" + ], + "type": "object", + "properties": { + "prescriptionId": { + "type": "string", + "description": "The identifier for the prescription used to verify the regulated product." + }, + "expirationDate": { + "type": "string", + "description": "The expiration date of the prescription used to verify the regulated product, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.", + "format": "date-time" + }, + "writtenQuantity": { + "minimum": 1, + "type": "integer", + "description": "The number of units in each fill as provided in the prescription." + }, + "totalRefillsAuthorized": { + "minimum": 0, + "type": "integer", + "description": "The total number of refills written in the original prescription used to verify the regulated product. If a prescription originally had no refills, this value must be 0." + }, + "refillsRemaining": { + "minimum": 0, + "type": "integer", + "description": "The number of refills remaining for the prescription used to verify the regulated product. If a prescription originally had 10 total refills, this value must be `10` for the first order, `9` for the second order, and `0` for the eleventh order. If a prescription originally had no refills, this value must be 0." + }, + "clinicId": { + "type": "string", + "description": "The identifier for the clinic which provided the prescription used to verify the regulated product." + }, + "usageInstructions": { + "type": "string", + "description": "The instructions for the prescription as provided by the approver of the regulated product." + } + }, + "description": "Information about the prescription that is used to verify a regulated product. This must be provided once per order and reflect the seller\u2019s own records. Only approved orders can have prescriptions." + }, + "ValidVerificationDetail": { + "required": [ + "ValidVerificationStatuses", + "VerificationDetailType" + ], + "type": "object", + "properties": { + "VerificationDetailType": { + "type": "string", + "description": "A supported type of verification detail. The type indicates which verification detail could be shared while updating the regulated order. Valid value: `prescriptionDetail`." + }, + "ValidVerificationStatuses": { + "type": "array", + "description": "A list of valid verification statuses where the associated verification detail type may be provided. For example, if the value of this field is [\"Approved\"], calls to provide the associated verification detail will fail for orders with a `VerificationStatus` of `Pending`, `Rejected`, `Expired`, or `Cancelled`.", + "items": { + "$ref": "#/components/schemas/VerificationStatus" + } + } + }, + "description": "The types of verification details that may be provided for the order and the criteria required for when the type of verification detail can be provided. The types of verification details allowed depend on the type of regulated product and will not change order to order." + }, + "VerificationDetails": { + "type": "object", + "properties": { + "prescriptionDetail": { + "$ref": "#/components/schemas/PrescriptionDetail" + } + }, + "description": "Additional information related to the verification of a regulated order." }, "VerificationStatus": { "type": "string", @@ -3943,11 +4316,11 @@ "properties": { "FieldId": { "type": "string", - "description": "The unique identifier for the field." + "description": "The unique identifier of the field." }, "FieldLabel": { "type": "string", - "description": "The name for the field." + "description": "The name of the field." }, "FieldType": { "type": "string", @@ -3959,17 +4332,17 @@ "x-docgen-enum-table-extension": [ { "value": "Text", - "description": "This field is a text representation of a response collected from the regulatory form." + "description": "This field is a text representation of the response collected from the regulatory form." }, { "value": "FileAttachment", - "description": "This field contains the link to an attachment collected from the regulatory form." + "description": "This field contains a link to an attachment collected from the regulatory form." } ] }, "FieldValue": { "type": "string", - "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 content of the field as collected in regulatory form. Note that `FileAttachment` type fields contain a URL where you can download the attachment." } }, "description": "A field collected from the regulatory form." @@ -3986,7 +4359,7 @@ }, "BuyerCompanyName": { "type": "string", - "description": "The company name of the contact buyer. For Invoice By Amazon (IBA) orders, the buyer company should be Amazon entities." + "description": "The company name of the contact buyer. For IBA orders, the buyer company must be Amazon entities." }, "ShippingAddress": { "$ref": "#/components/schemas/Address" @@ -4053,7 +4426,7 @@ }, "Phone": { "type": "string", - "description": "The phone number of the buyer.\n\n**Note**: \n1. This attribute is only available for shipping address.\n2. The buyer `Phone` number is suppressed in some cases, including but not limited to \na. `Phone` is suppressed for all Fulfillment by Amazon (FBA) orders.\nb. `Phone` is suppressed for the shipped MFN(Fulfilled by the seller) order when current date is past Latest Delivery Date." + "description": "The phone number of the buyer.\n\n**Note**: \n1. This attribute is only available for shipping address.\n2. In some cases, the buyer phone number is suppressed: \na. Phone is suppressed for all `AFN` (fulfilled by Amazon) orders.\nb. Phone is suppressed for the shipped `MFN` (fulfilled by seller) order when the current date is past the Latest Delivery Date." }, "ExtendedFields": { "$ref": "#/components/schemas/AddressExtendedFields" @@ -4088,7 +4461,7 @@ }, "StreetNumber": { "type": "string", - "description": "The house number/building number/property number in the street." + "description": "The house, building, or property number associated with the location's street address." }, "Complement": { "type": "string", @@ -4096,10 +4469,10 @@ }, "Neighborhood": { "type": "string", - "description": "The neighborhood. It's smaller than a region and an integral part of an address. It is used in some countries like Brazil." + "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, - "description": "The container of extended address fields. For example, street name, street number. Only available with Brazil shipping addresses as of now." + "description": "The container for address extended fields (such as `street name` and `street number`). Currently only available with Brazil shipping addresses." }, "DeliveryPreferences": { "type": "object", @@ -4137,7 +4510,7 @@ }, "ExceptionDates": { "type": "array", - "description": "Dates when the business is closed in the next 30 days.", + "description": "Dates when the business is closed during the next 30 days.", "items": { "$ref": "#/components/schemas/ExceptionDates" } @@ -4311,7 +4684,7 @@ }, "PaymentMethod": { "type": "string", - "description": "A sub-payment method for a COD order.\n\n**Possible values**:\n* `COD`: Cash On Delivery.\n* `GC`: Gift Card.\n* `PointsAccount`: Amazon Points.\n* `Invoice`: Invoice." + "description": "A sub-payment method for a COD order.\n\n**Possible values**:\n* `COD`: Cash on delivery \n* `GC`: Gift card \n* `PointsAccount`: Amazon Points\n* `Invoice`: Invoice" } }, "description": "Information about a sub-payment method used to pay for a COD order." @@ -4362,7 +4735,7 @@ "description": "The buyer's tax identifier." } }, - "description": "The tax classification for the order." + "description": "The tax classification of the order." }, "OrderItemsList": { "required": [ @@ -4402,11 +4775,11 @@ "properties": { "ASIN": { "type": "string", - "description": "The Amazon Standard Identification Number (ASIN) of the item." + "description": "The item's Amazon Standard Identification Number (ASIN)." }, "SellerSKU": { "type": "string", - "description": "The seller stock keeping unit (SKU) of the item." + "description": "The item's seller stock keeping unit (SKU)." }, "OrderItemId": { "type": "string", @@ -4421,7 +4794,7 @@ }, "Title": { "type": "string", - "description": "The name of the item." + "description": "The item's name." }, "QuantityOrdered": { "type": "integer", @@ -4472,46 +4845,46 @@ }, "IsGift": { "type": "string", - "description": "Indicates whether the item is a gift.\n\n**Possible values**: `true`, `false`." + "description": "Indicates whether the item is a gift.\n\n**Possible values**: `true` and `false`." }, "ConditionNote": { "type": "string", - "description": "The condition of the item as described by the seller." + "description": "The condition of the item, as described by the seller." }, "ConditionId": { "type": "string", - "description": "The condition of the item.\n\n**Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, `Club`." + "description": "The condition of the item.\n\n**Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, and `Club`." }, "ConditionSubtypeId": { "type": "string", - "description": "The subcondition of the item.\n\n**Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, `Other`." + "description": "The subcondition of the item.\n\n**Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, and `Other`." }, "ScheduledDeliveryStartDate": { "type": "string", - "description": "The start date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format." + "description": "The start date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format." }, "ScheduledDeliveryEndDate": { "type": "string", - "description": "The end date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format." + "description": "The end date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format." }, "PriceDesignation": { "type": "string", - "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, refer to [Amazon Business](https://business.amazon.com). \n\n**Possible values**: `BusinessPrice` - A special price that is available only for Amazon Business orders." + "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 values**: `BusinessPrice`" }, "TaxCollection": { "$ref": "#/components/schemas/TaxCollection" }, "SerialNumberRequired": { "type": "boolean", - "description": "When true, the product type for this item has a serial number.\n\nReturned only for Amazon Easy Ship orders." + "description": "When true, the product type for this item has a serial number.\n\n Only returned for Amazon Easy Ship orders." }, "IsTransparency": { "type": "boolean", - "description": "When true, the ASIN is enrolled in Transparency and the Transparency serial number that needs to be submitted can be determined by the following:\n\n**1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN).\n**2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number will be applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.\n**QR code SN:** Submit the URL that the QR code generates." + "description": "When true, the ASIN is enrolled in Transparency. The Transparency serial number that you must submit is determined by:\n\n**1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN).\n**2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.\n**QR code SN:** Submit the URL that the QR code generates." }, "IossNumber": { "type": "string", - "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 IOSS number of the marketplace. 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." }, "StoreChainStoreId": { "type": "string", @@ -4556,10 +4929,29 @@ }, "ShippingConstraints": { "$ref": "#/components/schemas/ShippingConstraints" + }, + "AmazonPrograms": { + "$ref": "#/components/schemas/AmazonPrograms" } }, "description": "A single order item." }, + "AmazonPrograms": { + "required": [ + "Programs" + ], + "type": "object", + "properties": { + "Programs": { + "type": "array", + "description": "A list of the programs that are associated with the specified order item.\n\n**Possible values**: `SUBSCRIBE_AND_SAVE`", + "items": { + "type": "string" + } + } + }, + "description": "Contains the list of programs that are associated with an item.\n\nPossible programs are:\n - **Subscribe and Save**: Offers recurring, scheduled deliveries to Amazon customers and Amazon Business customers for their frequently ordered products." + }, "SubstitutionPreferences": { "required": [ "SubstitutionType" @@ -4585,7 +4977,7 @@ }, { "value": "DO_NOT_SUBSTITUTE", - "description": "Do not provide substitute if item is not found." + "description": "Do not provide a substitute if item is not found." } ] }, @@ -4607,7 +4999,7 @@ "properties": { "ASIN": { "type": "string", - "description": "The Amazon Standard Identification Number (ASIN) of the item." + "description": "The item's Amazon Standard Identification Number (ASIN)." }, "QuantityOrdered": { "type": "integer", @@ -4615,11 +5007,11 @@ }, "SellerSKU": { "type": "string", - "description": "The seller stock keeping unit (SKU) of the item." + "description": "The item's seller stock keeping unit (SKU)." }, "Title": { "type": "string", - "description": "The title of the item." + "description": "The item's title." }, "Measurement": { "$ref": "#/components/schemas/Measurement" @@ -4636,7 +5028,7 @@ "properties": { "Unit": { "type": "string", - "description": "The unit of measure for this measurement.", + "description": "The unit of measure.", "enum": [ "OUNCES", "POUNDS", @@ -4666,105 +5058,105 @@ "x-docgen-enum-table-extension": [ { "value": "OUNCES", - "description": "Indicates the item's measurement is measured in ounces." + "description": "The item is measured in ounces." }, { "value": "POUNDS", - "description": "Indicates the item's measurement is measured in pounds." + "description": "The item is measured in pounds." }, { "value": "KILOGRAMS", - "description": "Indicates the item's measurement is measured in kilograms." + "description": "The item is measured in kilograms." }, { "value": "GRAMS", - "description": "Indicates the item's measurement is measured in grams." + "description": "The item is measured in grams." }, { "value": "MILLIGRAMS", - "description": "Indicates the item's measurement is measured in milligrams." + "description": "The item is measured in milligrams." }, { "value": "INCHES", - "description": "Indicates the item's measurement is measured in inches." + "description": "The item is measured in inches." }, { "value": "FEET", - "description": "Indicates the item's measurement is measured in feet." + "description": "The item is measured in feet." }, { "value": "METERS", - "description": "Indicates the item's measurement is measured in meters." + "description": "The item is measured in meters." }, { "value": "CENTIMETERS", - "description": "Indicates the item's measurement is measured in centimeters." + "description": "The item is measured in centimeters." }, { "value": "MILLIMETERS", - "description": "Indicates the item's measurement is measured in millimeters." + "description": "The item is measured in millimeters." }, { "value": "SQUARE_METERS", - "description": "Indicates the item's measurement is measured in square meters." + "description": "The item is measured in square meters." }, { "value": "SQUARE_CENTIMETERS", - "description": "Indicates the item's measurement is measured in square centimeters." + "description": "The item is measured in square centimeters." }, { "value": "SQUARE_FEET", - "description": "Indicates the item's measurement is measured in square feet." + "description": "The item is measured in square feet." }, { "value": "SQUARE_INCHES", - "description": "Indicates the item's measurement is measured in square inches." + "description": "The item is measured in square inches." }, { "value": "GALLONS", - "description": "Indicates the item's measurement is measured in gallons." + "description": "The item is measured in gallons." }, { "value": "PINTS", - "description": "Indicates the item's measurement is measured in pints." + "description": "The item is measured in pints." }, { "value": "QUARTS", - "description": "Indicates the item's measurement is measured in quarts." + "description": "The item is measured in quarts." }, { "value": "FLUID_OUNCES", - "description": "Indicates the item's measurement is measured in fluid ounces." + "description": "The item is measured in fluid ounces." }, { "value": "LITERS", - "description": "Indicates the item's measurement is measured in liters." + "description": "The item is measured in liters." }, { "value": "CUBIC_METERS", - "description": "Indicates the item's measurement is measured in cubic meters." + "description": "The item is measured in cubic meters." }, { "value": "CUBIC_FEET", - "description": "Indicates the item's measurement is measured in cubic feet." + "description": "The item is measured in cubic feet." }, { "value": "CUBIC_INCHES", - "description": "Indicates the item's measurement is measured in cubic inches." + "description": "The item is measured in cubic inches." }, { "value": "CUBIC_CENTIMETERS", - "description": "Indicates the item's measurement is measured in cubic centimeters." + "description": "The item is measured in cubic centimeters." }, { "value": "COUNT", - "description": "Indicates the item's measurement is measured by count." + "description": "The item is measured by count." } ] }, "Value": { "type": "number", - "description": "The value of the measurement." + "description": "The measurement value." } }, "description": "Measurement information for an order item." @@ -4784,7 +5176,7 @@ "$ref": "#/components/schemas/AssociationType" } }, - "description": "An item associated with an order item. For example, a tire installation service purchased with tires." + "description": "An item that is associated with an order item. For example, a tire installation service that is purchased with tires." }, "AssociationType": { "type": "string", @@ -4848,7 +5240,7 @@ }, "GiftMessageText": { "type": "string", - "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (Fulfilled by the seller) orders." + "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (fulfilled by seller) orders." }, "GiftWrapLevel": { "type": "string", @@ -4892,7 +5284,7 @@ "properties": { "CustomizedURL": { "type": "string", - "description": "The location of a zip file containing Amazon Custom data." + "description": "The location of a ZIP file containing Amazon Custom data." } }, "description": "Buyer information for custom orders from the Amazon Custom program." @@ -4956,16 +5348,25 @@ "properties": { "FulfillmentSupplySourceId": { "type": "string", - "description": "Denotes the recommended `sourceId` where the order should be fulfilled from." + "description": "The `sourceId` of the location from where you want the order fulfilled." } }, - "description": "Contains the instructions about the fulfillment like where should it be fulfilled from." + "description": "Contains the instructions about the fulfillment, such as the location from where you want the order filled." }, "ShippingConstraints": { "type": "object", "properties": { "PalletDelivery": { "$ref": "#/components/schemas/ConstraintType" + }, + "SignatureConfirmation": { + "$ref": "#/components/schemas/ConstraintType" + }, + "RecipientIdentityVerification": { + "$ref": "#/components/schemas/ConstraintType" + }, + "RecipientAgeVerification": { + "$ref": "#/components/schemas/ConstraintType" } }, "description": "Delivery constraints applicable to this order." @@ -5003,7 +5404,7 @@ }, "PurchaseOrderNumber": { "type": "string", - "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 purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } }, "description": "Buyer information." @@ -5022,7 +5423,7 @@ }, "GiftMessageText": { "type": "string", - "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (Fulfilled by the seller) orders." + "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (fulfilled by seller) orders." }, "GiftWrapLevel": { "type": "string", @@ -5065,7 +5466,7 @@ }, "EasyShipShipmentStatus": { "type": "string", - "description": "The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.", + "description": "The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.", "enum": [ "PendingSchedule", "PendingPickUp", @@ -5196,7 +5597,7 @@ }, "codCollectionMethod": { "type": "string", - "description": "The cod collection method, support in JP only. ", + "description": "The COD collection method (only supported in the JP marketplace).", "enum": [ "DirectPayment" ] @@ -5231,11 +5632,11 @@ }, "carrierCode": { "type": "string", - "description": "Identifies the carrier that will deliver the package. This field is required for all marketplaces. For the acceptable `CarrierCode` value, refer to the list of CarrierCode." + "description": "Identifies the carrier that will deliver the package. This field is required for all marketplaces. For more information, refer to the [`CarrierCode` announcement](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\" " + "description": "Carrier Name that will deliver the package. Required when `carrierCode` is \"Others\" " }, "shippingMethod": { "type": "string", @@ -5252,7 +5653,7 @@ }, "shipFromSupplySourceId": { "type": "string", - "description": "The unique identifier of the supply source." + "description": "The unique identifier for the supply source." }, "orderItems": { "$ref": "#/components/schemas/ConfirmShipmentOrderItemsList" @@ -5276,11 +5677,11 @@ "properties": { "orderItemId": { "type": "string", - "description": "The unique identifier of the order item." + "description": "The order item's unique identifier." }, "quantity": { "type": "integer", - "description": "The quantity of the item." + "description": "The item's quantity." }, "transparencyCodes": { "$ref": "#/components/schemas/TransparencyCodeList" @@ -5297,7 +5698,7 @@ }, "TransparencyCode": { "type": "string", - "description": "The Transparency code associated with the item." + "description": "The transparency code associated with the item." }, "PackageReferenceId": { "type": "string", diff --git a/resources/models/raw/seller/product-pricing/v2022-05-01.json b/resources/models/raw/seller/product-pricing/v2022-05-01.json index e77102f5b..b48e6a4f9 100644 --- a/resources/models/raw/seller/product-pricing/v2022-05-01.json +++ b/resources/models/raw/seller/product-pricing/v2022-05-01.json @@ -1824,9 +1824,6 @@ "description": "A list of error responses returned when a request is unsuccessful." }, "FeaturedOfferExpectedPriceResponseBody": { - "required": [ - "offerIdentifier" - ], "type": "object", "properties": { "offerIdentifier": { diff --git a/resources/models/raw/seller/sellers/v1.json b/resources/models/raw/seller/sellers/v1.json index 6dc685f91..d8741e221 100644 --- a/resources/models/raw/seller/sellers/v1.json +++ b/resources/models/raw/seller/sellers/v1.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "Selling Partner API for Sellers", - "description": "The Selling Partner API for Sellers lets you retrieve information on behalf of sellers about their seller account, such as the marketplaces they participate in. Along with listing the marketplaces that a seller can sell in, the API also provides additional information about the marketplace such as the default language and the default currency. The API also provides seller-specific information such as whether the seller has suspended listings in that marketplace.", + "description": "The [Selling Partner API for Sellers](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) (Sellers API) provides essential information about seller accounts, such as:\n\n- The marketplaces a seller can list in\n- The default language and currency of a marketplace\n- Whether the seller has suspended listings\n\nRefer to the [Sellers API reference](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) for details about this API's operations, data types, and schemas.", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" @@ -24,14 +24,14 @@ "tags": [ "sellers" ], - "description": "Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller's participation in those marketplaces.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.016 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of marketplaces where the seller can list items and information about the seller's participation in those marketplaces.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.016 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getMarketplaceParticipations", "responses": { "200": { "description": "Marketplace participations successfully retrieved.", "headers": { "x-amzn-RequestId": { - "description": "unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -100,7 +100,7 @@ "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -124,7 +124,7 @@ "description": "403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -142,7 +142,7 @@ "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -166,7 +166,7 @@ "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -190,7 +190,7 @@ "description": "The entity of the request is in a format not supported by the requested resource.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -214,7 +214,7 @@ "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -238,7 +238,7 @@ "description": "Encountered an unexpected condition which prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -262,7 +262,7 @@ "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -284,6 +284,310 @@ } } } + }, + "/sellers/v1/account": { + "get": { + "tags": [ + "sellers" + ], + "description": "Returns information about a seller account and its marketplaces.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.016 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getAccount", + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + }, + "example": { + "payload": { + "businessType": "PRIVATE_LIMITED", + "marketplaceLevelAttributes": [ + { + "marketplace": { + "id": "ATVPDKIKX0DER", + "name": "United States", + "countryCode": "US", + "domainName": "www.amazon.com" + }, + "storeName": "BestSellerStore", + "listingStatus": "ACTIVE", + "sellingPlan": "PROFESSIONAL" + } + ], + "business": { + "name": "BestSeller Inc.", + "nonLatinName": "\u30d9\u30b9\u30c8\u30bb\u30e9\u30fc\u682a\u5f0f\u4f1a\u793e", + "registeredBusinessAddress": { + "addressLine1": "123 Main St", + "addressLine2": "Suite 500", + "city": "Seattle", + "stateOrProvinceCode": "WA", + "postalCode": "98101", + "countryCode": "US" + }, + "companyRegistrationNumber": "123456789" + }, + "primaryContact": { + "name": "John Doe", + "nonLatinName": "\u30b8\u30e7\u30f3\u30fb\u30c9\u30a5", + "address": { + "addressLine1": "456 Oak St", + "addressLine2": "Apt 12", + "city": "Seattle", + "stateOrProvinceCode": "WA", + "postalCode": "98102", + "countryCode": "US" + } + } + } + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "response": { + "payload": { + "marketplaceLevelAttributes": [ + { + "marketplace": { + "id": "ATVPDKIKX0DER", + "name": "United States", + "countryCode": "US", + "domainName": "www.amazon.com" + }, + "storeName": "BestSellerStore", + "listingStatus": "ACTIVE", + "sellingPlan": "PROFESSIONAL" + } + ], + "businessType": "SOLE_PROPRIETORSHIP", + "business": { + "name": "BestSeller Inc.", + "registeredBusinessAddress": { + "addressLine1": "123 Main St", + "addressLine2": "Suite 500", + "city": "Seattle", + "stateOrProvinceCode": "WA", + "postalCode": "98101", + "countryCode": "US" + }, + "companyTaxIdentificationNumber": "TAX123456" + }, + "primaryContact": { + "name": "John Doe", + "nonLatinName": "\u30b8\u30e7\u30f3\u30fb\u30c9\u30a5", + "address": { + "addressLine1": "456 Oak St", + "addressLine2": "Apt 12", + "city": "Seattle", + "stateOrProvinceCode": "WA", + "postalCode": "98102", + "countryCode": "US" + } + } + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + }, + "example": { + "errors": [ + { + "code": "400", + "message": "Validation failed for obfuscatedId:ACUULBDVZHYZ1" + } + ] + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "response": { + "errors": [ + { + "code": "400", + "message": "Validation failed for obfuscatedId:ACUULBDVZHYZ1" + } + ] + } + } + ] + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + } + } + } } }, "components": { @@ -297,7 +601,7 @@ "properties": { "code": { "type": "string", - "description": "An error code that identifies the type of error that occured." + "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", @@ -305,7 +609,7 @@ }, "details": { "type": "string", - "description": "Additional details that can help the caller understand or fix the issue." + "description": "Additional details that can help you understand or fix the issue." } }, "description": "Error response returned when the request is unsuccessful." @@ -349,7 +653,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the getMarketplaceParticipations operation." + "description": "The response schema for the `getMarketplaceParticipations` operation." }, "Marketplace": { "required": [ @@ -368,7 +672,7 @@ }, "name": { "type": "string", - "description": "Marketplace name." + "description": "The marketplace name." }, "countryCode": { "pattern": "^([A-Z]{2})$", @@ -388,7 +692,7 @@ "description": "The domain name of the marketplace." } }, - "description": "Detailed information about an Amazon market where a seller can list items for sale and customers can view and purchase items." + "description": "Information about an Amazon marketplace where a seller can list items and customers can view and purchase items." }, "Participation": { "required": [ @@ -398,14 +702,237 @@ "type": "object", "properties": { "isParticipating": { - "type": "boolean" + "type": "boolean", + "description": "If `true`, the seller participates in the marketplace. Otherwise `false`." }, "hasSuspendedListings": { "type": "boolean", - "description": "Specifies if the seller has suspended listings. True if the seller Listing Status is set to Inactive, otherwise False." + "description": "Specifies if the seller has suspended listings. `true` if the seller Listing Status is set to Inactive, otherwise `false`." + } + }, + "description": "Information that is specific to a seller in a marketplace." + }, + "GetAccountResponse": { + "type": "object", + "properties": { + "payload": { + "$ref": "#/components/schemas/Account" + }, + "errors": { + "$ref": "#/components/schemas/ErrorList" + } + }, + "description": "The response schema for the `getAccount` operation." + }, + "MarketplaceLevelAttributes": { + "required": [ + "listingStatus", + "marketplace", + "sellingPlan", + "storeName" + ], + "type": "object", + "properties": { + "marketplace": { + "$ref": "#/components/schemas/Marketplace" + }, + "storeName": { + "type": "string", + "description": "The name of the seller's store as displayed in the marketplace." + }, + "listingStatus": { + "type": "string", + "description": "The current status of the seller's listings.", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ACTIVE", + "description": "The seller's listings are currently active." + }, + { + "value": "INACTIVE", + "description": "The seller's listings are currently inactive." + } + ] + }, + "sellingPlan": { + "type": "string", + "description": "The selling plan details.", + "enum": [ + "PROFESSIONAL", + "INDIVIDUAL" + ], + "x-docgen-enum-table-extension": [ + { + "value": "PROFESSIONAL", + "description": "The seller has a professional selling plan." + }, + { + "value": "INDIVIDUAL", + "description": "The seller has an individual selling plan." + } + ] + } + }, + "description": "Attributes that define the seller's presence and status within a specific marketplace. These attributes include the marketplace details, store name, listing status, and the selling plan the seller is subscribed to." + }, + "Account": { + "required": [ + "businessType", + "marketplaceLevelAttributes" + ], + "type": "object", + "properties": { + "marketplaceLevelAttributes": { + "type": "array", + "description": "A list of details of the marketplaces where the seller account is active.", + "items": { + "$ref": "#/components/schemas/MarketplaceLevelAttributes" + } + }, + "businessType": { + "type": "string", + "description": "The type of business registered for the seller account.", + "enum": [ + "CHARITY", + "CRAFTSMAN", + "NATURAL_PERSON_COMPANY", + "PUBLIC_LISTED", + "PRIVATE_LIMITED", + "SOLE_PROPRIETORSHIP", + "STATE_OWNED", + "INDIVIDUAL" + ], + "x-docgen-enum-table-extension": [ + { + "value": "CHARITY", + "description": "The business is registered as a charity." + }, + { + "value": "CRAFTSMAN", + "description": "The business is registered as a craftsman." + }, + { + "value": "NATURAL_PERSON_COMPANY", + "description": "The business is a natural person company." + }, + { + "value": "PUBLIC_LISTED", + "description": "The business is a publicly listed company." + }, + { + "value": "PRIVATE_LIMITED", + "description": "The business is a private limited company." + }, + { + "value": "SOLE_PROPRIETORSHIP", + "description": "The business is a sole proprietorship." + }, + { + "value": "STATE_OWNED", + "description": "The business is state-owned." + }, + { + "value": "INDIVIDUAL", + "description": "The entity is not a business but an individual." + } + ] + }, + "business": { + "$ref": "#/components/schemas/Business" + }, + "primaryContact": { + "$ref": "#/components/schemas/PrimaryContact" + } + }, + "description": "The response schema for the `getAccount` operation." + }, + "Business": { + "required": [ + "name", + "registeredBusinessAddress" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The registered business name." + }, + "registeredBusinessAddress": { + "$ref": "#/components/schemas/Address" + }, + "companyRegistrationNumber": { + "type": "string", + "description": "The seller's company registration number, if applicable. This field will be absent for individual sellers and sole proprietorships." + }, + "companyTaxIdentificationNumber": { + "type": "string", + "description": "The seller's company tax identification number, if applicable. This field will be present for certain business types only, such as sole proprietorships." + }, + "nonLatinName": { + "type": "string", + "description": "The non-Latin script version of the registered business name, if applicable." + } + }, + "description": "Information about the seller's business. Certain fields may be omitted depending on the seller's `businessType`." + }, + "Address": { + "required": [ + "addressLine1", + "countryCode" + ], + "type": "object", + "properties": { + "addressLine1": { + "type": "string", + "description": "Street address information." + }, + "addressLine2": { + "type": "string", + "description": "Additional street address information." + }, + "countryCode": { + "type": "string", + "description": "The country code in two-character ISO 3166-1 alpha-2 format." + }, + "stateOrProvinceCode": { + "type": "string", + "description": "The state or province code." + }, + "city": { + "type": "string", + "description": "The city." + }, + "postalCode": { + "type": "string", + "description": "The postal code." + } + }, + "description": "Represents an address" + }, + "PrimaryContact": { + "required": [ + "address", + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The full name of the seller's primary contact." + }, + "address": { + "$ref": "#/components/schemas/Address" + }, + "nonLatinName": { + "type": "string", + "description": "The non-Latin script version of the primary contact's name, if applicable." } }, - "description": "Detailed information that is specific to a seller in a Marketplace." + "description": "Information about the seller's primary contact." } } }, diff --git a/resources/models/raw/seller/shipping/v2.json b/resources/models/raw/seller/shipping/v2.json index df003b156..45ef61d4d 100644 --- a/resources/models/raw/seller/shipping/v2.json +++ b/resources/models/raw/seller/shipping/v2.json @@ -6117,6 +6117,9 @@ }, "packageDocumentDetail": { "$ref": "#/components/schemas/PackageDocumentDetail" + }, + "benefits": { + "$ref": "#/components/schemas/Benefits" } }, "description": "The payload for the getShipmentDocuments operation." @@ -6238,6 +6241,9 @@ }, "promise": { "$ref": "#/components/schemas/Promise" + }, + "benefits": { + "$ref": "#/components/schemas/Benefits" } }, "description": "The payload for the purchaseShipment operation." @@ -6860,7 +6866,7 @@ "$ref": "#/components/schemas/ExcludedBenefits" } }, - "description": "Representing the included/excluded benefits that we offer for each ShippingOffering/Rate. Benefits being services provided by Amazon when sellers purchase shipping through Amazon." + "description": "Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC." }, "IncludedBenefits": { "type": "array", @@ -6879,19 +6885,27 @@ "ExcludedBenefit": { "required": [ "benefit", - "reasonCode" + "reasonCodes" ], "type": "object", "properties": { "benefit": { "type": "string" }, - "reasonCode": { - "type": "string" + "reasonCodes": { + "$ref": "#/components/schemas/ExcludedBenefitReasonCodes" } }, "description": "Object representing an excluded benefit that is excluded for an ShippingOffering/Rate." }, + "ExcludedBenefitReasonCodes": { + "minItems": 1, + "type": "array", + "description": "List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer.", + "items": { + "type": "string" + } + }, "ServiceSelection": { "required": [ "serviceId" diff --git a/resources/models/raw/vendor/orders/v1.json b/resources/models/raw/vendor/orders/v1.json index 4058c976e..1b242fc80 100644 --- a/resources/models/raw/vendor/orders/v1.json +++ b/resources/models/raw/vendor/orders/v1.json @@ -24,7 +24,7 @@ "tags": [ "vendorOrders" ], - "description": "Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getPurchaseOrders", "parameters": [ { @@ -41,7 +41,7 @@ { "name": "createdAfter", "in": "query", - "description": "Purchase orders that became available after this time will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -50,7 +50,7 @@ { "name": "createdBefore", "in": "query", - "description": "Purchase orders that became available before this time will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -99,7 +99,7 @@ { "name": "includeDetails", "in": "query", - "description": "When `true`, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is `true`.", + "description": "When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.", "schema": { "type": "string", "format": "boolean" @@ -108,7 +108,7 @@ { "name": "changedAfter", "in": "query", - "description": "Purchase orders that changed after this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -117,7 +117,7 @@ { "name": "changedBefore", "in": "query", - "description": "Purchase orders that changed before this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -126,7 +126,7 @@ { "name": "poItemState", "in": "query", - "description": "Current state of the purchase order item. If this value is `Cancelled`, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.", + "description": "Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.", "schema": { "type": "string", "enum": [ @@ -149,7 +149,7 @@ { "name": "isPOChanged", "in": "query", - "description": "When `true`, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is `false`.", + "description": "When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.", "schema": { "type": "string", "format": "boolean" @@ -309,11 +309,13 @@ "isBackOrderAllowed": true, "netCost": { "amount": "1800", - "currencyCode": "INR" + "currencyCode": "INR", + "unitOfMeasure": "POUNDS" }, "listPrice": { "amount": "2000", - "currencyCode": "INR" + "currencyCode": "INR", + "unitOfMeasure": "POUNDS" } } ] @@ -475,11 +477,13 @@ "isBackOrderAllowed": true, "netCost": { "amount": "94.97", - "currencyCode": "USD" + "currencyCode": "USD", + "unitOfMeasure": "POUNDS" }, "listPrice": { "amount": "94.97", - "currencyCode": "USD" + "currencyCode": "USD", + "unitOfMeasure": "POUNDS" } } ] @@ -1030,7 +1034,8 @@ "isBackOrderAllowed": true, "netCost": { "amount": "94.97", - "currencyCode": "INR" + "currencyCode": "INR", + "unitOfMeasure": "POUNDS" } } ] @@ -1101,13 +1106,19 @@ } }, "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.", + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1150,6 +1161,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1168,6 +1185,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1186,6 +1209,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1204,6 +1233,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1222,7 +1257,7 @@ "tags": [ "vendorOrders" ], - "description": "Returns a purchase order based on the `purchaseOrderNumber` value that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a purchase order based on the `purchaseOrderNumber` value that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getPurchaseOrder", "parameters": [ { @@ -1524,13 +1559,19 @@ } }, "401": { - "description": "The request's authorization header is not formatted correctly or does not contain a valid token.", + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1542,13 +1583,19 @@ } }, "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.", + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1591,6 +1638,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1609,6 +1662,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1627,6 +1686,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1645,6 +1710,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1663,10 +1734,9 @@ "tags": [ "vendorOrders" ], - "description": "Submits acknowledgements for one or more purchase orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Submits acknowledgements for one or more purchase orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "submitAcknowledgement", "requestBody": { - "description": "Submits acknowledgements for one or more purchase orders from a vendor.", "content": { "application/json": { "schema": { @@ -1819,13 +1889,19 @@ } }, "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized,` `Expired Token`, or `Invalid Signature`.", + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1868,6 +1944,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1886,6 +1968,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1904,6 +1992,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1922,6 +2016,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1940,6 +2040,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1959,7 +2065,7 @@ "tags": [ "vendorOrders" ], - "description": "Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getPurchaseOrdersStatus", "parameters": [ { @@ -2016,7 +2122,7 @@ { "name": "createdAfter", "in": "query", - "description": "Purchase orders that became available after this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -2025,7 +2131,7 @@ { "name": "createdBefore", "in": "query", - "description": "Purchase orders that became available before this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -2034,7 +2140,7 @@ { "name": "updatedAfter", "in": "query", - "description": "Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -2043,7 +2149,7 @@ { "name": "updatedBefore", "in": "query", - "description": "Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -2905,13 +3011,19 @@ } }, "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.", + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -2954,6 +3066,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -2972,6 +3090,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -2990,6 +3114,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -3008,6 +3138,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -3034,7 +3170,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the `getPurchaseOrders` operation." + "description": "The response schema for the getPurchaseOrders operation." }, "GetPurchaseOrderResponse": { "type": "object", @@ -3046,7 +3182,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the `getPurchaseOrder` operation." + "description": "The response schema for the getPurchaseOrder operation." }, "OrderList": { "type": "object", @@ -3056,23 +3192,20 @@ }, "orders": { "type": "array", - "description": "Represents an individual order within the `OrderList`.", "items": { "$ref": "#/components/schemas/Order" } } - }, - "description": "A list of orders returned as response." + } }, "Pagination": { "type": "object", "properties": { "nextToken": { "type": "string", - "description": "A generated string used to pass information to your next request. If `NextToken` is returned, pass the value of `NextToken` to the next request. If `NextToken` is not returned, there are no more purchase order items to return." + "description": "A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more purchase order items to return." } - }, - "description": "The pagination elements required to retrieve the remaining data." + } }, "Order": { "required": [ @@ -3096,11 +3229,11 @@ "x-docgen-enum-table-extension": [ { "value": "New", - "description": "The purchase order is newly created and needs to be acknowledged by the vendor." + "description": "The purchase order is newly created and needs to be acknowledged by vendor." }, { "value": "Acknowledged", - "description": "The purchase order has been acknowledged by the vendor." + "description": "The purchase order has been acknowledged by vendor." }, { "value": "Closed", @@ -3111,8 +3244,7 @@ "orderDetails": { "$ref": "#/components/schemas/OrderDetails" } - }, - "description": "Represents an order placed by Amazon, including the purchase order number, current state, and order details." + } }, "OrderDetails": { "required": [ @@ -3124,17 +3256,17 @@ "properties": { "purchaseOrderDate": { "type": "string", - "description": "The date the purchase order was placed. Must be in ISO 8601 date/time format.", + "description": "The date the purchase order was placed. Must be in ISO-8601 date/time format.", "format": "date-time" }, "purchaseOrderChangedDate": { "type": "string", - "description": "The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than 'purchaseOrderDate'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO 8601 date/time format.", + "description": "The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than 'purchaseOrderDate'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO-8601 date/time format.", "format": "date-time" }, "purchaseOrderStateChangedDate": { "type": "string", - "description": "The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'. Must be in ISO 8601 date/time format.", + "description": "The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'. Must be in ISO-8601 date/time format.", "format": "date-time" }, "purchaseOrderType": { @@ -3335,12 +3467,12 @@ "portOfDelivery": { "maxLength": 64, "type": "string", - "description": "The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the `internationalCommercialTerms` is `FOB`." + "description": "The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the internationalCommercialTerms is FOB." }, "importContainers": { "maxLength": 64, "type": "string", - "description": "Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: `$NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE`. The list of values for the container type is: `40'`(40-foot container), `40'HC` (40-foot high-capacity container), `45'`, `45'HC`, `30'`, `30'HC`, `20'`, `20'HC`." + "description": "Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: $NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE. The list of values for the container type is: 40'(40-foot container), 40'HC (40-foot high-capacity container), 45', 45'HC, 30', 30'HC, 20', 20'HC." }, "shippingInstructions": { "type": "string", @@ -3351,7 +3483,7 @@ }, "DateTimeInterval": { "type": "string", - "description": "Defines a date time interval according to ISO 8601. Interval is separated by double hyphen (--)." + "description": "Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--)." }, "PartyIdentification": { "required": [ @@ -3369,8 +3501,7 @@ "taxInfo": { "$ref": "#/components/schemas/TaxRegistrationDetails" } - }, - "description": "Name, address and tax details of a party." + } }, "TaxRegistrationDetails": { "required": [ @@ -3399,7 +3530,7 @@ }, "taxRegistrationNumber": { "type": "string", - "description": "Tax registration number for the entity. For example, `VAT ID`." + "description": "Tax registration number for the entity. For example, VAT ID." } }, "description": "Tax registration details of the entity." @@ -3446,7 +3577,7 @@ }, "postalCode": { "type": "string", - "description": "The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation." + "description": "The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation." }, "countryCode": { "maxLength": 2, @@ -3493,8 +3624,7 @@ "listPrice": { "$ref": "#/components/schemas/Money" } - }, - "description": "Represents an individual item in an order, including item details, quantities, pricing, and backorder information." + } }, "Money": { "type": "object", @@ -3506,9 +3636,37 @@ }, "amount": { "$ref": "#/components/schemas/Decimal" + }, + "unitOfMeasure": { + "type": "string", + "description": "The unit of measure for prices of items sold by weight. If this field is absent, the item is sold by eaches.", + "enum": [ + "POUNDS", + "OUNCES", + "GRAMS", + "KILOGRAMS" + ], + "x-docgen-enum-table-extension": [ + { + "value": "POUNDS", + "description": "Priced per Pound." + }, + { + "value": "OUNCES", + "description": "Priced per Ounce." + }, + { + "value": "GRAMS", + "description": "Priced per Gram." + }, + { + "value": "KILOGRAMS", + "description": "Priced per Kilogram." + } + ] } }, - "description": "An amount of money, including units in the form of currency." + "description": "An amount of money. Includes the currency code and an optional unit of measure for items priced by weight." }, "Decimal": { "type": "string", @@ -3524,7 +3682,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the `submitAcknowledgement` operation" + "description": "The response schema for the submitAcknowledgement operation" }, "TransactionId": { "type": "object", @@ -3533,8 +3691,7 @@ "type": "string", "description": "GUID assigned by Amazon to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction." } - }, - "description": "Response containing the transaction ID." + } }, "ErrorList": { "type": "array", @@ -3548,13 +3705,12 @@ "properties": { "acknowledgements": { "type": "array", - "description": "An array of order acknowledgements to be submitted.", "items": { "$ref": "#/components/schemas/OrderAcknowledgement" } } }, - "description": "The request schema for the `submitAcknowledgment` operation." + "description": "The request schema for the submitAcknowledgment operation." }, "OrderAcknowledgement": { "required": [ @@ -3574,7 +3730,7 @@ }, "acknowledgementDate": { "type": "string", - "description": "The date and time when the purchase order is acknowledged, in ISO 8601 date/time format.", + "description": "The date and time when the purchase order is acknowledged, in ISO-8601 date/time format.", "format": "date-time" }, "items": { @@ -3584,8 +3740,7 @@ "$ref": "#/components/schemas/OrderAcknowledgementItem" } } - }, - "description": "Represents an acknowledgement for an order, including the purchase order number, selling party details, acknowledgement date, and a list of acknowledged items." + } }, "OrderAcknowledgementItem": { "required": [ @@ -3651,7 +3806,7 @@ }, { "value": "Backordered", - "description": "Vendor placed a backorder to fulfill the original order and provides a `scheduledShipDate` or `scheduledDeliveryDate` which is different than the `expectedShipDate` or `expectedDeliveryDate` provided in the purchase order." + "description": "Vendor placed a backorder to fulfill the original order and provides a scheduledShipDate or scheduledDeliveryDate which is different than the expectedShipDate or expectedDeliveryDate provided in the purchase order." }, { "value": "Rejected", @@ -3664,12 +3819,12 @@ }, "scheduledShipDate": { "type": "string", - "description": "Estimated ship date per line item. Must be in ISO 8601 date/time format.", + "description": "Estimated ship date per line item. Must be in ISO-8601 date/time format.", "format": "date-time" }, "scheduledDeliveryDate": { "type": "string", - "description": "Estimated delivery date per line item. Must be in ISO 8601 date/time format.", + "description": "Estimated delivery date per line item. Must be in ISO-8601 date/time format.", "format": "date-time" }, "rejectionReason": { @@ -3695,8 +3850,7 @@ } ] } - }, - "description": "Represents the acknowledgement details for an individual order item, including the acknowledgement code, acknowledged quantity, scheduled ship and delivery dates, and rejection reason (if applicable)." + } }, "ItemQuantity": { "type": "object", @@ -3740,7 +3894,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the `getPurchaseOrdersStatus` operation." + "description": "The response schema for the getPurchaseOrdersStatus operation." }, "OrderListStatus": { "type": "object", @@ -3750,13 +3904,11 @@ }, "ordersStatus": { "type": "array", - "description": "Represents an order status within the `OrderListStatus`.", "items": { "$ref": "#/components/schemas/OrderStatus" } } - }, - "description": "A list of order statuses." + } }, "OrderStatus": { "required": [ @@ -3793,12 +3945,12 @@ }, "purchaseOrderDate": { "type": "string", - "description": "The date the purchase order was placed. Must be in ISO 8601 date/time format.", + "description": "The date the purchase order was placed. Must be in ISO-8601 date/time format.", "format": "date-time" }, "lastUpdatedDate": { "type": "string", - "description": "The date when the purchase order was last updated. Must be in ISO 8601 date/time format.", + "description": "The date when the purchase order was last updated. Must be in ISO-8601 date/time format.", "format": "date-time" }, "sellingParty": { @@ -3938,21 +4090,20 @@ }, "lastReceiveDate": { "type": "string", - "description": "The date when the most recent item was received at the buyer's warehouse. Must be in ISO 8601 date/time format.", + "description": "The date when the most recent item was received at the buyer's warehouse. Must be in ISO-8601 date/time format.", "format": "date-time" } }, "description": "Item receive status at the buyer's warehouse." } - }, - "description": "Represents the current status of an order item, including acknowledgement and receiving details." + } }, "OrderedQuantityDetails": { "type": "object", "properties": { "updatedDate": { "type": "string", - "description": "The date when the line item quantity was updated by the buyer. Must be in ISO 8601 date/time format.", + "description": "The date when the line item quantity was updated by buyer. Must be in ISO-8601 date/time format.", "format": "date-time" }, "orderedQuantity": { @@ -3962,14 +4113,14 @@ "$ref": "#/components/schemas/ItemQuantity" } }, - "description": "Details of the item quantity ordered." + "description": "Details of item quantity ordered" }, "AcknowledgementStatusDetails": { "type": "object", "properties": { "acknowledgementDate": { "type": "string", - "description": "The date when the line item was confirmed by the vendor. Must be in ISO 8601 date/time format.", + "description": "The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format.", "format": "date-time" }, "acceptedQuantity": { @@ -3979,7 +4130,7 @@ "$ref": "#/components/schemas/ItemQuantity" } }, - "description": "Details of the item quantity ordered" + "description": "Details of item quantity ordered" }, "Error": { "required": [ diff --git a/resources/models/seller/amazon-warehousing-distribution/v2024-05-09.json b/resources/models/seller/amazon-warehousing-distribution/v2024-05-09.json index 0289518de..aeaadc28e 100644 --- a/resources/models/seller/amazon-warehousing-distribution/v2024-05-09.json +++ b/resources/models/seller/amazon-warehousing-distribution/v2024-05-09.json @@ -1,8 +1,8 @@ { "openapi": "3.0.1", "info": { - "title": "The Selling Partner API for AWD", - "description": "The Selling Partner API for Amazon Warehousing and Distribution (AWD).", + "title": "The Selling Partner API for Amazon Warehousing and Distribution", + "description": "The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory. ", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" @@ -36,6 +36,39 @@ "minLength": 1, "type": "string" } + }, + { + "name": "skuQuantities", + "in": "query", + "description": "If equal to `SHOW`, the response includes the shipment SKU quantity details.\n\nDefaults to `HIDE`, in which case the response does not contain SKU quantities", + "schema": { + "type": "string", + "enum": [ + "SHOW", + "HIDE" + ], + "x-docgen-enum-table-extension": [ + { + "description": "Show the additional SKU quantity details.", + "value": "SHOW" + }, + { + "description": "Hide the additional SKU quantity details.", + "value": "HIDE" + } + ] + }, + "example": "SHOW", + "x-docgen-enum-table-extension": [ + { + "description": "Show the additional SKU quantity details.", + "value": "SHOW" + }, + { + "description": "Hide the additional SKU quantity details.", + "value": "HIDE" + } + ] } ], "responses": { @@ -134,6 +167,19 @@ ], "shipmentId": "TestShipmentId", "shipmentStatus": "CREATED", + "shipmentSkuQuantities": [ + { + "sku": "testPen", + "expectedQuantity": { + "quantity": 2, + "unitOfMeasurement": "CASE" + }, + "receivedQuantity": { + "quantity": 0, + "unitOfMeasurement": "CASE" + } + } + ], "updatedAt": "2023-06-07T12:12:09.061Z" } } @@ -326,13 +372,13 @@ "tags": [ "AmazonWarehousingAndDistributionV20240509" ], - "description": "Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "listInboundShipments", "parameters": [ { "name": "sortBy", "in": "query", - "description": "Field to sort results by. Required if `sortOrder` is provided.", + "description": "Field to sort results by. By default, the response will be sorted by UPDATED_AT.", "schema": { "type": "string", "enum": [ @@ -341,22 +387,22 @@ ], "x-docgen-enum-table-extension": [ { - "description": "Sort by `Updated at`timestamp.", + "description": "Sort by the time of update.", "value": "UPDATED_AT" }, { - "description": "Sort by `Created at` timestamp.", + "description": "Sort by the time of creation.", "value": "CREATED_AT" } ] }, "x-docgen-enum-table-extension": [ { - "description": "Sort by `Updated at`timestamp.", + "description": "Sort by the time of update.", "value": "UPDATED_AT" }, { - "description": "Sort by `Created at` timestamp.", + "description": "Sort by the time of creation.", "value": "CREATED_AT" } ] @@ -364,7 +410,7 @@ { "name": "sortOrder", "in": "query", - "description": "Sort the response in `ASCENDING` or `DESCENDING` order.", + "description": "Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.", "schema": { "type": "string", "enum": [ @@ -878,6 +924,7 @@ "inventory": [ { "totalOnhandQuantity": 20, + "totalInboundQuantity": 10, "sku": "100TestSKU1Pen", "inventoryDetails": { "availableDistributableQuantity": 10, @@ -886,6 +933,7 @@ }, { "totalOnhandQuantity": 20, + "totalInboundQuantity": 5, "sku": "2U-BKEX-VW4D", "inventoryDetails": { "availableDistributableQuantity": 10, @@ -1180,7 +1228,7 @@ ], "x-docgen-enum-table-extension": [ { - "description": "Standard Carrier Alpha Code. Ref: https://help.cbp.gov/s/article/Article-572?language=en_US.", + "description": "Standard Carrier Alpha Code. Refer to [What is a Standard Carrier Alpha Code](https://www.help.cbp.gov/s/article/Article-1420?language=en_US) for more information.", "value": "SCAC" } ] @@ -1435,6 +1483,13 @@ "type": "string", "description": "Unique shipment ID." }, + "shipmentSkuQuantities": { + "type": "array", + "description": "Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW.", + "items": { + "$ref": "#/components/schemas/SkuQuantity" + } + }, "shipmentStatus": { "$ref": "#/components/schemas/InboundShipmentStatus" }, @@ -1624,6 +1679,11 @@ "type": "string", "description": "The seller or merchant SKU." }, + "totalInboundQuantity": { + "type": "integer", + "description": "Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Center", + "format": "int64" + }, "totalOnhandQuantity": { "type": "integer", "description": "Total quantity that is present in AWD distribution centers.", @@ -1769,10 +1829,6 @@ "attributes": { "type": "array", "description": "Attributes for this instance of the product. For example, already-prepped, or other attributes that distinguish the product beyond the SKU.", - "example": { - "name": "TestAttribute", - "value": "TestAttributeValue" - }, "items": { "$ref": "#/components/schemas/ProductAttribute" } @@ -1826,6 +1882,45 @@ } ] }, + "SkuQuantitiesVisibility": { + "type": "string", + "description": "Enum to specify if returned shipment should include SKU quantity details", + "example": "SHOW", + "enum": [ + "SHOW", + "HIDE" + ], + "x-docgen-enum-table-extension": [ + { + "description": "Show the additional SKU quantity details", + "value": "SHOW" + }, + { + "description": "Hide the additional SKU quantity details", + "value": "HIDE" + } + ] + }, + "SkuQuantity": { + "required": [ + "expectedQuantity", + "sku" + ], + "type": "object", + "properties": { + "expectedQuantity": { + "$ref": "#/components/schemas/InventoryQuantity" + }, + "receivedQuantity": { + "$ref": "#/components/schemas/InventoryQuantity" + }, + "sku": { + "type": "string", + "description": "The merchant stock keeping unit" + } + }, + "description": "Quantity details for a SKU as part of a shipment" + }, "SortOrder": { "type": "string", "description": "Sort order for a collection of items. For example, order or shipment.", diff --git a/resources/models/seller/application-management/v2023-11-30.json b/resources/models/seller/application-management/v2023-11-30.json index 40265f43e..f6897ae54 100644 --- a/resources/models/seller/application-management/v2023-11-30.json +++ b/resources/models/seller/application-management/v2023-11-30.json @@ -46,7 +46,7 @@ "content": {} }, "400": { - "description": "The application has not enrolled for programmatic rotations. Please visit your developer console to enroll.", + "description": "Application is not enrolled for rotation notification. Please update application notification preference in Developer console.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", diff --git a/resources/models/seller/catalog-items/v2022-04-01.json b/resources/models/seller/catalog-items/v2022-04-01.json index 24d8e663c..e7ef7e2c6 100644 --- a/resources/models/seller/catalog-items/v2022-04-01.json +++ b/resources/models/seller/catalog-items/v2022-04-01.json @@ -24,7 +24,7 @@ "tags": [ "CatalogItemsV20220401" ], - "description": "Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.\n\n**Usage Plans:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 5 |\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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.\n\n**Usage Plans:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "searchCatalogItems", "parameters": [ { @@ -1768,7 +1768,7 @@ "tags": [ "CatalogItemsV20220401" ], - "description": "Retrieves details for an item in the Amazon catalog.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 5 |\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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Retrieves details for an item in the Amazon catalog.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getCatalogItem", "parameters": [ { diff --git a/resources/models/seller/fba-inbound/v0.json b/resources/models/seller/fba-inbound/v0.json index cac79a0bb..9d6d52620 100644 --- a/resources/models/seller/fba-inbound/v0.json +++ b/resources/models/seller/fba-inbound/v0.json @@ -4102,8 +4102,7 @@ } } } - }, - "deprecated": true + } } }, "/fba/inbound/v0/shipments/{shipmentId}/items": { @@ -4362,8 +4361,7 @@ } } } - }, - "deprecated": true + } } }, "/fba/inbound/v0/shipmentItems": { @@ -4718,8 +4716,7 @@ } } } - }, - "deprecated": true + } } } }, diff --git a/resources/models/seller/fba-inventory/v1.json b/resources/models/seller/fba-inventory/v1.json index e6188fc58..80a811c02 100644 --- a/resources/models/seller/fba-inventory/v1.json +++ b/resources/models/seller/fba-inventory/v1.json @@ -24,7 +24,7 @@ "tags": [ "FBAInventoryV1" ], - "description": "Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:\n\n- All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted.\n- When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified.\n- When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored.\n- When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.\n\nNote: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.\n\nUsage Plan:\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\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 than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.", + "description": "Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:\n\n- All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted.\n- When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified.\n- When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored.\n- When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.\n\nNote: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\nUsage Plan:\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).", "operationId": "getInventorySummaries", "parameters": [ { @@ -1040,6 +1040,13 @@ "totalQuantity": { "type": "integer", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." + }, + "stores": { + "type": "array", + "description": "A list of seller-enrolled stores that apply to this seller SKU.", + "items": { + "type": "string" + } } }, "description": "Inventory summary for a specific item." diff --git a/resources/models/seller/fba-outbound/v2020-07-01.json b/resources/models/seller/fba-outbound/v2020-07-01.json index cf4e325d3..a288255cd 100644 --- a/resources/models/seller/fba-outbound/v2020-07-01.json +++ b/resources/models/seller/fba-outbound/v2020-07-01.json @@ -24,7 +24,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Returns a list of fulfillment order previews based on shipping criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of fulfillment order previews based on shipping criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFulfillmentPreview", "requestBody": { "description": "GetFulfillmentPreviewRequest parameter", @@ -212,7 +212,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "deliveryOffers", "requestBody": { "description": "GetDeliveryOffersRequest parameter", @@ -400,7 +400,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)", + "description": "Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)", "operationId": "listAllFulfillmentOrders", "parameters": [ { @@ -590,7 +590,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)", + "description": "Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)", "operationId": "createFulfillmentOrder", "requestBody": { "description": "CreateFulfillmentOrderRequest parameter", @@ -778,7 +778,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getPackageTrackingDetails", "parameters": [ { @@ -966,7 +966,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "listReturnReasonCodes", "parameters": [ { @@ -1177,7 +1177,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Creates a fulfillment return.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Creates a fulfillment return.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "createFulfillmentReturn", "parameters": [ { @@ -1376,7 +1376,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Returns the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFulfillmentOrder", "parameters": [ { @@ -1559,7 +1559,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Updates and/or requests shipment for a fulfillment order with an order hold on it.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Updates and/or requests shipment for a fulfillment order with an order hold on it.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "updateFulfillmentOrder", "parameters": [ { @@ -1759,7 +1759,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "cancelFulfillmentOrder", "parameters": [ { @@ -2130,7 +2130,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeatures", "parameters": [ { @@ -2317,7 +2317,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Returns a list of inventory items that are eligible for the fulfillment feature you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..", + "description": "Returns a list of inventory items that are eligible for the fulfillment feature you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..", "operationId": "getFeatureInventory", "parameters": [ { @@ -2345,6 +2345,15 @@ "schema": { "type": "string" } + }, + { + "name": "queryStartDate", + "in": "query", + "description": "A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ", + "schema": { + "type": "string", + "format": "date-time" + } } ], "responses": { @@ -2521,7 +2530,7 @@ "tags": [ "FBAOutboundV20200701" ], - "description": "Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn't eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn't eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeatureSKU", "parameters": [ { @@ -3763,6 +3772,9 @@ }, "lockerDetails": { "$ref": "#/components/schemas/LockerDetails" + }, + "deliveryInformation": { + "$ref": "#/components/schemas/DeliveryInformation" } }, "description": "Package information for a shipment in a fulfillment order." @@ -4115,32 +4127,6 @@ }, "description": "A physical address with varying degrees of precision. A more precise address can provide more accurate results than country code and postal code alone." }, - "DeliveryQuantity": { - "required": [ - "amount", - "unitOfMeasure" - ], - "type": "object", - "properties": { - "unitOfMeasure": { - "type": "string", - "description": "The unit of measure for the amount.", - "enum": [ - "Each" - ], - "x-docgen-enum-table-extension": [ - { - "value": "Each", - "description": "Specifies an integer count of units." - } - ] - }, - "amount": { - "$ref": "#/components/schemas/Decimal" - } - }, - "description": "A quantity based on unit of measure." - }, "DateRange": { "required": [ "earliest", @@ -4316,7 +4302,43 @@ "description": "Indicates the locker access code" } }, - "description": "The locker details, if provided can be used to access locker delivery box." + "description": "The locker details, which you can use to access the locker delivery box." + }, + "DeliveryInformation": { + "type": "object", + "properties": { + "deliveryDocumentList": { + "$ref": "#/components/schemas/DeliveryDocumentList" + }, + "dropOffLocation": { + "$ref": "#/components/schemas/DropOffLocation" + } + }, + "description": "The delivery information for the package. This information is available after the package is delivered." + }, + "DeliveryDocumentList": { + "type": "array", + "description": "A list of delivery documents for a package.", + "items": { + "$ref": "#/components/schemas/DeliveryDocument" + } + }, + "DeliveryDocument": { + "required": [ + "documentType" + ], + "type": "object", + "properties": { + "documentType": { + "type": "string", + "description": "The delivery document type. Values are `SIGNATURE` and `DELIVERY_IMAGE`." + }, + "url": { + "type": "string", + "description": "A URL that you can use to download the document. This URL has a `Content-Type` header. Note that the URL expires after one hour. To get a new URL, you must call the API again." + } + }, + "description": "A delivery document for a package." }, "NotificationEmailList": { "type": "array", diff --git a/resources/models/seller/feeds/v2021-06-30.json b/resources/models/seller/feeds/v2021-06-30.json index 632af305e..a44e55b3b 100644 --- a/resources/models/seller/feeds/v2021-06-30.json +++ b/resources/models/seller/feeds/v2021-06-30.json @@ -24,7 +24,7 @@ "tags": [ "FeedsV20210630" ], - "description": "Returns feed details for the feeds that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns feed details for the feeds that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeeds", "parameters": [ { @@ -392,7 +392,7 @@ "tags": [ "FeedsV20210630" ], - "description": "Creates a feed. Upload the contents of the feed document before calling this operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0083 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Creates a feed. Upload the contents of the feed document before calling this operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0083 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).\n\nThe rate limit for the [`JSON_LISTINGS_FEED`](https://developer-docs.amazon.com/sp-api/docs/listings-feed-type-values#listings-feed) feed type differs from the rate limit for the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#post-feeds2021-06-30feeds) operation. For more information, refer to the [Building Listings Management Workflows Guide](https://developer-docs.amazon.com/sp-api/docs/building-listings-management-workflows-guide#should-i-submit-in-bulk-using-the-json_listings_feed-or-individually-with-the-listings-items-api).", "operationId": "createFeed", "requestBody": { "description": "Information required to create the feed.", @@ -646,7 +646,7 @@ "tags": [ "FeedsV20210630" ], - "description": "Returns feed details (including the resultDocumentId, if available) for the feed that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeed", "parameters": [ { @@ -889,7 +889,7 @@ "tags": [ "FeedsV20210630" ], - "description": "Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeeds) operations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "cancelFeed", "parameters": [ { @@ -1120,7 +1120,7 @@ "tags": [ "FeedsV20210630" ], - "description": "Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#createfeed) operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "createFeedDocument", "requestBody": { "description": "Specifies the content type for the createFeedDocument operation.", @@ -1364,7 +1364,7 @@ "tags": [ "FeedsV20210630" ], - "description": "Returns the information required for retrieving a feed document's contents.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns the information required for retrieving a feed document's contents.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeedDocument", "parameters": [ { diff --git a/resources/models/seller/finances/v0.json b/resources/models/seller/finances/v0.json index b940014fa..dac630b05 100644 --- a/resources/models/seller/finances/v0.json +++ b/resources/models/seller/finances/v0.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "Selling Partner API for Finances", - "description": "The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.", + "description": "The Selling Partner API for Finances provides financial information that is relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range. ", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" @@ -21,25 +21,25 @@ "paths": { "/finances/v0/financialEventGroups": { "get": { - "description": "Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events.\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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events.\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 can have higher rate and burst values than 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).", "operationId": "listFinancialEventGroups", "parameters": [ { "name": "MaxResultsPerPage", "in": "query", - "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.", + "description": "The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", - "default": 100 + "default": 10 } }, { "name": "FinancialEventGroupStartedBefore", "in": "query", - "description": "A date used for selecting financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned.", + "description": "A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned.", "schema": { "type": "string", "format": "date-time" @@ -48,7 +48,7 @@ { "name": "FinancialEventGroupStartedAfter", "in": "query", - "description": "A date used for selecting financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be no later than two minutes before the request was submitted.", + "description": "A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.", "schema": { "type": "string", "format": "date-time" @@ -57,7 +57,7 @@ { "name": "NextToken", "in": "query", - "description": "A string token returned in the response of your previous request.", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", "schema": { "type": "string" } @@ -66,6 +66,20 @@ "responses": { "200": { "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -124,6 +138,20 @@ }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -203,12 +231,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -227,12 +249,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -251,12 +267,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -275,13 +285,13 @@ }, "/finances/v0/financialEventGroups/{eventGroupId}/financialEvents": { "get": { - "description": "Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events.\n\n**Note:** This operation will only retrieve group's data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned.\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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events.\n\n**Note:** This operation only retrieves a group's data for the past two years. A request for data spanning more than two years produces an empty response.\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 can have higher rate and burst values than 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).", "operationId": "listFinancialEventsByGroupId", "parameters": [ { "name": "MaxResultsPerPage", "in": "query", - "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.", + "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.", "schema": { "maximum": 100, "minimum": 1, @@ -293,7 +303,7 @@ { "name": "PostedAfter", "in": "query", - "description": "A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.", + "description": "The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.", "schema": { "type": "string", "format": "date-time" @@ -302,7 +312,7 @@ { "name": "PostedBefore", "in": "query", - "description": "A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two minutes.", + "description": "The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.\n\nThe date-time must be later than `PostedAfter` and more than two minutes before the requestd was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter.\n\n**Default:** Two minutes before the time of the request.", "schema": { "type": "string", "format": "date-time" @@ -320,7 +330,7 @@ { "name": "NextToken", "in": "query", - "description": "A string token returned in the response of your previous request.", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", "schema": { "type": "string" } @@ -329,6 +339,20 @@ "responses": { "200": { "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -701,6 +725,20 @@ }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -780,12 +818,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -804,12 +836,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -828,12 +854,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -852,7 +872,7 @@ }, "/finances/v0/orders/{orderId}/financialEvents": { "get": { - "description": "Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events.\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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events.\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 can have higher rate and burst values than 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).", "operationId": "listFinancialEventsByOrderId", "parameters": [ { @@ -867,7 +887,7 @@ { "name": "MaxResultsPerPage", "in": "query", - "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.", + "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.", "schema": { "maximum": 100, "minimum": 1, @@ -879,7 +899,7 @@ { "name": "NextToken", "in": "query", - "description": "A string token returned in the response of your previous request.", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", "schema": { "type": "string" } @@ -888,6 +908,20 @@ "responses": { "200": { "description": "Financial Events successfully retrieved.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -1038,6 +1072,20 @@ }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -1117,12 +1165,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1141,12 +1183,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1165,12 +1201,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1189,13 +1219,13 @@ }, "/finances/v0/financialEvents": { "get": { - "description": "Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don't show up in responses until in they are released.\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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events.\n\n**Note:** in `ListFinancialEvents`, deferred events don't show up in responses until in they are released.\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 can have higher rate and burst values than 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).", "operationId": "listFinancialEvents", "parameters": [ { "name": "MaxResultsPerPage", "in": "query", - "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'.", + "description": "The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.", "schema": { "maximum": 100, "minimum": 1, @@ -1207,7 +1237,7 @@ { "name": "PostedAfter", "in": "query", - "description": "A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.", + "description": "The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.", "schema": { "type": "string", "format": "date-time" @@ -1216,7 +1246,7 @@ { "name": "PostedBefore", "in": "query", - "description": "A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.", + "description": "The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.\n\nThe date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter.\n\n**Default:** Two minutes before the time of the request.", "schema": { "type": "string", "format": "date-time" @@ -1225,7 +1255,7 @@ { "name": "NextToken", "in": "query", - "description": "A string token returned in the response of your previous request.", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", "schema": { "type": "string" } @@ -1234,6 +1264,20 @@ "responses": { "200": { "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -1380,6 +1424,20 @@ }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { @@ -1459,12 +1517,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1483,12 +1535,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1507,12 +1553,6 @@ "schema": { "type": "string" } - }, - "x-amzn-RateLimit-Limit": { - "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.", - "schema": { - "type": "string" - } } }, "content": { @@ -1537,7 +1577,7 @@ "properties": { "TransactionType": { "type": "string", - "description": "Indicates the type of transaction.\n\nExample: \"Disbursed to Amazon Gift Card balance\"" + "description": "The type of transaction. For example, \"Disbursed to Amazon Gift Card balance\"." }, "PostedDate": { "$ref": "#/components/schemas/Date" @@ -1564,7 +1604,7 @@ "properties": { "AdjustmentType": { "type": "string", - "description": "The type of adjustment.\n\nPossible values:\n\n* FBAInventoryReimbursement - An FBA inventory reimbursement to a seller's account. This occurs if a seller's inventory is damaged.\n\n* ReserveEvent - A reserve event that is generated at the time of a settlement period closing. This occurs when some money from a seller's account is held back.\n\n* PostageBilling - The amount paid by a seller for shipping labels.\n\n* PostageRefund - The reimbursement of shipping labels purchased for orders that were canceled or refunded.\n\n* LostOrDamagedReimbursement - An Amazon Easy Ship reimbursement to a seller's account for a package that we lost or damaged.\n\n* CanceledButPickedUpReimbursement - An Amazon Easy Ship reimbursement to a seller's account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace.\n\n* ReimbursementClawback - An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace.\n\n* SellerRewards - An award credited to a seller's account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace." + "description": "The type of adjustment.\n\nPossible values:\n\n* `FBAInventoryReimbursement`: An FBA inventory reimbursement to a seller's account. This occurs if a seller's inventory is damaged.\n* `ReserveEvent`: A reserve event that is generated at the time a settlement period closes. This occurs when some money from a seller's account is held back.\n* `PostageBilling`: The amount paid by a seller for shipping labels.\n* `PostageRefund`: The reimbursement of shipping labels purchased for orders that were canceled or refunded.\n* `LostOrDamagedReimbursement`: An Amazon Easy Ship reimbursement to a seller's account for a package that we lost or damaged.\n* `CanceledButPickedUpReimbursement`: An Amazon Easy Ship reimbursement to a seller's account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace.\n* `ReimbursementClawback`: An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace.\n* `SellerRewards`: An award credited to a seller's account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace." }, "PostedDate": { "$ref": "#/components/schemas/Date" @@ -1590,7 +1630,7 @@ "properties": { "Quantity": { "type": "string", - "description": "Represents the number of units in the seller's inventory when the AdustmentType is FBAInventoryReimbursement." + "description": "Represents the number of units in the seller's inventory when the `AdjustmentType` is `FBAInventoryReimbursement`." }, "PerUnitAmount": { "$ref": "#/components/schemas/Currency" @@ -1641,11 +1681,11 @@ }, "MarketplaceId": { "type": "string", - "description": "An encrypted, Amazon-defined marketplace identifier." + "description": "The Amazon-defined marketplace identifier." }, "TransactionType": { "type": "string", - "description": "Indicates the type of transaction. \n\nPossible values:\n\n* Charge - For an affordability promotion expense.\n\n* Refund - For an affordability promotion expense reversal." + "description": "The type of transaction. \n\nPossible values:\n\n* `Charge`: an affordability promotion expense.\n* `Refund`: an affordability promotion expense reversal." }, "BaseExpense": { "$ref": "#/components/schemas/Currency" @@ -1673,7 +1713,8 @@ } }, "BigDecimal": { - "type": "number" + "type": "number", + "description": "A signed decimal number." }, "ChargeComponent": { "type": "object", @@ -1686,7 +1727,7 @@ "$ref": "#/components/schemas/Currency" } }, - "description": "A charge on the seller's account.\n\nPossible values:\n\n* Principal - The selling price of the order item, equal to the selling price of the item multiplied by the quantity ordered.\n\n* Tax - The tax collected by the seller on the Principal.\n\n* MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal.\n\n* MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge.\n\n* MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge.\n\n* MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges.\n\n* Discount - The promotional discount for an order item.\n\n* TaxDiscount - The tax amount deducted for promotional rebates.\n\n* CODItemCharge - The COD charge for an order item.\n\n* CODItemTaxCharge - The tax collected by the seller on a CODItemCharge.\n\n* CODOrderCharge - The COD charge for an order.\n\n* CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge.\n\n* CODShippingCharge - Shipping charges for a COD order.\n\n* CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge.\n\n* ShippingCharge - The shipping charge.\n\n* ShippingTax - The tax collected by the seller on a ShippingCharge.\n\n* Goodwill - The amount given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience.\n\n* Giftwrap - The gift wrap charge.\n\n* GiftwrapTax - The tax collected by the seller on a Giftwrap charge.\n\n* RestockingFee - The charge applied to the buyer when returning a product in certain categories.\n\n* ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event we are at fault.\n\n* PointsFee - The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction.\n\n* GenericDeduction - A generic bad debt deduction.\n\n* FreeReplacementReturnShipping - The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item.\n\n* PaymentMethodFee - The fee collected for certain payment methods in certain marketplaces.\n\n* ExportCharge - The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program.\n\n* SAFE-TReimbursement - The SAFE-T claim amount for the item.\n\n* TCS-CGST - Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST).\n\n* TCS-SGST - Tax Collected at Source for State Goods and Services Tax (SGST).\n\n* TCS-IGST - Tax Collected at Source for Integrated Goods and Services Tax (IGST).\n\n* TCS-UTGST - Tax Collected at Source for Union Territories Goods and Services Tax (UTGST)." + "description": "A charge on the seller's account.\n\nPossible values:\n\n* `Principal`: The selling price of the order item, which is equal to the selling price of the item multiplied by the quantity ordered.\n\n* `Tax`: The tax on the principal that is collected by the seller.\n\n* `MarketplaceFacilitatorTax-Principal`: The tax that is withheld on the principal.\n\n* `MarketplaceFacilitatorTax-Shipping`: The tax that is withheld on the `ShippingCharge`.\n\n* `MarketplaceFacilitatorTax-Giftwrap`: The tax that is withheld on the Giftwrap charge.\n\n* `MarketplaceFacilitatorTax-Other`: The tax that is withheld on other miscellaneous charges.\n\n* `Discount`: The promotional discount for an order item.\n\n* `TaxDiscount`: The tax that is deducted for promotional rebates.\n\n* `CODItemCharge`: The COD charge for an order item.\n\n* `CODItemTaxCharge`: The tax that is collected by the seller on a `CODItemCharge`.\n\n* `CODOrderCharge`: The COD charge for an order.\n\n* `CODOrderTaxCharge`: The tax that is collected by the seller on a `CODOrderCharge`.\n\n* `CODShippingCharge`: Shipping charges for a COD order.\n\n* `CODShippingTaxCharge`: The tax that is collected by the seller on a `CODShippingCharge`.\n\n* `ShippingCharge`: The shipping charge.\n\n* `ShippingTax`: The tax that is collected by the seller on a `ShippingCharge`.\n\n* `Goodwill`: The amount of money that is given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience.\n\n* `Giftwrap`: The gift wrap charge.\n\n* `GiftwrapTax`: The tax that is collected by the seller on a gift wrap charge.\n\n* `RestockingFee`: The charge that is applied to the buyer when returning a product in certain categories.\n\n* `ReturnShipping`: The amount of money that is given to the buyer to compensate for shipping the item back if we are at fault.\n\n* `PointsFee`: The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction.\n\n* `GenericDeduction`: A generic bad debt deduction.\n\n* `FreeReplacementReturnShipping`: The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item.\n\n* `PaymentMethodFee`: The fee that is collected for certain payment methods in certain marketplaces.\n\n* `ExportCharge`: The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program.\n\n* `SAFE-TReimbursement`: The SAFE-T claim amount for the item.\n\n* `TCS-CGST`: Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST).\n\n* `TCS-SGST`: Tax Collected at Source for State Goods and Services Tax (SGST).\n\n* `TCS-IGST`: Tax Collected at Source for Integrated Goods and Services Tax (IGST).\n\n* `TCS-UTGST`: Tax Collected at Source for Union Territories Goods and Services Tax (UTGST)." }, "ChargeComponentList": { "type": "array", @@ -1727,11 +1768,11 @@ }, "ReasonCode": { "type": "string", - "description": "The reason given for a charge refund.\n\nExample: `SubscriptionFeeCorrection`" + "description": "The reason given for a charge refund. For example, `SubscriptionFeeCorrection`." }, "ReasonCodeDescription": { "type": "string", - "description": "A description of the Reason Code. \n\nExample: `SubscriptionFeeCorrection`" + "description": "A description of the Reason Code. For example, `SubscriptionFeeCorrection`." }, "ChargeRefundTransactions": { "$ref": "#/components/schemas/ChargeRefundTransactions" @@ -1823,6 +1864,7 @@ }, "Date": { "type": "string", + "description": "A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", "format": "date-time" }, "DebtRecoveryEvent": { @@ -1830,7 +1872,7 @@ "properties": { "DebtRecoveryType": { "type": "string", - "description": "The debt recovery type.\n\nPossible values:\n\n* DebtPayment\n\n* DebtPaymentFailure\n\n*DebtAdjustment" + "description": "The debt recovery type.\n\nPossible values:\n\n* `DebtPayment`\n* `DebtPaymentFailure`\n* `DebtAdjustment`" }, "RecoveryAmount": { "$ref": "#/components/schemas/Currency" @@ -1884,7 +1926,7 @@ "properties": { "DirectPaymentType": { "type": "string", - "description": "The type of payment.\n\nPossible values:\n\n* StoredValueCardRevenue - The amount that is deducted from the seller's account because the seller received money through a stored value card.\n\n* StoredValueCardRefund - The amount that Amazon returns to the seller if the order that is bought using a stored value card is refunded.\n\n* PrivateLabelCreditCardRevenue - The amount that is deducted from the seller's account because the seller received money through a private label credit card offered by Amazon.\n\n* PrivateLabelCreditCardRefund - The amount that Amazon returns to the seller if the order that is bought using a private label credit card offered by Amazon is refunded.\n\n* CollectOnDeliveryRevenue - The COD amount that the seller collected directly from the buyer.\n\n* CollectOnDeliveryRefund - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded." + "description": "The type of payment.\n\nPossible values:\n\n* `StoredValueCardRevenue` - The amount that is deducted from the seller's account because the seller received money through a stored value card.\n\n* `StoredValueCardRefund` - The amount that Amazon returns to the seller if the order that is purchased using a stored value card is refunded.\n\n* `PrivateLabelCreditCardRevenue` - The amount that is deducted from the seller's account because the seller received money through a private label credit card offered by Amazon.\n\n* `PrivateLabelCreditCardRefund` - The amount that Amazon returns to the seller if the order that is purchased using a private label credit card offered by Amazon is refunded.\n\n* `CollectOnDeliveryRevenue` - The COD amount that the seller collected directly from the buyer.\n\n* `CollectOnDeliveryRefund` - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded." }, "DirectPaymentAmount": { "$ref": "#/components/schemas/Currency" @@ -1901,7 +1943,7 @@ }, "FailedAdhocDisbursementEventList": { "type": "array", - "description": "A list of `FailedAdhocDisbursementEvent`s.", + "description": "A list of `FailedAdhocDisbursementEvent`.", "items": { "$ref": "#/components/schemas/FailedAdhocDisbursementEvent" } @@ -1911,7 +1953,7 @@ "properties": { "FundsTransfersType": { "type": "string", - "description": "The type of fund transfer. \n\nExample \"Refund\"" + "description": "The type of fund transfer. For example, `Refund`." }, "TransferId": { "type": "string", @@ -1923,11 +1965,11 @@ }, "PaymentDisbursementType": { "type": "string", - "description": "The type of payment for disbursement. \n\nExample `CREDIT_CARD`" + "description": "The type of payment for disbursement. For example, `CREDIT_CARD`." }, "Status": { "type": "string", - "description": "The status of the failed `AdhocDisbursement`. \n\nExample `HARD_DECLINED`" + "description": "The status of the failed `AdhocDisbursement`. For example, `HARD_DECLINED`." }, "TransferAmount": { "$ref": "#/components/schemas/Currency" @@ -1993,7 +2035,7 @@ }, "ProcessingStatus": { "type": "string", - "description": "The processing status of the financial event group indicates whether the balance of the financial event group is settled.\n\nPossible values:\n\n* Open\n\n* Closed" + "description": "The processing status of the financial event group indicates whether the balance of the financial event group is settled.\n\nPossible values:\n\n* `Open`\n* `Closed`" }, "FundTransferStatus": { "type": "string", @@ -2138,7 +2180,7 @@ "$ref": "#/components/schemas/CapacityReservationBillingEventList" } }, - "description": "Contains all information related to a financial event." + "description": "All the information that is related to a financial event." }, "ImagingServicesFeeEvent": { "type": "object", @@ -2178,7 +2220,7 @@ "$ref": "#/components/schemas/FinancialEventGroupList" } }, - "description": "The payload for the listFinancialEventGroups operation." + "description": "The payload for the `listFinancialEventGroups` operation." }, "ListFinancialEventGroupsResponse": { "type": "object", @@ -2190,7 +2232,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the listFinancialEventGroups operation." + "description": "The response schema for the `listFinancialEventGroups` operation." }, "ListFinancialEventsPayload": { "type": "object", @@ -2203,7 +2245,7 @@ "$ref": "#/components/schemas/FinancialEvents" } }, - "description": "The payload for the listFinancialEvents operation." + "description": "The payload for the `listFinancialEvents` operation." }, "ListFinancialEventsResponse": { "type": "object", @@ -2215,7 +2257,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the listFinancialEvents operation." + "description": "The response schema for the `listFinancialEvents` operation." }, "LoanServicingEvent": { "type": "object", @@ -2225,7 +2267,7 @@ }, "SourceBusinessEventType": { "type": "string", - "description": "The type of event.\n\nPossible values:\n\n* LoanAdvance\n\n* LoanPayment\n\n* LoanRefund" + "description": "The type of event.\n\nPossible values:\n\n* `LoanAdvance`\n\n* `LoanPayment`\n\n* `LoanRefund`" } }, "description": "A loan advance, loan payment, or loan refund." @@ -2242,7 +2284,7 @@ "properties": { "TransactionType": { "type": "string", - "description": "The type of network item swap.\n\nPossible values:\n\n* NetCo - A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace.\n\n* ComminglingVAT - A commingling VAT transaction. Available only in the UK, Spain, France, Germany, and Italy marketplaces." + "description": "The type of network item swap.\n\nPossible values:\n\n* `NetCo`: A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace.\n\n* `ComminglingVAT`: A commingling VAT transaction. Available only in the Spain, UK, France, Germany, and Italy marketplaces." }, "PostedDate": { "$ref": "#/components/schemas/Date" @@ -2305,7 +2347,7 @@ }, "PaymentAmountType": { "type": "string", - "description": "The type of payment.\n\nPossible values:\n\n* Sales" + "description": "The type of payment.\n\nPossible values:\n\n* `Sales`" }, "AmountDescription": { "type": "string", @@ -2313,11 +2355,11 @@ }, "FulfillmentChannel": { "type": "string", - "description": "The fulfillment channel.\n\nPossible values:\n\n* AFN - Amazon Fulfillment Network (Fulfillment by Amazon)\n\n* MFN - Merchant Fulfillment Network (self-fulfilled)" + "description": "The fulfillment channel.\n\nPossible values:\n\n* `AFN`: Amazon Fulfillment Network (Fulfillment by Amazon)\n\n* `MFN`: Merchant Fulfillment Network (self-fulfilled)" }, "StoreName": { "type": "string", - "description": "The store name where the event occurred." + "description": "The name of the store where the event occurred." } }, "description": "An event related to the seller's Pay with Amazon account." @@ -2337,11 +2379,11 @@ }, "transactionType": { "type": "string", - "description": "Indicates if the transaction is for a charge or a refund.\n\nPossible values:\n\n* charge - Charge\n\n* refund - Refund" + "description": "Indicates if the transaction is for a charge or a refund.\n\nPossible values:\n\n* `charge`\n\n* `refund`" }, "invoiceId": { "type": "string", - "description": "Identifier for the invoice that the transaction appears in." + "description": "The identifier for the invoice that includes the transaction." }, "baseValue": { "$ref": "#/components/schemas/Currency" @@ -2394,7 +2436,7 @@ }, "MerchantOrderId": { "type": "string", - "description": "The merchant removal orderId." + "description": "The merchant removal `orderId`." }, "OrderId": { "type": "string", @@ -2402,7 +2444,11 @@ }, "TransactionType": { "type": "string", - "description": "The type of removal order.\n\nPossible values:\n\n* WHOLESALE_LIQUIDATION" + "description": "The type of removal order.\n\nPossible values:\n\n* `WHOLESALE_LIQUIDATION`" + }, + "StoreName": { + "type": "string", + "description": "The name of the store where the event occurred." }, "RemovalShipmentItemList": { "$ref": "#/components/schemas/RemovalShipmentItemList" @@ -2426,7 +2472,7 @@ }, "TaxCollectionModel": { "type": "string", - "description": "The tax collection model applied to the item.\n\nPossible values:\n\n* MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n\n* Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon." + "description": "The tax collection model that is applied to the item.\n\nPossible values:\n\n* `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n* `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon." }, "FulfillmentNetworkSKU": { "type": "string", @@ -2454,7 +2500,7 @@ }, "RemovalShipmentItemList": { "type": "array", - "description": "A list of information about removal shipment items.", + "description": "A list of `RemovalShipmentItem`.", "items": { "$ref": "#/components/schemas/RemovalShipmentItem" } @@ -2479,11 +2525,11 @@ }, "TransactionType": { "type": "string", - "description": "The type of removal order.\n\nPossible values:\n\n* WHOLESALE_LIQUIDATION." + "description": "The type of removal order.\n\nPossible values:\n\n* `WHOLESALE_LIQUIDATION`." }, "RemovalShipmentItemAdjustmentList": { "type": "array", - "description": "A comma-delimited list of Removal shipmentItemAdjustment details for FBA inventory.", + "description": "A comma-delimited list of `RemovalShipmentItemAdjustment` details for FBA inventory.", "items": { "$ref": "#/components/schemas/RemovalShipmentItemAdjustment" } @@ -2493,7 +2539,7 @@ }, "RemovalShipmentAdjustmentEventList": { "type": "array", - "description": "A comma-delimited list of Removal shipmentAdjustment details for FBA inventory.", + "description": "A comma-delimited list of `RemovalShipmentAdjustment` details for FBA inventory.", "items": { "$ref": "#/components/schemas/RemovalShipmentAdjustmentEvent" } @@ -2507,7 +2553,7 @@ }, "TaxCollectionModel": { "type": "string", - "description": "The tax collection model applied to the item.\n\nPossible values:\n\n* MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n\n* Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon." + "description": "The tax collection model that is applied to the item.\n\nPossible values:\n\n* `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n* `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon." }, "FulfillmentNetworkSKU": { "type": "string", @@ -2515,7 +2561,7 @@ }, "AdjustedQuantity": { "type": "integer", - "description": "Adjusted quantity of removal shipmentItemAdjustment items.", + "description": "Adjusted quantity of `RemovalShipmentItemAdjustment` items.", "format": "int32" }, "RevenueAdjustment": { @@ -2539,11 +2585,11 @@ }, "RentalEventType": { "type": "string", - "description": "The type of rental event.\n\nPossible values:\n\n* RentalCustomerPayment-Buyout - Transaction type that represents when the customer wants to buy out a rented item.\n\n* RentalCustomerPayment-Extension - Transaction type that represents when the customer wants to extend the rental period.\n\n* RentalCustomerRefund-Buyout - Transaction type that represents when the customer requests a refund for the buyout of the rented item.\n\n* RentalCustomerRefund-Extension - Transaction type that represents when the customer requests a refund over the extension on the rented item.\n\n* RentalHandlingFee - Transaction type that represents the fee that Amazon charges sellers who rent through Amazon.\n\n* RentalChargeFailureReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a failed charge.\n\n* RentalLostItemReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a lost item." + "description": "The type of rental event.\n\nPossible values:\n\n* `RentalCustomerPayment-Buyout`: A transaction type that represents when the customer wants to buy out a rented item.\n\n* `RentalCustomerPayment-Extension`: A transaction type that represents when the customer wants to extend the rental period.\n\n* `RentalCustomerRefund-Buyout`: A transaction type that represents when the customer requests a refund for the buyout of the rented item.\n\n* `RentalCustomerRefund-Extension`: A transaction type that represents when the customer requests a refund over the extension on the rented item.\n\n* `RentalHandlingFee`: A transaction type that represents the fee that Amazon charges sellers who rent through Amazon.\n\n* `RentalChargeFailureReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a failed charge.\n\n* `RentalLostItemReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a lost item." }, "ExtensionLength": { "type": "integer", - "description": "The number of days that the buyer extended an already rented item. This value is only returned for RentalCustomerPayment-Extension and RentalCustomerRefund-Extension events.", + "description": "The number of days that the buyer extended an already rented item. This value is only returned for `RentalCustomerPayment-Extension` and `RentalCustomerRefund-Extension` events.", "format": "int32" }, "PostedDate": { @@ -2583,7 +2629,7 @@ "properties": { "RetrochargeEventType": { "type": "string", - "description": "The type of event.\n\nPossible values:\n\n* Retrocharge\n\n* RetrochargeReversal" + "description": "The type of event.\n\nPossible values:\n\n* `Retrocharge`\n\n* `RetrochargeReversal`" }, "AmazonOrderId": { "type": "string", @@ -2610,7 +2656,7 @@ }, "RetrochargeEventList": { "type": "array", - "description": "A list of information about Retrocharge or RetrochargeReversal events.", + "description": "A list of information about `Retrocharge` or `RetrochargeReversal` events.", "items": { "$ref": "#/components/schemas/RetrochargeEvent" } @@ -2640,7 +2686,7 @@ }, "SAFETReimbursementEventList": { "type": "array", - "description": "A list of SAFETReimbursementEvents.", + "description": "A list of `SAFETReimbursementEvent`.", "items": { "$ref": "#/components/schemas/SAFETReimbursementEvent" } @@ -2664,7 +2710,7 @@ }, "SAFETReimbursementItemList": { "type": "array", - "description": "A list of SAFETReimbursementItems.", + "description": "A list of `SAFETReimbursementItem`.", "items": { "$ref": "#/components/schemas/SAFETReimbursementItem" } @@ -2685,11 +2731,11 @@ }, "eventType": { "type": "string", - "description": "The type of event: SellerDealComplete." + "description": "The type of event: `SellerDealComplete`." }, "feeType": { "type": "string", - "description": "The type of fee: RunLightningDealFee." + "description": "The type of fee: `RunLightningDealFee`." }, "feeAmount": { "$ref": "#/components/schemas/Currency" @@ -2772,6 +2818,10 @@ "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." + }, + "StoreName": { + "type": "string", + "description": "The name of the store where the event occurred." } }, "description": "A service fee on the seller's account." @@ -2798,6 +2848,10 @@ "type": "string", "description": "The name of the marketplace where the event occurred." }, + "StoreName": { + "type": "string", + "description": "The name of the store where the event occurred." + }, "OrderChargeList": { "$ref": "#/components/schemas/ChargeComponentList" }, @@ -2948,7 +3002,7 @@ }, "SolutionProviderCreditEventList": { "type": "array", - "description": "A list of information about solution provider credits.", + "description": "A list of `SolutionProviderCreditEvent`.", "items": { "$ref": "#/components/schemas/SolutionProviderCreditEvent" } @@ -2963,7 +3017,7 @@ "$ref": "#/components/schemas/Date" } }, - "description": "Period which taxwithholding on seller's account is calculated." + "description": "The period during which tax withholding on a seller's account is calculated." }, "TaxWithholdingEvent": { "type": "object", @@ -2981,11 +3035,11 @@ "$ref": "#/components/schemas/TaxWithholdingPeriod" } }, - "description": "A TaxWithholding event on seller's account." + "description": "A tax withholding event on a seller's account." }, "TaxWithholdingEventList": { "type": "array", - "description": "A list of `TaxWithholding` events.", + "description": "A list of tax withholding events.", "items": { "$ref": "#/components/schemas/TaxWithholdingEvent" } @@ -2995,7 +3049,7 @@ "properties": { "TaxCollectionModel": { "type": "string", - "description": "The tax collection model applied to the item.\n\nPossible values:\n\n* MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n\n* Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon." + "description": "The tax collection model applied to the item.\n\nPossible values:\n\n* `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller.\n* `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon." }, "TaxesWithheld": { "$ref": "#/components/schemas/ChargeComponentList" @@ -3076,7 +3130,7 @@ "properties": { "TransactionType": { "type": "string", - "description": "Indicates the type of transaction.\n\nExample: 'Other Support Service fees'" + "description": "The transaction type. For example, 'Other Support Service fees'" }, "PostedDate": { "$ref": "#/components/schemas/Date" @@ -3096,7 +3150,7 @@ "properties": { "TransactionType": { "type": "string", - "description": "Indicates the type of transaction. For example, FBA Inventory Fee" + "description": "The transaction type. For example, FBA Inventory Fee." }, "PostedDate": { "$ref": "#/components/schemas/Date" diff --git a/resources/models/seller/finances/v2024-06-19.json b/resources/models/seller/finances/v2024-06-19.json new file mode 100644 index 000000000..fd53b03e6 --- /dev/null +++ b/resources/models/seller/finances/v2024-06-19.json @@ -0,0 +1,903 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "The Selling Partner API for Finances", + "description": "The Selling Partner API for Finances provides financial information relevant to a seller's business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.", + "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" + }, + "version": "2024-06-19" + }, + "servers": [ + { + "url": "https://sellingpartnerapi-na.amazon.com/" + } + ], + "paths": { + "/finances/2024-06-19/transactions": { + "get": { + "description": "Returns transactions for the given parameters. Orders from the last 48 hours might not be included in financial events.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than 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).", + "operationId": "listTransactions", + "parameters": [ + { + "name": "postedAfter", + "in": "query", + "description": "The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.", + "required": true, + "schema": { + "type": "string", + "format": "date-time" + }, + "example": "2023-01-12" + }, + { + "name": "postedBefore", + "in": "query", + "description": "The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.\n\nThe date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty.\n\n**Default:** Two minutes before the time of the request.", + "schema": { + "type": "string", + "format": "date-time" + }, + "example": "2023-02-12" + }, + { + "name": "marketplaceId", + "in": "query", + "description": "The ID of the marketplace from which you want to retrieve transactions.", + "schema": { + "type": "string" + }, + "example": "ATIV93840DER" + }, + { + "name": "nextToken", + "in": "query", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", + "schema": { + "type": "string" + }, + "example": "jehgri34yo7jr9e8f984tr9i4o" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListTransactionsResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "postedAfter": { + "value": "2023-03-07" + }, + "nextToken": { + "value": "jehgri34yo7jr9e8f984tr9i4o" + } + } + }, + "response": { + "nextToken": "Next token value", + "transactions": [ + { + "sellingPartnerMetadata": { + "sellingPartnerId": "A3TH9S8BH6GOGM", + "accountType": "PAYABLE", + "marketplaceId": "ATIV93840DER" + }, + "relatedIdentifiers": [ + { + "relatedIdentifierName": "ORDER_ID", + "relatedIdentifierValue": "8129762527551" + } + ], + "transactionType": "Shipment", + "postedDate": "2020-07-14T03:35:13.214Z", + "totalAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + } + } + ] + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "postedBefore": { + "value": "2022-03-07" + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Start date cannot be null", + "details": "Start date cannot be null" + } + ] + } + } + ] + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + }, + "tags": [ + "FinancesV20240619" + ] + } + } + }, + "components": { + "schemas": { + "ListTransactionsResponse": { + "type": "object", + "properties": { + "nextToken": { + "type": "string", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages." + }, + "transactions": { + "$ref": "#/components/schemas/Transactions" + } + }, + "description": "The response schema for the `listTransactions` operation." + }, + "Transactions": { + "type": "array", + "description": "A list of transactions within the specified time period.", + "items": { + "$ref": "#/components/schemas/Transaction" + } + }, + "Transaction": { + "type": "object", + "properties": { + "sellingPartnerMetadata": { + "$ref": "#/components/schemas/SellingPartnerMetadata" + }, + "relatedIdentifiers": { + "$ref": "#/components/schemas/RelatedIdentifiers" + }, + "transactionType": { + "type": "string", + "description": "The type of transaction.\n\n**Possible value:** `Shipment`" + }, + "transactionId": { + "type": "string", + "description": "The unique identifier of the transaction." + }, + "transactionStatus": { + "type": "string", + "description": "The status of the transaction. \n\n**Possible values:**\n\n* `Deferred`\n* `Released`" + }, + "description": { + "type": "string", + "description": "Describes the reasons for the transaction.\n\n**Example:** 'Order Payment', 'Refund Order'" + }, + "postedDate": { + "$ref": "#/components/schemas/Date" + }, + "totalAmount": { + "$ref": "#/components/schemas/Currency" + }, + "marketplaceDetails": { + "$ref": "#/components/schemas/MarketplaceDetails" + }, + "items": { + "$ref": "#/components/schemas/Items" + }, + "contexts": { + "$ref": "#/components/schemas/Contexts" + }, + "breakdowns": { + "$ref": "#/components/schemas/Breakdowns" + } + }, + "description": "All the information related to a transaction.", + "example": { + "sellingPartnerMetadata": { + "sellingPartnerId": "XXXXXXXXXXXXXX", + "accountType": "PAYABLE", + "marketplaceId": "ATVPDKIKX0DER" + }, + "relatedIdentifiers": [ + { + "relatedIdentifierName": "ORDER_ID", + "relatedIdentifierValue": "8129762527551" + } + ], + "transactionType": "Shipment", + "transactionId": "b1qD0oAliFkLiqRyGbmeT0DoS2Z2kHzi7TZ92z-vARI", + "transactionStatus": "Released", + "description": "Order Payment", + "postedDate": "2020-07-14T03:35:13.214Z", + "totalAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "marketplaceDetails": { + "marketplaceId": "ATVPDKIKX0DER", + "marketplaceName": "Amazon.com" + }, + "items": [ + { + "description": "Item title", + "totalAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "relatedIdentifiers": [ + { + "itemRelatedIdentifierName": "ORDER_ADJUSTMENT_ITEM_ID", + "itemRelatedIdentifierValue": "81297625-121-27551" + } + ], + "breakdowns": [ + { + "breakdownType": "Product Charges", + "breakdownAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "breakdowns": [ + { + "breakdownType": "Principle", + "breakdownAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "breakdowns": [] + } + ] + } + ], + "contexts": [ + { + "contextType": "ProductContext", + "asin": "B07FGXZQZ1", + "sku": "sku-12", + "quantityShipped": 1, + "fulfillmentNetwork": "MFN" + } + ] + } + ], + "breakdowns": { + "breakdowns": [ + { + "breakdownType": "Sales", + "breakdownAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "breakdowns": [ + { + "breakdownType": "Product Charges", + "breakdownAmount": { + "currencyAmount": 10, + "currencyCode": "USD" + }, + "breakdowns": [] + } + ] + } + ] + }, + "contexts": [ + { + "contextType": "AmazonPayContext", + "storeName": "Store 1", + "orderType": "Order Type", + "channel": "MFN" + } + ] + } + }, + "BigDecimal": { + "type": "number", + "description": "A signed decimal number." + }, + "Currency": { + "type": "object", + "properties": { + "currencyCode": { + "type": "string", + "description": "The three-digit currency code in ISO 4217 format." + }, + "currencyAmount": { + "$ref": "#/components/schemas/BigDecimal" + } + }, + "description": "A currency type and amount." + }, + "SellingPartnerMetadata": { + "type": "object", + "properties": { + "sellingPartnerId": { + "type": "string", + "description": "A unique seller identifier." + }, + "accountType": { + "type": "string", + "description": "The type of account in the transaction." + }, + "marketplaceId": { + "type": "string", + "description": "The identifier of the marketplace where the transaction occurred." + } + }, + "description": "Metadata that describes the seller." + }, + "RelatedIdentifier": { + "type": "object", + "properties": { + "relatedIdentifierName": { + "type": "string", + "description": "An enumerated set of related business identifier names.", + "enum": [ + "ORDER_ID", + "SHIPMENT_ID", + "EVENT_GROUP_ID", + "REFUND_ID", + "INVOICE_ID", + "DISBURSEMENT_ID", + "TRANSFER_ID", + "DEFERRED_TRANSACTION_ID" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ORDER_ID", + "description": "The `OrderId` that is associated with the transaction." + }, + { + "value": "SHIPMENT_ID", + "description": "The `ShipmentId` that is associated with the transaction." + }, + { + "value": "EVENT_GROUP_ID", + "description": "The identifier that is associated with the transaction's financial event group." + }, + { + "value": "REFUND_ID", + "description": "The `RefundId` that is associated with the transaction." + }, + { + "value": "INVOICE_ID", + "description": "The `InvoiceId` that is associated with the transaction." + }, + { + "value": "DISBURSEMENT_ID", + "description": "The disbursement ID for Amazon's bank transfer." + }, + { + "value": "TRANSFER_ID", + "description": "The `TransferId` associated with the transaction." + }, + { + "value": "DEFERRED_TRANSACTION_ID", + "description": "The transaction ID for the related deferred transaction" + } + ] + }, + "relatedIdentifierValue": { + "type": "string", + "description": "Corresponding value of `RelatedIdentifierName`." + } + }, + "description": "Related business identifier of the transaction." + }, + "RelatedIdentifiers": { + "type": "array", + "description": "Related business identifiers of the transaction.", + "items": { + "$ref": "#/components/schemas/RelatedIdentifier" + } + }, + "Date": { + "type": "string", + "description": "A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", + "format": "date-time" + }, + "MarketplaceDetails": { + "type": "object", + "properties": { + "marketplaceId": { + "type": "string", + "description": "The identifier of the marketplace where the transaction occured." + }, + "marketplaceName": { + "type": "string", + "description": "The name of the marketplace where the transaction occurred. For example: `Amazon.com`,`Amazon.in`" + } + }, + "description": "Information about the marketplace where the transaction occurred.", + "example": { + "marketplaceId": "ATVPDKIKX0DER", + "marketplaceName": "Amazon.com" + } + }, + "Items": { + "type": "array", + "description": "A list of items in the transaction.", + "items": { + "$ref": "#/components/schemas/Item" + } + }, + "Item": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the items in a transaction." + }, + "relatedIdentifiers": { + "$ref": "#/components/schemas/ItemRelatedIdentifiers" + }, + "totalAmount": { + "$ref": "#/components/schemas/Currency" + }, + "breakdowns": { + "$ref": "#/components/schemas/Breakdowns" + }, + "contexts": { + "$ref": "#/components/schemas/Contexts" + } + }, + "description": "Additional information about the items in a transaction." + }, + "ItemRelatedIdentifier": { + "type": "object", + "properties": { + "itemRelatedIdentifierName": { + "type": "string", + "description": "Enumerated set of related item identifier names for the item.", + "enum": [ + "ORDER_ADJUSTMENT_ITEM_ID", + "COUPON_ID", + "REMOVAL_SHIPMENT_ITEM_ID", + "TRANSACTION_ID" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ORDER_ADJUSTMENT_ITEM_ID", + "description": "An Amazon-defined order adjustment identifier defined for refunds, guarantee claims, and chargeback events." + }, + { + "value": "COUPON_ID", + "description": "An identifier for a coupon that is applied to a transaction." + }, + { + "value": "REMOVAL_SHIPMENT_ITEM_ID", + "description": "An identifier for an item in a removal shipment." + }, + { + "value": "TRANSACTION_ID", + "description": "The transaction ID of the item." + } + ] + }, + "itemRelatedIdentifierValue": { + "type": "string", + "description": "Corresponding value to `ItemRelatedIdentifierName`." + } + }, + "description": "Related business identifiers of the item.", + "example": { + "itemRelatedIdentifierName": "ORDER_ADJUSTMENT_ITEM_ID", + "itemRelatedIdentifierValue": "OAI-123456789" + } + }, + "ItemRelatedIdentifiers": { + "type": "array", + "description": "Related business identifiers of the item in the transaction.", + "items": { + "$ref": "#/components/schemas/ItemRelatedIdentifier" + } + }, + "Breakdowns": { + "type": "array", + "description": "A list of breakdowns that provide details on how the total amount is calculated for the transaction.", + "items": { + "$ref": "#/components/schemas/Breakdown" + } + }, + "Breakdown": { + "type": "object", + "properties": { + "breakdownType": { + "type": "string", + "description": "The type of charge." + }, + "breakdownAmount": { + "$ref": "#/components/schemas/Currency" + }, + "breakdowns": { + "$ref": "#/components/schemas/Breakdown" + } + }, + "description": "Details about the movement of money in the financial transaction. Breakdowns are further categorized into breakdown types, breakdown amounts, and further breakdowns." + }, + "Contexts": { + "type": "array", + "description": "A list of additional information about the item.", + "items": { + "$ref": "#/components/schemas/Context" + } + }, + "Context": { + "description": "Additional Information about the item.", + "allOf": [ + { + "required": [ + "contextType" + ], + "type": "object", + "properties": { + "contextType": { + "type": "string" + } + } + }, + { + "$ref": "#/components/schemas/AmazonPayContext" + }, + { + "$ref": "#/components/schemas/ProductContext" + }, + { + "$ref": "#/components/schemas/PaymentsContext" + }, + { + "$ref": "#/components/schemas/DeferredContext" + }, + { + "$ref": "#/components/schemas/TimeRangeContext" + } + ] + }, + "ProductContext": { + "type": "object", + "properties": { + "asin": { + "type": "string", + "description": "The Amazon Standard Identification Number (ASIN) of the item." + }, + "sku": { + "type": "string", + "description": "The Stock Keeping Unit (SKU) of the item." + }, + "quantityShipped": { + "type": "integer", + "description": "The quantity of the item shipped.", + "format": "int32" + }, + "fulfillmentNetwork": { + "type": "string", + "description": "The fulfillment network of the item." + } + }, + "description": "Additional information related to the product.", + "example": { + "asin": "B07FGXZQZ1", + "sku": "sku-12", + "quantityShipped": 1, + "fulfillmentNetwork": "MFN" + } + }, + "AmazonPayContext": { + "type": "object", + "properties": { + "storeName": { + "type": "string", + "description": "The name of the store that is related to the transaction." + }, + "orderType": { + "type": "string", + "description": "The transaction's order type." + }, + "channel": { + "type": "string", + "description": "Channel details of related transaction." + } + }, + "description": "Additional information related to Amazon Pay.", + "example": { + "storeName": "Store 1", + "orderType": "Order Type", + "channel": "MFN" + } + }, + "PaymentsContext": { + "type": "object", + "properties": { + "paymentType": { + "type": "string", + "description": "The type of payment." + }, + "paymentMethod": { + "type": "string", + "description": "The method of payment." + }, + "paymentReference": { + "type": "string", + "description": "The reference number of the payment." + }, + "paymentDate": { + "$ref": "#/components/schemas/Date" + } + }, + "description": "Additional information related to payments-related transactions.", + "example": { + "paymentType": "Debit Card", + "paymentMethod": "BANK", + "paymentReference": "XXXXX123", + "paymentDate": "2020-07-14T03:35:13.214Z" + } + }, + "DeferredContext": { + "type": "object", + "properties": { + "deferralReason": { + "type": "string", + "description": "Deferral policy applied on the transaction.\n\n**Examples:** `B2B`,`DD7`" + }, + "maturityDate": { + "$ref": "#/components/schemas/Date" + }, + "deferralStatus": { + "type": "string", + "description": "The status of the transaction. For example, `HOLD`,`RELEASE`." + } + }, + "description": "Additional information related to deferred transactions.", + "example": { + "deferralReason": "B2B", + "maturityDate": "2024-07-14T00:00:00Z", + "deferralStatus": "HOLD" + } + }, + "TimeRangeContext": { + "type": "object", + "properties": { + "startTime": { + "$ref": "#/components/schemas/Date" + }, + "endTime": { + "$ref": "#/components/schemas/Date" + } + }, + "description": "Additional information that is related to the time range of the transaction.", + "example": { + "startTime": "2020-07-14T03:35:13.214Z", + "endTime": "2020-07-14T03:35:13.214Z" + } + }, + "ErrorList": { + "required": [ + "errors" + ], + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "The error responses that are returned when the request is unsuccessful.", + "items": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "A list of error responses returned when a request is unsuccessful." + }, + "Error": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An error code that identifies the type of error that occurred." + }, + "message": { + "type": "string", + "description": "A message that describes the error condition." + }, + "details": { + "type": "string", + "description": "Additional details that can help the caller understand or fix the issue." + } + }, + "description": "An error response returned when the request is unsuccessful." + } + } + }, + "x-original-swagger-version": "2.0" +} \ No newline at end of file diff --git a/resources/models/seller/invoices/v2024-06-19.json b/resources/models/seller/invoices/v2024-06-19.json new file mode 100644 index 000000000..0911a9d29 --- /dev/null +++ b/resources/models/seller/invoices/v2024-06-19.json @@ -0,0 +1,2656 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "The Selling Partner API for Invoices.", + "description": "Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.", + "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" + }, + "version": "2024-06-19" + }, + "servers": [ + { + "url": "https://sellingpartnerapi-na.amazon.com/" + } + ], + "paths": { + "/tax/invoices/2024-06-19/attributes": { + "get": { + "tags": [ + "InvoicesV20240619" + ], + "description": "Returns marketplace-dependent schemas and their respective set of possible values.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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 indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoicesAttributes", + "parameters": [ + { + "name": "marketplaceId", + "in": "query", + "description": "The marketplace identifier.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoicesAttributesResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + } + } + }, + "response": { + "invoicesAttributes": { + "invoiceStatusOptions": [ + { + "description": "The government authorized the invoice.", + "value": "AUTHORIZED" + }, + { + "description": "The government rejected the invoice.", + "value": "REJECTED" + }, + { + "description": "The invoice is canceled.", + "value": "CANCELED" + } + ], + "invoiceTypeOptions": [], + "transactionIdentifierNameOptions": [], + "transactionTypeOptions": [] + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": {} + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required parameter: 'marketplaceId'", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + }, + "/tax/invoices/2024-06-19/documents/{invoicesDocumentId}": { + "get": { + "tags": [ + "InvoicesV20240619" + ], + "description": "Returns the invoice document's ID and URL. Use the URL to download the ZIP file, which contains the invoices from the corresponding `createInvoicesExport` request.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 1 |\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 indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoicesDocument", + "parameters": [ + { + "name": "invoicesDocumentId", + "in": "path", + "description": "The export document identifier.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoicesDocumentResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "invoicesDocumentId": { + "value": "18c598f5-75db-4c1a-bd3e-4c64b36781c5" + } + } + }, + "response": { + "invoicesDocument": { + "invoicesDocumentId": "18c598f5-75db-4c1a-bd3e-4c64b36781c5", + "invoicesDocumentUrl": "https://invoicesdocumentbucket.s3.eu-east-1.amazonaws.com/18c598f5-75db-4c1a-bd3e-4c64b36781c5.xml?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=&X-Amz-Date=20240710T171315Z&X-Amz-Expires=300&X-Amz-Signature=&X-Amz-SignedHeaders=host" + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": {} + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required parameter 'invoiceId'", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + }, + "/tax/invoices/2024-06-19/exports": { + "get": { + "tags": [ + "InvoicesV20240619" + ], + "description": "Returns invoice exports details for exports that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.1 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoicesExports", + "parameters": [ + { + "name": "marketplaceId", + "in": "query", + "description": "The returned exports match the specified marketplace.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dateStart", + "in": "query", + "description": "The earliest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 30 days ago.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "nextToken", + "in": "query", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "The maximum number of invoices to return in a single call.\n\nMinimum: 1\n\nMaximum: 100", + "schema": { + "type": "integer" + } + }, + { + "name": "dateEnd", + "in": "query", + "description": "The latest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default value is the time of the request.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "status", + "in": "query", + "description": "Return exports matching the status specified. ", + "schema": { + "type": "string", + "enum": [ + "REQUESTED", + "PROCESSING", + "DONE", + "ERROR" + ], + "x-docgen-enum-table-extension": [ + { + "description": "The export request was created, but has not started yet.", + "value": "REQUESTED" + }, + { + "description": "The export request is being processed", + "value": "PROCESSING" + }, + { + "description": "The export request is finished with success. Use the document IDs to download the output documents.", + "value": "DONE" + }, + { + "description": "The export request resulted in an error. Check the `errorMessage` attribute for more details.", + "value": "ERROR" + } + ] + }, + "x-docgen-enum-table-extension": [ + { + "description": "The export request was created, but has not started yet.", + "value": "REQUESTED" + }, + { + "description": "The export request is being processed", + "value": "PROCESSING" + }, + { + "description": "The export request is finished with success. Use the document IDs to download the output documents.", + "value": "DONE" + }, + { + "description": "The export request resulted in an error. Check the `errorMessage` attribute for more details.", + "value": "ERROR" + } + ] + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoicesExportsResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "dateEnd": { + "value": "2024-07-10T23:59:59.000Z" + }, + "dateStart": { + "value": "2024-07-10T00:00:00.000Z" + }, + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + }, + "pageSize": { + "value": 1 + }, + "status": { + "value": "DONE" + } + } + }, + "response": { + "exports": [ + { + "errorMessage": "", + "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef", + "generateExportFinishedAt": "2024-07-10T16:00:00.000Z", + "generateExportStartedAt": "2024-07-10T15:00:00.000Z", + "invoicesDocumentIds": [ + "18c598f5-75db-4c1a-bd3e-4c64b36781c5" + ], + "status": "DONE" + } + ], + "nextToken": "WTtGLzlBkat22iOI5C1yrpSPqMpz9UHYxdvm5U4DqEVJL5hqxv9xMuXe3eg35i17" + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + }, + "nextToken": { + "value": "WTtGLzlBkat22iOI5C1yrpSPqMpz9UHYxdvm5U4DqEVJL5hqxv9xMuXe3eg35i17" + }, + "status": { + "value": "DONE" + } + } + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Specifying nextToken with any other parameters will cause the request to fail.", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + }, + "post": { + "tags": [ + "InvoicesV20240619" + ], + "description": "Creates an invoice export request.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.167 | 1 |\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 indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "createInvoicesExport", + "requestBody": { + "description": "Information required to create the export request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExportInvoicesRequest" + } + } + }, + "required": true + }, + "responses": { + "202": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExportInvoicesResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "body": { + "value": { + "dateEnd": "2024-07-30T23:59:59", + "dateStart": "2024-07-01T00:00:00", + "externalInvoiceId": "1283743", + "fileFormat": "XML", + "invoiceType": "SYMBOLIC_RETURN", + "marketplaceId": "A2Q3Y263D00KWC", + "series": "32", + "statuses": [ + "AUTHORIZED" + ], + "transactionIdentifier": { + "name": "BUSINESS_TRANSACTION_ID", + "id": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + }, + "transactionType": "CUSTOMER_SALES" + } + } + } + }, + "response": { + "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef" + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": {} + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required attribute(s): 'marketplaceId'.", + "message": "Request has missing or invalid parameters and cannot be parsed." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/tax/invoices/2024-06-19/exports/{exportId}": { + "get": { + "tags": [ + "InvoicesV20240619" + ], + "description": "Returns invoice export details (including the `exportDocumentId`, if available) for the export that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoicesExport", + "parameters": [ + { + "name": "exportId", + "in": "path", + "description": "The unique identifier for the export.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoicesExportResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "exportId": { + "value": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef" + } + } + }, + "response": { + "export": { + "errorMessage": "", + "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef", + "generateExportFinishedAt": "2024-07-10T16:00:00.000Z", + "generateExportStartedAt": "2024-07-10T15:00:00.000Z", + "invoicesDocumentIds": [ + "18c598f5-75db-4c1a-bd3e-4c64b36781c5" + ], + "status": "DONE" + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": {} + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required parameter 'exportId'", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + }, + "/tax/invoices/2024-06-19/invoices": { + "get": { + "tags": [ + "InvoicesV20240619" + ], + "description": "Returns invoice details for the invoices that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.1 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoices", + "parameters": [ + { + "name": "transactionIdentifierName", + "in": "query", + "description": "The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options.", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "The maximum number of invoices you want to return in a single call.\n\nMinimum: 1\n\nMaximum: 200", + "schema": { + "type": "integer" + } + }, + { + "name": "dateEnd", + "in": "query", + "description": "The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the current date-time.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "marketplaceId", + "in": "query", + "description": "The response includes only the invoices that match the specified marketplace.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "transactionType", + "in": "query", + "description": "The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options.", + "schema": { + "type": "string" + } + }, + { + "name": "transactionIdentifierId", + "in": "query", + "description": "The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field.", + "schema": { + "type": "string" + } + }, + { + "name": "dateStart", + "in": "query", + "description": "The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "series", + "in": "query", + "description": "Return invoices with the specified series number.", + "schema": { + "type": "string" + } + }, + { + "name": "nextToken", + "in": "query", + "description": "The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.", + "schema": { + "type": "string" + } + }, + { + "name": "sortOrder", + "in": "query", + "description": "Sort the invoices in the response in ascending or descending order.", + "schema": { + "type": "string", + "enum": [ + "DESC", + "ASC" + ], + "x-docgen-enum-table-extension": [ + { + "description": "Sort in descending order.", + "value": "DESC" + }, + { + "description": "Sort in ascending order.", + "value": "ASC" + } + ] + }, + "x-docgen-enum-table-extension": [ + { + "description": "Sort in descending order.", + "value": "DESC" + }, + { + "description": "Sort in ascending order.", + "value": "ASC" + } + ] + }, + { + "name": "invoiceType", + "in": "query", + "description": "The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options.", + "schema": { + "type": "string" + } + }, + { + "name": "statuses", + "in": "query", + "description": "A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options.\n\nMin count: 1", + "style": "form", + "explode": false, + "schema": { + "minItems": 1, + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "externalInvoiceId", + "in": "query", + "description": "Return invoices that match this external ID. This is typically the Government Invoice ID.", + "schema": { + "type": "string" + } + }, + { + "name": "sortBy", + "in": "query", + "description": "The attribute by which you want to sort the invoices in the response.", + "schema": { + "type": "string", + "enum": [ + "START_DATE_TIME" + ], + "x-docgen-enum-table-extension": [ + { + "description": "Sort by date time.", + "value": "START_DATE_TIME" + } + ] + }, + "x-docgen-enum-table-extension": [ + { + "description": "Sort by date time.", + "value": "START_DATE_TIME" + } + ] + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoicesResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "dateEnd": { + "value": "2024-07-20T23:59:59" + }, + "dateStart": { + "value": "2024-07-01T00:00:00" + }, + "invoiceType": { + "value": "SYMBOLIC_RETURN" + }, + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + }, + "pageSize": { + "value": 1 + }, + "sortBy": { + "value": "START_DATE_TIME" + }, + "sortOrder": { + "value": "DESC" + }, + "transactionIdentifierId": { + "value": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + }, + "transactionIdentifierName": { + "value": "BUSINESS_TRANSACTION_ID" + }, + "transactionType": { + "value": "CUSTOMER_SALES" + } + } + }, + "response": { + "invoices": [ + { + "date": "2024-07-10T15:00:00.000Z", + "errorCode": "", + "externalInvoiceId": "1283743", + "govResponse": "", + "id": "ad5b9dcd-6981-4dc4-a3d7-dd2568298a94", + "invoiceType": "SYMBOLIC_RETURN", + "series": "32", + "status": "AUTHORIZED", + "transactionIds": [ + { + "name": "BUSINESS_TRANSACTION_ID", + "id": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + } + ], + "transactionType": "CUSTOMER_SALES" + } + ], + "nextToken": "WTtGLzlBkat22iOI5C1yrpSPqMpz9UHYxdvm5U4DqEVJL5hqxv9xMuXe3eg35i17" + } + }, + { + "request": { + "parameters": { + "externalInvoiceId": { + "value": "1283743" + }, + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + }, + "series": { + "value": "32" + } + } + }, + "response": { + "invoices": [ + { + "date": "2024-07-10T15:00:00.000Z", + "errorCode": "", + "externalInvoiceId": "1283743", + "govResponse": "", + "id": "ad5b9dcd-6981-4dc4-a3d7-dd2568298a94", + "invoiceType": "SYMBOLIC_RETURN", + "series": "32", + "status": "AUTHORIZED", + "transactionIds": [ + { + "name": "BUSINESS_TRANSACTION_ID", + "id": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + } + ], + "transactionType": "CUSTOMER_SALES" + } + ], + "nextToken": "WTtGLzlBkat22iOI5C1yrpSPqMpz9UHYxdvm5U4DqEVJL5hqxv9xMuXe3eg35i17" + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + }, + "nextToken": { + "value": "WTtGLzlBkat22iOI5C1yrpSPqMpz9UHYxdvm5U4DqEVJL5hqxv9xMuXe3eg35i17" + }, + "statuses": { + "value": [ + "REJECTED" + ] + } + } + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Specifying nextToken with any other parameters will cause the request to fail.", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + }, + "/tax/invoices/2024-06-19/invoices/{invoiceId}": { + "get": { + "tags": [ + "InvoicesV20240619" + ], + "description": "Returns invoice data for the specified invoice. This operation returns only a subset of the invoices data; refer to the response definition to get all the possible attributes.\nTo get the full invoice, use the `createInvoicesExport` operation to start an export request.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getInvoice", + "parameters": [ + { + "name": "marketplaceId", + "in": "query", + "description": "The marketplace from which you want the invoice.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "invoiceId", + "in": "path", + "description": "The invoice identifier.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetInvoiceResponse" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "invoiceId": { + "value": "ad5b9dcd-6981-4dc4-a3d7-dd2568298a94" + }, + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + } + } + }, + "response": { + "invoice": { + "date": "2024-07-10T15:00:00.000Z", + "errorCode": "", + "externalInvoiceId": "1283743", + "govResponse": "", + "id": "ad5b9dcd-6981-4dc4-a3d7-dd2568298a94", + "invoiceType": "CUSTOMER_SALES", + "series": "32", + "status": "AUTHORIZED", + "transactionIds": [ + { + "name": "BUSINESS_TRANSACTION_ID", + "id": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + } + ], + "transactionType": "CUSTOMER_SALES_SYMBOLIC" + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "marketplaceId": { + "value": "A2Q3Y263D00KWC" + } + } + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required parameter 'invoiceId'", + "message": "Invalid Request." + } + ] + } + }, + { + "request": { + "parameters": { + "invoiceId": { + "value": "ad5b9dcd-6981-4dc4-a3d7-dd2568298a94" + } + } + }, + "response": { + "errors": [ + { + "code": "400", + "details": "Missing required parameter 'marketplaceId'", + "message": "Invalid Request." + } + ] + } + } + ] + } + }, + "401": { + "description": "A list of error responses returned when a request is unsuccessful.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "AttributeOption": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the attribute value." + }, + "value": { + "type": "string", + "description": "The possible values for the attribute option." + } + }, + "description": "The definition of the attribute option." + }, + "Error": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An error code that identifies the type of error that occurred." + }, + "details": { + "type": "string", + "description": "Additional details that can help the caller understand or fix the issue." + }, + "message": { + "type": "string", + "description": "A message that describes the error condition." + } + }, + "description": "The error response that is returned when the request is unsuccessful." + }, + "Export": { + "type": "object", + "properties": { + "errorMessage": { + "type": "string", + "description": "When the export generation fails, this attribute contains a description of the error." + }, + "exportId": { + "type": "string", + "description": "The export identifier." + }, + "generateExportFinishedAt": { + "type": "string", + "description": "The date and time when the export generation finished. Vales are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", + "format": "date-time" + }, + "generateExportStartedAt": { + "type": "string", + "description": "The date and time when the export generation started. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", + "format": "date-time" + }, + "invoicesDocumentIds": { + "type": "array", + "description": "The identifier for the export documents. To get the information required to retrieve the export document's contents, pass each ID in the `getInvoicesDocument` operation.\n\nThis list is empty until the status is `DONE`.", + "items": { + "type": "string" + } + }, + "status": { + "$ref": "#/components/schemas/ExportStatus" + } + }, + "description": "Detailed information about the export." + }, + "ExportInvoicesRequest": { + "required": [ + "marketplaceId" + ], + "type": "object", + "properties": { + "dateEnd": { + "type": "string", + "description": "The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the time of the request.", + "format": "date" + }, + "dateStart": { + "type": "string", + "description": "The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request.", + "format": "date" + }, + "externalInvoiceId": { + "type": "string", + "description": "The external ID of the invoices you want included in the response." + }, + "fileFormat": { + "$ref": "#/components/schemas/FileFormat" + }, + "invoiceType": { + "type": "string", + "description": "The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options." + }, + "marketplaceId": { + "type": "string", + "description": "The ID of the marketplace from which you want the invoices." + }, + "series": { + "type": "string", + "description": "The series number of the invoices you want included in the response." + }, + "statuses": { + "minItems": 1, + "type": "array", + "description": "A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options.\n\nMin count: 1", + "items": { + "type": "string" + } + }, + "transactionIdentifier": { + "$ref": "#/components/schemas/TransactionIdentifier" + }, + "transactionType": { + "type": "string", + "description": "The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options" + } + }, + "description": "The information required to create the export request.", + "example": { + "dateEnd": "2024-07-30T23:59:59", + "dateStart": "2024-07-01T00:00:00", + "externalInvoiceId": "1283743", + "fileFormat": "XML", + "invoiceType": "SYMBOLIC_RETURN", + "marketplaceId": "A2Q3Y263D00KWC", + "series": "32", + "statuses": [ + "AUTHORIZED" + ], + "transactionIdentifier": { + "name": "BUSINESS_TRANSACTION_ID", + "id": "94cd4e1a-5cc5-486d-b592-045a95a168e1" + }, + "transactionType": "CUSTOMER_SALES" + } + }, + "ExportInvoicesResponse": { + "type": "object", + "properties": { + "exportId": { + "type": "string", + "description": "The export identifier." + } + }, + "description": "Success." + }, + "ExportStatus": { + "type": "string", + "description": "The current status of the request.", + "enum": [ + "REQUESTED", + "PROCESSING", + "DONE", + "ERROR" + ], + "x-docgen-enum-table-extension": [ + { + "description": "The export request was created, but has not yet started.", + "value": "REQUESTED" + }, + { + "description": "The export request is being processed.", + "value": "PROCESSING" + }, + { + "description": "The export request has finished successfully. Use the document IDs to download the output documents.", + "value": "DONE" + }, + { + "description": "The export request resulted in an error. Refer to the `errorMessage` attribute for more information.", + "value": "ERROR" + } + ] + }, + "FileFormat": { + "type": "string", + "description": "Supported invoice file extensions.", + "enum": [ + "XML" + ], + "x-docgen-enum-table-extension": [ + { + "description": "The invoice file is in XML format.", + "value": "XML" + } + ] + }, + "GetInvoiceResponse": { + "type": "object", + "properties": { + "invoice": { + "$ref": "#/components/schemas/Invoice" + } + }, + "description": "Success." + }, + "GetInvoicesAttributesResponse": { + "type": "object", + "properties": { + "invoicesAttributes": { + "$ref": "#/components/schemas/InvoicesAttributes" + } + }, + "description": "Success." + }, + "GetInvoicesDocumentResponse": { + "type": "object", + "properties": { + "invoicesDocument": { + "$ref": "#/components/schemas/InvoicesDocument" + } + }, + "description": "Success." + }, + "GetInvoicesExportResponse": { + "type": "object", + "properties": { + "export": { + "$ref": "#/components/schemas/Export" + } + }, + "description": "Success." + }, + "GetInvoicesExportsResponse": { + "type": "object", + "properties": { + "exports": { + "maxItems": 100, + "type": "array", + "description": "A list of exports.", + "items": { + "$ref": "#/components/schemas/Export" + } + }, + "nextToken": { + "type": "string", + "description": "This token is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getInvoices` operation and include this token with the previous call parameters." + } + }, + "description": "Success." + }, + "GetInvoicesResponse": { + "type": "object", + "properties": { + "invoices": { + "maxItems": 100, + "type": "array", + "description": "A list of invoices.", + "items": { + "$ref": "#/components/schemas/Invoice" + } + }, + "nextToken": { + "type": "string", + "description": "This token is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getInvoices` operation and include this token with the previous call parameters." + } + }, + "description": "Success." + }, + "Invoice": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "The date and time the invoice is issued. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", + "format": "date-time" + }, + "errorCode": { + "type": "string", + "description": "If the invoice is in an error state, this attribute displays the error code." + }, + "externalInvoiceId": { + "type": "string", + "description": "The invoice identifier that is used by an external party. This is typically the government agency that authorized the invoice." + }, + "govResponse": { + "type": "string", + "description": "The response message from the government authority when there is an error during invoice issuance." + }, + "id": { + "type": "string", + "description": "The invoice identifier." + }, + "invoiceType": { + "type": "string", + "description": "The classification of the invoice type. This varies across marketplaces. Use the `getInvoicesAttributes` operation to check `invoiceType` options." + }, + "series": { + "type": "string", + "description": "Use this identifier in conjunction with `externalInvoiceId` to identify invoices from the same seller." + }, + "status": { + "type": "string", + "description": "The invoice status classification. Use the `getInvoicesAttributes` operation to check invoice status options." + }, + "transactionIds": { + "type": "array", + "description": "List with identifiers for the transactions associated to the invoice.", + "items": { + "$ref": "#/components/schemas/TransactionIdentifier" + } + }, + "transactionType": { + "type": "string", + "description": "Classification of the transaction that originated this invoice. Use the `getInvoicesAttributes` operation to check `transactionType` options." + } + }, + "description": "Provides detailed information about an invoice." + }, + "InvoicesAttributes": { + "type": "object", + "properties": { + "invoiceStatusOptions": { + "type": "array", + "description": "A list of all the options that are available for the invoice status attribute.", + "items": { + "$ref": "#/components/schemas/AttributeOption" + } + }, + "invoiceTypeOptions": { + "type": "array", + "description": "A list of all the options that are available for the invoice type attribute.", + "items": { + "$ref": "#/components/schemas/AttributeOption" + } + }, + "transactionIdentifierNameOptions": { + "type": "array", + "description": "A list of all the options that are available for the transaction identifier name attribute.", + "items": { + "$ref": "#/components/schemas/AttributeOption" + } + }, + "transactionTypeOptions": { + "type": "array", + "description": "A list of all the options that are available for the transaction type attribute.", + "items": { + "$ref": "#/components/schemas/AttributeOption" + } + } + }, + "description": "An object that contains the invoice attributes definition." + }, + "InvoicesDocument": { + "type": "object", + "properties": { + "invoicesDocumentId": { + "type": "string", + "description": "The identifier of the export document." + }, + "invoicesDocumentUrl": { + "type": "string", + "description": "A pre-signed URL that you can use to download the invoices document in zip format. This URL expires after 30 seconds." + } + }, + "description": "An object that contains the `documentId` and an S3 pre-signed URL that you can use to download the specified file." + }, + "TransactionIdentifier": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The transaction identifier name. Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options." + }, + "id": { + "type": "string", + "description": "The transaction identifier." + } + }, + "description": "The identifier for a transaction." + }, + "ErrorList": { + "required": [ + "errors" + ], + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of errors.", + "items": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "A list of error responses that are returned when a request is unsuccessful." + } + } + }, + "x-original-swagger-version": "2.0" +} \ No newline at end of file diff --git a/resources/models/seller/listings-items/v2021-08-01.json b/resources/models/seller/listings-items/v2021-08-01.json index 2d97ac018..d97af1e45 100644 --- a/resources/models/seller/listings-items/v2021-08-01.json +++ b/resources/models/seller/listings-items/v2021-08-01.json @@ -53,6 +53,7 @@ "style": "form", "explode": false, "schema": { + "maxItems": 1, "type": "array", "items": { "type": "string" @@ -169,6 +170,10 @@ "price": { "currencyCode": "USD", "amount": "100.00" + }, + "audience": { + "value": "ALL", + "displayName": "Sell on Amazon" } } ], @@ -299,6 +304,10 @@ "price": { "currencyCode": "USD", "amount": "100.00" + }, + "audience": { + "value": "ALL", + "displayName": "Sell on Amazon" } } ], @@ -608,6 +617,7 @@ "style": "form", "explode": false, "schema": { + "maxItems": 1, "type": "array", "items": { "type": "string" @@ -656,7 +666,7 @@ "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", - "description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog." + "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ] }, @@ -664,7 +674,7 @@ "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", - "description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog." + "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ] }, @@ -1023,6 +1033,7 @@ "style": "form", "explode": false, "schema": { + "maxItems": 1, "type": "array", "items": { "type": "string" @@ -1275,6 +1286,7 @@ "style": "form", "explode": false, "schema": { + "maxItems": 1, "type": "array", "items": { "type": "string" @@ -1323,7 +1335,7 @@ "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", - "description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog." + "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ] }, @@ -1331,7 +1343,7 @@ "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", - "description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog." + "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ] }, @@ -1648,217 +1660,1481 @@ }, "x-codegen-request-body-name": "body" } - } - }, - "components": { - "schemas": { - "Error": { - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "An error code that identifies the type of error that occurred." - }, - "message": { - "type": "string", - "description": "A message that describes the error condition." - }, - "details": { - "type": "string", - "description": "Additional details that can help the caller understand or fix the issue." - } - }, - "description": "Error response returned when the request is unsuccessful." - }, - "ErrorList": { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Error" - } - } - }, - "description": "A list of error responses returned when a request is unsuccessful." - }, - "Item": { - "required": [ - "sku" + }, + "/listings/2021-08-01/items/{sellerId}": { + "get": { + "tags": [ + "ListingsItemsV20210801" ], - "type": "object", - "properties": { - "sku": { - "type": "string", - "description": "A selling partner provided identifier for an Amazon listing." - }, - "summaries": { - "$ref": "#/components/schemas/ItemSummaries" - }, - "attributes": { - "$ref": "#/components/schemas/ItemAttributes" - }, - "issues": { - "$ref": "#/components/schemas/ItemIssues" - }, - "offers": { - "$ref": "#/components/schemas/ItemOffers" - }, - "fulfillmentAvailability": { - "type": "array", - "description": "The fulfillment availability for the listings item.", - "items": { - "$ref": "#/components/schemas/FulfillmentAvailability" - } - }, - "procurement": { - "type": "array", - "description": "The vendor procurement information for the listings item.", - "items": { - "$ref": "#/components/schemas/ItemProcurement" + "description": "Search for and return list of listings items and respective details for a selling partner.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 5 |\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": "searchListingsItems", + "parameters": [ + { + "name": "sellerId", + "in": "path", + "description": "A selling partner identifier, such as a merchant account or vendor code.", + "required": true, + "schema": { + "type": "string" } - } - }, - "description": "A listings item." - }, - "ItemSummaries": { - "type": "array", - "description": "Summary details of a listings item.", - "items": { - "$ref": "#/components/schemas/ItemSummaryByMarketplace" - } - }, - "ItemSummaryByMarketplace": { - "required": [ - "asin", - "createdDate", - "itemName", - "lastUpdatedDate", - "marketplaceId", - "productType", - "status" - ], - "type": "object", - "properties": { - "marketplaceId": { - "type": "string", - "description": "A marketplace identifier. Identifies the Amazon marketplace for the listings item." }, - "asin": { - "type": "string", - "description": "Amazon Standard Identification Number (ASIN) of the listings item." + { + "name": "marketplaceIds", + "in": "query", + "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", + "required": true, + "style": "form", + "explode": false, + "schema": { + "maxItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "example": "ATVPDKIKX0DER" }, - "productType": { - "type": "string", - "description": "The Amazon product type of the listings item." + { + "name": "identifiers", + "in": "query", + "description": "A comma-delimited list of product identifiers to search for listings items by. \n\n**Note**: \n1. Required when `identifiersType` is provided.", + "style": "form", + "explode": false, + "schema": { + "maxItems": 20, + "type": "array", + "items": { + "type": "string" + } + }, + "example": "GM-ZDPI-9B4E" }, - "conditionType": { - "type": "string", - "description": "Identifies the condition of the listings item.", - "enum": [ - "new_new", - "new_open_box", - "new_oem", - "refurbished_refurbished", - "used_like_new", - "used_very_good", - "used_good", - "used_acceptable", - "collectible_like_new", - "collectible_very_good", - "collectible_good", - "collectible_acceptable", - "club_club" - ], + { + "name": "identifiersType", + "in": "query", + "description": "Type of product identifiers to search for listings items by. \n\n**Note**: \n1. Required when `identifiers` is provided.", + "schema": { + "type": "string", + "enum": [ + "ASIN", + "EAN", + "GTIN", + "ISBN", + "JAN", + "MINSAN", + "SKU", + "UPC" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ASIN", + "description": "Amazon Standard Identification Number." + }, + { + "value": "EAN", + "description": "European Article Number." + }, + { + "value": "GTIN", + "description": "Global Trade Item Number." + }, + { + "value": "ISBN", + "description": "International Standard Book Number." + }, + { + "value": "JAN", + "description": "Japanese Article Number." + }, + { + "value": "MINSAN", + "description": "Minsan Code." + }, + { + "value": "SKU", + "description": "Stock Keeping Unit, a seller-specified identifier for an Amazon listing." + }, + { + "value": "UPC", + "description": "Universal Product Code." + } + ] + }, + "example": "SKU", "x-docgen-enum-table-extension": [ { - "value": "new_new", - "description": "New." - }, - { - "value": "new_open_box", - "description": "New - Open Box." - }, - { - "value": "new_oem", - "description": "New - OEM." - }, - { - "value": "refurbished_refurbished", - "description": "Refurbished." - }, - { - "value": "used_like_new", - "description": "Used - Like New." - }, - { - "value": "used_very_good", - "description": "Used - Very Good." + "value": "ASIN", + "description": "Amazon Standard Identification Number." }, { - "value": "used_good", - "description": "Used - Good." + "value": "EAN", + "description": "European Article Number." }, { - "value": "used_acceptable", - "description": "Used - Acceptable." + "value": "GTIN", + "description": "Global Trade Item Number." }, { - "value": "collectible_like_new", - "description": "Collectible - Like New." + "value": "ISBN", + "description": "International Standard Book Number." }, { - "value": "collectible_very_good", - "description": "Collectible - Very Good." + "value": "JAN", + "description": "Japanese Article Number." }, { - "value": "collectible_good", - "description": "Collectible - Good." + "value": "MINSAN", + "description": "Minsan Code." }, { - "value": "collectible_acceptable", - "description": "Collectible - Acceptable." + "value": "SKU", + "description": "Stock Keeping Unit, a seller-specified identifier for an Amazon listing." }, { - "value": "club_club", - "description": "Club." + "value": "UPC", + "description": "Universal Product Code." } ] }, - "status": { - "type": "array", - "description": "Statuses that apply to the listings item.", - "items": { - "type": "string", - "enum": [ - "BUYABLE", - "DISCOVERABLE" - ], - "x-docgen-enum-table-extension": [ - { - "value": "BUYABLE", - "description": "The listings item can be purchased by shoppers. This status does not apply to vendor listings." - }, - { - "value": "DISCOVERABLE", - "description": "The listings item is visible to shoppers." - } - ] - } + { + "name": "pageSize", + "in": "query", + "description": "Number of results to be returned per page.", + "schema": { + "maximum": 20, + "type": "integer", + "default": 10 + }, + "example": 9 }, - "fnSku": { - "type": "string", - "description": "The fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item." + { + "name": "pageToken", + "in": "query", + "description": "A token to fetch a certain page when there are multiple pages worth of results.", + "schema": { + "type": "string" + }, + "example": "sdlkj234lkj234lksjdflkjwdflkjsfdlkj234234234234" }, - "itemName": { - "type": "string", + { + "name": "includedData", + "in": "query", + "description": "A comma-delimited list of data sets to include in the response. Default: summaries.", + "style": "form", + "explode": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "summaries", + "attributes", + "issues", + "offers", + "fulfillmentAvailability", + "procurement" + ], + "x-docgen-enum-table-extension": [ + { + "value": "summaries", + "description": "Summary details of the listing item." + }, + { + "value": "attributes", + "description": "JSON object containing structured listing item attribute data keyed by attribute name." + }, + { + "value": "issues", + "description": "Issues associated with the listing item." + }, + { + "value": "offers", + "description": "Current offers for the listing item." + }, + { + "value": "fulfillmentAvailability", + "description": "Fulfillment availability details for the listing item." + }, + { + "value": "procurement", + "description": "Vendor procurement details for the listing item. " + } + ] + }, + "default": "[\"summaries\"]" + }, + "example": "summaries" + }, + { + "name": "issueLocale", + "in": "query", + "description": "A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale.", + "schema": { + "type": "string" + }, + "example": "en_US" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ItemSearchResults" + }, + "example": { + "numberOfResults": 3, + "pagination": { + "nextToken": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234", + "previousToken": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d" + }, + "items": [ + { + "sku": "GM-ZDPI-9B4E", + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "asin": "B071VG5N9D", + "productType": "LUGGAGE", + "conditionType": "new_new", + "status": [ + "BUYABLE" + ], + "itemName": "Hardside Carry-On Spinner Suitcase Luggage", + "createdDate": "2021-02-01T00:00:00Z", + "lastUpdatedDate": "2021-03-01T00:00:00Z", + "mainImage": { + "link": "https://www.example.com/luggage.png", + "height": 500, + "width": 500 + } + } + ], + "attributes": { + "total_hdmi_ports": [ + { + "value": 4, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "resolution": [ + { + "language_tag": "en_US", + "value": "4K", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_weight": [ + { + "unit": "pounds", + "value": 107.6, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "product_subcategory": [ + { + "value": "50400120", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "bullet_point": [ + { + "language_tag": "en_US", + "value": "SMART TV WITH UNIVERSAL GUIDE: Simple on-screen Guide is an easy way to find streaming content and live TV shows", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "100% COLOR VOLUME WITH QUANTUM DOTS: Powered by Quantum dots, Samsung\u2019s 4K QLED TV offers over a billion shades of brilliant color and 100% color volume for exceptional depth of detail that will draw you in to the picture for the best 4K TV experience", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "QUANTUM PROCESSOR 4K: Intelligently powered processor instantly upscales content to 4K for sharp detail and refined color", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "QUANTUM HDR 4X: 4K depth of detail with high dynamic range powered by HDR10+ delivers the lightest to darkest colors, scene by scene, for amazing picture realism", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "AMBIENT MODE: Customizes and complements your living space by turning a blank screen of this big screen TV into enticing visuals including d\u00e9cor, info, photos and artwork", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "SMART TV FEATURES: OneRemote to control all compatible devices, Bixby voice command, on-screen universal guide, SmartThings to control compatible home appliances and devices, smart speaker expandability with Alexa and Google Assistant compatibility, and more", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_dimensions": [ + { + "width": { + "unit": "inches", + "value": 72.4 + }, + "length": { + "unit": "inches", + "value": 2.4 + }, + "height": { + "unit": "inches", + "value": 41.4 + }, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "brand": [ + { + "language_tag": "en_US", + "value": "SAMSUNG", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "generic_keyword": [ + { + "language_tag": "en_US", + "value": "oled 65 inch smart tv qled 75 inch tv 85 inch 4k tv smart tv 4k tv 65 inch qled 82 inch tv 8k tv oled 65 smart tv qled 65 inch 80 inch tv 4k 4k tv shield tv 2018", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "q9fn qled 2018 oled 4k 4k oled toshiba antenna dvd player outdoor tv kitchen tv fire tv firetv hdtv hd tv android shield tv gaming deals tv ears dvr speakers digital tv antenna tv android tv frame mount", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "4k hdr tv 70 tv shield tv 90 inch tv gaming tv 75 tv 65 inch 4k tv tv 65 inch smart tv 4k 65 inch 4k tv 65 inch 4k tv 4k tv uhd tv uhd tv 4k", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "smart tv 4k tv tv tv oled tv 65 inch smart tv 4k tv 65 inch smart tv shield tv 2018 tv 4k oled tv 65 4k tv 4k smart tv 4k hdr tv shield tv gaming tv 65 inch 4k tv tv 65 inch smart tv 4k 65 inch 4k tv 65 inch 4k tv 4k tv uhd tv uhd tv 4k", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "control_method": [ + { + "value": "voice", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_package_dimensions": [ + { + "length": { + "unit": "centimeters", + "value": 26.67 + }, + "width": { + "unit": "centimeters", + "value": 121.92 + }, + "height": { + "unit": "centimeters", + "value": 203.2 + }, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "image_aspect_ratio": [ + { + "language_tag": "en_US", + "value": "16:9", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "part_number": [ + { + "value": "QN82Q60RAFXZA", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "includes_remote": [ + { + "value": true, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "style": [ + { + "language_tag": "en_US", + "value": "TV only", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_type_name": [ + { + "language_tag": "en_US", + "value": "TV", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "battery": [ + { + "cell_composition": [ + { + "value": "alkaline" + } + ], + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "image_contrast_ratio": [ + { + "language_tag": "en_US", + "value": "QLED 4K", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "manufacturer": [ + { + "language_tag": "en_US", + "value": "Samsung", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "number_of_boxes": [ + { + "value": 1, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "total_usb_ports": [ + { + "value": 2, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "model_number": [ + { + "value": "QN82Q60RAFXZA", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "supplier_declared_dg_hz_regulation": [ + { + "value": "not_applicable", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "num_batteries": [ + { + "quantity": 2, + "type": "aaa", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "california_proposition_65": [ + { + "compliance_type": "on_product_combined_cancer_reproductive", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "compliance_type": "chemical", + "chemical_names": [ + "di_2_ethylhexyl_phthalate_dehp" + ], + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "display": [ + { + "resolution_maximum": [ + { + "unit": "pixels", + "language_tag": "en_US", + "value": "3840 x 2160" + } + ], + "size": [ + { + "unit": "inches", + "value": 82 + } + ], + "type": [ + { + "language_tag": "en_US", + "value": "QLED" + } + ], + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_name": [ + { + "language_tag": "en_US", + "value": "Samsung QN82Q60RAFXZA Flat 82-Inch QLED 4K Q60 Series (2019) Ultra HD Smart TV with HDR and Alexa Compatibility", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "list_price": [ + { + "currency": "USD", + "value": 3799.99, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "batteries_required": [ + { + "value": false, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "includes_rechargable_battery": [ + { + "value": false, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "product_site_launch_date": [ + { + "value": "2019-03-11T08:00:01.000Z", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "product_category": [ + { + "value": "50400100", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "batteries_included": [ + { + "value": false, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "connectivity_technology": [ + { + "language_tag": "en_US", + "value": "Bluetooth", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "USB", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Wireless", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "HDMI", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "included_components": [ + { + "language_tag": "en_US", + "value": "QLED Standard Smart Remote", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Power Cable", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Stand", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Samsung Smart Control", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "specification_met": [ + { + "language_tag": "en_US", + "value": "", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "parental_control_technology": [ + { + "value": "V-Chip", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "power_consumption": [ + { + "unit": "watts", + "value": 120, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "cpsia_cautionary_statement": [ + { + "value": "no_warning_applicable", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_type_keyword": [ + { + "value": "qled-televisions", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "number_of_items": [ + { + "value": 1, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "warranty_description": [ + { + "language_tag": "en_US", + "value": "1 year manufacturer", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "max_resolution": [ + { + "unit": "pixels", + "value": 8.3, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "color": [ + { + "language_tag": "en_US", + "value": "Black", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "screen_surface_description": [ + { + "language_tag": "en_US", + "value": "Flat", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_package_weight": [ + { + "unit": "kilograms", + "value": 62.142, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "speaker_type": [ + { + "language_tag": "en_US", + "value": "2CH", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "supported_internet_services": [ + { + "language_tag": "en_US", + "value": "Amazon Instant Video", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "YouTube", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Netflix", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Hulu", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Browser", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "tuner_technology": [ + { + "language_tag": "en_US", + "value": "Analog Tuner", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "controller_type": [ + { + "language_tag": "en_US", + "value": "SmartThings", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Voice Control", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "special_feature": [ + { + "language_tag": "en_US", + "value": "100% Color Volume with Quantum Dot; Quantum Processor 4K; Ambient Mode; Quantum HDR 4X; Real Game Enhancer", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "wireless_communication_technology": [ + { + "language_tag": "en_US", + "value": "Wi-Fi::Wi-Fi Direct::Bluetooth", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "model_year": [ + { + "value": 2019, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "power_source_type": [ + { + "language_tag": "en_US", + "value": "Corded Electric", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "street_date": [ + { + "value": "2019-03-21T00:00:01Z", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "mounting_type": [ + { + "language_tag": "en_US", + "value": "Table Mount", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Wall Mount", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "refresh_rate": [ + { + "unit": "hertz", + "language_tag": "en_US", + "value": "120", + "marketplace_id": "ATVPDKIKX0DER" + } + ] + }, + "offers": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "offerType": "B2C", + "price": { + "currencyCode": "USD", + "amount": "100.00" + } + } + ], + "fulfillmentAvailability": [ + { + "fulfillmentChannelCode": "DEFAULT", + "quantity": 100 + } + ], + "issues": [ + { + "code": "90220", + "message": "'size' is required but not supplied.", + "severity": "ERROR", + "attributeNames": [ + "size" + ], + "categories": [ + "MISSING_ATTRIBUTE" + ] + }, + { + "code": "18027", + "message": "We believe the main image has text, logo, graphic or watermark which is not permitted for this product type. Please submit a compliant image to lift the suppression. Also refer to Product image requirements.", + "severity": "ERROR", + "categories": [ + "INVALID_IMAGE" + ], + "enforcements": { + "actions": [ + { + "action": "SEARCH_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT_UNTIL_EXPIRY_DATE", + "expiryDate": "2025-05-28T00:36:48.914Z" + } + } + }, + { + "code": "99300", + "message": "Product Detail Page Rules Violation (Inaccurate information on product detail page)", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "ATTRIBUTE_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT" + } + } + }, + { + "code": "18155", + "message": "The 'minimum price' is greater than the selling price (excluding shipping) for the listing. Please review and update your price and/or minimum price.", + "severity": "ERROR", + "categories": [ + "INVALID_PRICE" + ], + "enforcements": { + "actions": [ + { + "action": "LISTING_SUPPRESSED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + }, + { + "code": "18742", + "message": "Restricted Products Policy Violation", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "CATALOG_ITEM_REMOVED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + } + ] + } + ] + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "identifiersType": { + "value": "SKU" + }, + "identifiers": { + "value": [ + "GM-ZDPI-9B4E", + "HW-ZDPI-9B4E", + "TC-ZDPI-9B4E" + ] + }, + "marketplaceIds": { + "value": [ + "ATVPDKIKX0DER" + ] + }, + "includedData": { + "value": [ + "summaries", + "offers", + "fulfillmentAvailability", + "issues" + ] + }, + "pageSize": { + "value": 1 + } + } + }, + "response": { + "numberOfResults": 3, + "pagination": { + "nextToken": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234", + "previousToken": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d" + }, + "items": [ + { + "sku": "GM-ZDPI-9B4E", + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "asin": "B071VG5N9D", + "productType": "LUGGAGE", + "conditionType": "new_new", + "status": [ + "BUYABLE" + ], + "itemName": "Hardside Carry-On Spinner Suitcase Luggage", + "createdDate": "2021-02-01T00:00:00Z", + "lastUpdatedDate": "2021-03-01T00:00:00Z", + "mainImage": { + "link": "https://www.example.com/luggage.png", + "height": 500, + "width": 500 + } + } + ], + "offers": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "offerType": "B2C", + "price": { + "currencyCode": "USD", + "amount": "100.00" + } + } + ], + "fulfillmentAvailability": [ + { + "fulfillmentChannelCode": "DEFAULT", + "quantity": 100 + } + ], + "issues": [ + { + "code": "90220", + "message": "'size' is required but not supplied.", + "severity": "ERROR", + "attributeNames": [ + "size" + ], + "categories": [ + "MISSING_ATTRIBUTE" + ] + }, + { + "code": "18027", + "message": "We believe the main image has text, logo, graphic or watermark which is not permitted for this product type. Please submit a compliant image to lift the suppression. Also refer to Product image requirements.", + "severity": "ERROR", + "categories": [ + "INVALID_IMAGE" + ], + "enforcements": { + "actions": [ + { + "action": "SEARCH_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT_UNTIL_EXPIRY_DATE", + "expiryDate": "2025-05-28T00:36:48.914Z" + } + } + }, + { + "code": "99300", + "message": "Product Detail Page Rules Violation (Inaccurate information on product detail page)", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "ATTRIBUTE_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT" + } + } + }, + { + "code": "18155", + "message": "The 'minimum price' is greater than the selling price (excluding shipping) for the listing. Please review and update your price and/or minimum price.", + "severity": "ERROR", + "categories": [ + "INVALID_PRICE" + ], + "enforcements": { + "actions": [ + { + "action": "LISTING_SUPPRESSED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + }, + { + "code": "18742", + "message": "Restricted Products Policy Violation", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "CATALOG_ITEM_REMOVED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + } + ] + } + ] + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "sellerId": { + "value": "SellerId" + }, + "marketplaceIds": { + "value": [ + "invalid" + ] + } + } + }, + "response": { + "errors": [ + { + "code": "BAD_REQUEST", + "message": "Invalid input", + "details": "Invalid input" + } + ] + } + } + ] + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorList" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "Error": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An error code that identifies the type of error that occurred." + }, + "message": { + "type": "string", + "description": "A message that describes the error condition." + }, + "details": { + "type": "string", + "description": "Additional details that can help the caller understand or fix the issue." + } + }, + "description": "Error response returned when the request is unsuccessful." + }, + "ErrorList": { + "required": [ + "errors" + ], + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "A list of error responses returned when a request is unsuccessful." + }, + "ItemSearchResults": { + "required": [ + "items", + "numberOfResults" + ], + "type": "object", + "properties": { + "numberOfResults": { + "type": "integer", + "description": "The total number of selling partner listings items found for the search criteria (only results up to the page count limit will be returned per request regardless of the number found).\n\nNote: The maximum number of items (SKUs) that can be returned and paged through is 1000." + }, + "pagination": { + "$ref": "#/components/schemas/Pagination" + }, + "items": { + "type": "array", + "description": "A list of listings items.", + "items": { + "$ref": "#/components/schemas/Item" + } + } + }, + "description": "Selling partner listings items and search related metadata." + }, + "Item": { + "required": [ + "sku" + ], + "type": "object", + "properties": { + "sku": { + "type": "string", + "description": "A selling partner provided identifier for an Amazon listing." + }, + "summaries": { + "$ref": "#/components/schemas/ItemSummaries" + }, + "attributes": { + "$ref": "#/components/schemas/ItemAttributes" + }, + "issues": { + "$ref": "#/components/schemas/ItemIssues" + }, + "offers": { + "$ref": "#/components/schemas/ItemOffers" + }, + "fulfillmentAvailability": { + "type": "array", + "description": "The fulfillment availability for the listings item.", + "items": { + "$ref": "#/components/schemas/FulfillmentAvailability" + } + }, + "procurement": { + "type": "array", + "description": "The vendor procurement information for the listings item.", + "items": { + "$ref": "#/components/schemas/ItemProcurement" + } + } + }, + "description": "A listings item." + }, + "ItemSummaries": { + "type": "array", + "description": "Summary details of a listings item.", + "items": { + "$ref": "#/components/schemas/ItemSummaryByMarketplace" + } + }, + "ItemSummaryByMarketplace": { + "required": [ + "asin", + "createdDate", + "itemName", + "lastUpdatedDate", + "marketplaceId", + "productType", + "status" + ], + "type": "object", + "properties": { + "marketplaceId": { + "type": "string", + "description": "A marketplace identifier. Identifies the Amazon marketplace for the listings item." + }, + "asin": { + "type": "string", + "description": "Amazon Standard Identification Number (ASIN) of the listings item." + }, + "productType": { + "type": "string", + "description": "The Amazon product type of the listings item." + }, + "conditionType": { + "type": "string", + "description": "Identifies the condition of the listings item.", + "enum": [ + "new_new", + "new_open_box", + "new_oem", + "refurbished_refurbished", + "used_like_new", + "used_very_good", + "used_good", + "used_acceptable", + "collectible_like_new", + "collectible_very_good", + "collectible_good", + "collectible_acceptable", + "club_club" + ], + "x-docgen-enum-table-extension": [ + { + "value": "new_new", + "description": "New." + }, + { + "value": "new_open_box", + "description": "New - Open Box." + }, + { + "value": "new_oem", + "description": "New - OEM." + }, + { + "value": "refurbished_refurbished", + "description": "Refurbished." + }, + { + "value": "used_like_new", + "description": "Used - Like New." + }, + { + "value": "used_very_good", + "description": "Used - Very Good." + }, + { + "value": "used_good", + "description": "Used - Good." + }, + { + "value": "used_acceptable", + "description": "Used - Acceptable." + }, + { + "value": "collectible_like_new", + "description": "Collectible - Like New." + }, + { + "value": "collectible_very_good", + "description": "Collectible - Very Good." + }, + { + "value": "collectible_good", + "description": "Collectible - Good." + }, + { + "value": "collectible_acceptable", + "description": "Collectible - Acceptable." + }, + { + "value": "club_club", + "description": "Club." + } + ] + }, + "status": { + "type": "array", + "description": "Statuses that apply to the listings item.", + "items": { + "type": "string", + "enum": [ + "BUYABLE", + "DISCOVERABLE" + ], + "x-docgen-enum-table-extension": [ + { + "value": "BUYABLE", + "description": "The listings item can be purchased by shoppers. This status does not apply to vendor listings." + }, + { + "value": "DISCOVERABLE", + "description": "The listings item is visible to shoppers." + } + ] + } + }, + "fnSku": { + "type": "string", + "description": "The fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item." + }, + "itemName": { + "type": "string", "description": "The name or title associated with an Amazon catalog item." }, "createdDate": { @@ -2089,6 +3365,9 @@ }, "points": { "$ref": "#/components/schemas/Points" + }, + "audience": { + "$ref": "#/components/schemas/Audience" } }, "description": "Offer details of a listings item for an Amazon marketplace." @@ -2156,6 +3435,21 @@ }, "description": "The number of Amazon Points offered with the purchase of an item, and their monetary value. Note that the `Points` element is only returned in Japan (JP)." }, + "Audience": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Name of the audience an offer is applicable to. \n\nCommon values: \n\n* 'ALL' - Standard offer audience for buyers on Amazon retail websites. \n\n* 'B2B' - Offer audience for Amazon Business website buyers.", + "example": "ALL" + }, + "displayName": { + "type": "string", + "description": "Localized display name for the audience." + } + }, + "description": "Buyer segment or program this offer is applicable to." + }, "PatchOperation": { "required": [ "op", @@ -2337,6 +3631,20 @@ } }, "description": "Identity attributes associated with the item in the Amazon catalog for the indicated Amazon marketplace." + }, + "Pagination": { + "type": "object", + "properties": { + "nextToken": { + "type": "string", + "description": "A token that can be used to fetch the next page." + }, + "previousToken": { + "type": "string", + "description": "A token that can be used to fetch the previous page." + } + }, + "description": "When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there will be no `nextToken` key in the pagination object." } } }, diff --git a/resources/models/seller/orders/v0.json b/resources/models/seller/orders/v0.json index 441ea3b07..991167cb6 100644 --- a/resources/models/seller/orders/v0.json +++ b/resources/models/seller/orders/v0.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "Selling Partner API for Orders", - "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. The Orders API supports orders that are two years old or less. Orders more than two years old will not show in the API response.\n\n**Note:** The Orders API supports orders from 2016 and after for the JP, AU, and SG marketplaces.", + "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).", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" @@ -24,13 +24,13 @@ "tags": [ "OrdersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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": "A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in ISO 8601 format.\n\n**Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. You could specify `CreatedBefore` but not provide `LastUpdatedAfter` or `LastUpdatedBefore` when `CreatedAfter` is specified.", + "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.", "schema": { "type": "string" } @@ -38,7 +38,7 @@ { "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.\n\n**Note**: `CreatedBefore` is optional when `CreatedAfter` is specified. But if specified, `CreatedBefore` should be equal to or after the `CreatedAfter` date and at least 2 minutes before the current time.", + "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.", "schema": { "type": "string" } @@ -46,7 +46,7 @@ { "name": "LastUpdatedAfter", "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.\n\n**Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is specified. But if specified, `LastUpdatedBefore` should be equal to or after the `LastUpdatedAfter` date and at least 2 minutes before current time.", + "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.", "schema": { "type": "string" } @@ -54,7 +54,7 @@ { "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.\n\n**Note**: LastUpdatedBefore is optional when LastUpdatedAfter is set. But if specified, LastUpdatedBefore should be equal to or after the LastUpdatedAfter date and at least 2 minutes before current time.", + "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.", "schema": { "type": "string" } @@ -75,7 +75,7 @@ { "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.", + "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, "style": "form", "explode": false, @@ -90,7 +90,7 @@ { "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` (Fulfillment by Amazon); `MFN` (Fulfilled by the seller).", + "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).", "style": "form", "explode": false, "schema": { @@ -103,7 +103,7 @@ { "name": "PaymentMethods", "in": "query", - "description": "A list of payment method values. Used to select orders paid using the specified payment methods.\n\n**Possible values**: `COD` (Cash on delivery); `CVS` (Convenience store payment); `Other` (Any payment method other than `COD` or `CVS`).", + "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).", "style": "form", "explode": false, "schema": { @@ -124,7 +124,7 @@ { "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.", + "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.", "schema": { "type": "string" } @@ -174,7 +174,7 @@ { "name": "AmazonOrderIds", "in": "query", - "description": "A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.", + "description": "A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.", "style": "form", "explode": false, "schema": { @@ -188,7 +188,7 @@ { "name": "ActualFulfillmentSupplySourceId", "in": "query", - "description": "Denotes the recommended sourceId where the order should be fulfilled from.", + "description": "The `sourceId` of the location from where you want the order fulfilled.", "schema": { "type": "string" } @@ -212,7 +212,7 @@ { "name": "EarliestDeliveryDateBefore", "in": "query", - "description": "A date used for selecting orders with a earliest delivery date before (or at) a specified time. The date must be in ISO 8601 format.", + "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.", "schema": { "type": "string" } @@ -220,7 +220,7 @@ { "name": "EarliestDeliveryDateAfter", "in": "query", - "description": "A date used for selecting orders with a earliest delivery date after (or at) a specified time. The date must be in ISO 8601 format.", + "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.", "schema": { "type": "string" } @@ -228,7 +228,7 @@ { "name": "LatestDeliveryDateBefore", "in": "query", - "description": "A date used for selecting orders with a latest delivery date before (or at) a specified time. The date must be in ISO 8601 format.", + "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.", "schema": { "type": "string" } @@ -236,7 +236,7 @@ { "name": "LatestDeliveryDateAfter", "in": "query", - "description": "A date used for selecting orders with a latest delivery date after (or at) a specified time. The date must be in ISO 8601 format.", + "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.", "schema": { "type": "string" } @@ -679,7 +679,7 @@ "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 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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": [ { @@ -1059,7 +1059,7 @@ "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 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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": [ { @@ -1277,7 +1277,7 @@ "tags": [ "OrdersV0" ], - "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.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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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.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": "getOrderAddress", "parameters": [ { @@ -1505,7 +1505,7 @@ "tags": [ "OrdersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "getOrderItems", "parameters": [ { @@ -1848,7 +1848,7 @@ "tags": [ "OrdersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "getOrderItemsBuyerInfo", "parameters": [ { @@ -2088,7 +2088,7 @@ "tags": [ "OrdersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "updateShipmentStatus", "parameters": [ { @@ -2181,7 +2181,7 @@ "errors": [ { "code": "InvalidInput", - "message": "Marketplace id is not defined", + "message": "Marketplace ID is not defined", "details": "1001" } ] @@ -2331,7 +2331,7 @@ "tags": [ "OrdersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "getOrderRegulatedInfo", "parameters": [ { @@ -2418,6 +2418,191 @@ } } } + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-2592119-3531015" + } + } + }, + "response": { + "payload": { + "AmazonOrderId": "902-2592119-3531015", + "RequiresDosageLabel": false, + "RegulatedInformation": { + "Fields": [ + { + "FieldId": "pets_rx_scName", + "FieldLabel": "Pet name", + "FieldType": "Text", + "FieldValue": "Woofer" + }, + { + "FieldId": "pets_rx_scType", + "FieldLabel": "Pet type", + "FieldType": "Text", + "FieldValue": "Dog" + }, + { + "FieldId": "pets_rx_scBreed", + "FieldLabel": "Pet breed", + "FieldType": "Text", + "FieldValue": "Husky" + }, + { + "FieldId": "pets_rx_scGender", + "FieldLabel": "Pet gender", + "FieldType": "Text", + "FieldValue": "Female" + }, + { + "FieldId": "pets_rx_scDateOfBirth", + "FieldLabel": "Pet Birth Date", + "FieldType": "Text", + "FieldValue": "2016-05-01" + }, + { + "FieldId": "pets_rx_scWeight", + "FieldLabel": "Weight", + "FieldType": "Text", + "FieldValue": "12" + }, + { + "FieldId": "pets_rx_scWeightUnit", + "FieldLabel": "Weight Unit", + "FieldType": "Text", + "FieldValue": "Pound" + }, + { + "FieldId": "pets_rx_scHasAllergies", + "FieldLabel": "Does your pet have allergies?", + "FieldType": "Text", + "FieldValue": "False" + }, + { + "FieldId": "pets_rx_scTakesAdditionalMedications", + "FieldLabel": "Is your pet on any other medication?", + "FieldType": "Text", + "FieldValue": "False" + }, + { + "FieldId": "pets_rx_scHasOtherProblems", + "FieldLabel": "Any pet health problems?", + "FieldType": "Text", + "FieldValue": "False" + }, + { + "FieldId": "pets_rx_scSourceClinicId", + "FieldLabel": "Source Clinic ID", + "FieldType": "Text", + "FieldValue": "Clinic-1234" + }, + { + "FieldId": "pets_rx_scVetClinicName", + "FieldLabel": "Vet Clinic Name", + "FieldType": "Text", + "FieldValue": "Test Clinic" + }, + { + "FieldId": "pets_rx_scVetClinicCity", + "FieldLabel": "Vet Clinic City", + "FieldType": "Text", + "FieldValue": "Seattle" + }, + { + "FieldId": "pets_rx_scVetClinicState", + "FieldLabel": "Vet Clinic State", + "FieldType": "Text", + "FieldValue": "WA" + }, + { + "FieldId": "pets_rx_scVetClinicZipCode", + "FieldLabel": "Vet Clinic Zip Code", + "FieldType": "Text", + "FieldValue": "98000" + }, + { + "FieldId": "pets_rx_scVetClinicPhoneNumber", + "FieldLabel": "Vet Clinic Phone Number", + "FieldType": "Text", + "FieldValue": "2060000000" + } + ] + }, + "RegulatedOrderVerificationStatus": { + "Status": "Pending", + "RequiresMerchantAction": true, + "ValidRejectionReasons": [ + { + "RejectionReasonId": "pets_rx_sc_incorrect_product", + "RejectionReasonDescription": "Canceled order due to veterinarian indicating wrong product ordered" + }, + { + "RejectionReasonId": "pets_rx_sc_no_vcpr", + "RejectionReasonDescription": "Canceled order due to veterinarian indicating they do not have you as their client" + }, + { + "RejectionReasonId": "pets_rx_sc_visit_required", + "RejectionReasonDescription": "Canceled order due to veterinarian indicating they need to see your pet for an appointment" + }, + { + "RejectionReasonId": "pets_rx_sc_wrx_required", + "RejectionReasonDescription": "Canceled order due to veterinarian policy requiring you pick up a written prescription and mail to pharmacy" + }, + { + "RejectionReasonId": "pets_rx_sc_other", + "RejectionReasonDescription": "Canceled order due to prescription denied - contact your vetinarian" + }, + { + "RejectionReasonId": "pets_rx_sc_therapy_change", + "RejectionReasonDescription": "Canceled order due to a change in therapy, follow up with your veterinarian" + }, + { + "RejectionReasonId": "pets_rx_sc_wrong_weight", + "RejectionReasonDescription": "Canceled order due to incorrect pet weight on file, update weight and replace order or order correct product" + }, + { + "RejectionReasonId": "pets_rx_sc_early_refill", + "RejectionReasonDescription": "Canceled due to refilling prescription order too soon" + }, + { + "RejectionReasonId": "pets_rx_sc_wrong_species", + "RejectionReasonDescription": "Canceled due to ordering for wrong pet species, replace order for correct product" + }, + { + "RejectionReasonId": "pets_rx_sc_duplicate", + "RejectionReasonDescription": "Canceled due to duplicate order identified" + }, + { + "RejectionReasonId": "pets_rx_sc_invalid_rx", + "RejectionReasonDescription": "Canceled due to not receiving a valid prescription" + }, + { + "RejectionReasonId": "pets_rx_sc_address_validation_error", + "RejectionReasonDescription": "Canceled due to a non-verified address, correct address and replace order" + }, + { + "RejectionReasonId": "pets_rx_sc_no_clinic_match", + "RejectionReasonDescription": "Canceled due to no valid clinic match, provide complete and accurate details for vet clinic and replace order" + }, + { + "RejectionReasonId": "pets_rx_sc_pharmacist_canceled", + "RejectionReasonDescription": "Order canceled by pharmacy" + } + ], + "ValidVerificationDetails": [ + { + "VerificationDetailType": "prescriptionDetail", + "ValidVerificationStatuses": [ + "Approved" + ] + } + ] + } + } + } } ] } @@ -2569,7 +2754,7 @@ "tags": [ "OrdersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "updateVerificationStatus", "parameters": [ { @@ -2631,6 +2816,34 @@ } }, "response": {} + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "externalReviewerId": "reviewer1234", + "verificationDetails": { + "prescriptionDetail": { + "prescriptionId": "Rx-1234", + "expirationDate": "2024-01-01T00:00:00Z", + "writtenQuantity": 3, + "totalRefillsAuthorized": 10, + "usageInstructions": "Take one per day by mouth with food", + "refillsRemaining": 10, + "clinicId": "ABC-1234" + } + } + } + } + } + } + }, + "response": {} } ] } @@ -2712,6 +2925,80 @@ } ] } + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "status": "Rejected", + "rejectionReasonId": "shield_pom_vps_reject_incorrect_weight", + "verificationDetails": { + "prescriptionDetail": { + "prescriptionId": "Rx-1234", + "expirationDate": "2024-01-01T00:00:00Z", + "writtenQuantity": 3, + "totalRefillsAuthorized": 10, + "usageInstructions": "Take one per day by mouth with food", + "refillsRemaining": 10, + "clinicId": "ABC-1234" + } + } + } + } + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Verification Detail `prescriptionDetail` is not supported when order is in Rejected status." + }, + { + "code": "InvalidInput", + "message": "Missing request parameter: externalReviewerId." + } + ] + } + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "externalReviewerId": "reviewer1234", + "verificationDetails": { + "prescriptionDetail": { + "prescriptionId": "Rx-1234", + "expirationDate": "2024-01-01T00:00:00Z", + "writtenQuantity": 3, + "totalRefillsAuthorized": 10, + "usageInstructions": "Take one per day by mouth with food", + "refillsRemaining": 10 + } + } + } + } + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Missing required parameter(s) from prescriptionDetail value: clinicId" + } + ] + } } ] } @@ -2857,7 +3144,7 @@ "tags": [ "OrdersV0" ], - "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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "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 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": "confirmShipment", "parameters": [ { @@ -2871,7 +3158,7 @@ } ], "requestBody": { - "description": "The request body of the `confirmShipment` operation.", + "description": "Request body of `confirmShipment`.", "content": { "application/json": { "schema": { @@ -3159,8 +3446,7 @@ }, "UpdateVerificationStatusRequestBody": { "required": [ - "externalReviewerId", - "status" + "externalReviewerId" ], "type": "object", "properties": { @@ -3169,11 +3455,14 @@ }, "externalReviewerId": { "type": "string", - "description": "The identifier for the order's regulated information reviewer." + "description": "The identifier of the order's regulated information reviewer." }, "rejectionReasonId": { "type": "string", - "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": "The unique identifier of the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected." + }, + "verificationDetails": { + "$ref": "#/components/schemas/VerificationDetails" } }, "description": "The updated values of the `VerificationStatus` field." @@ -3213,7 +3502,7 @@ "properties": { "orderItemId": { "type": "string", - "description": "The unique identifier of the order item." + "description": "The order item's unique identifier." }, "quantity": { "type": "integer", @@ -3339,11 +3628,11 @@ }, "LastUpdatedBefore": { "type": "string", - "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": "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. All dates must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "CreatedBefore": { "type": "string", - "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": "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." } }, "description": "A list of orders along with additional information to make subsequent API calls." @@ -3378,7 +3667,7 @@ }, "LastUpdateDate": { "type": "string", - "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 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." }, "OrderStatus": { "type": "string", @@ -3396,7 +3685,7 @@ "x-docgen-enum-table-extension": [ { "value": "Pending", - "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." + "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", @@ -3424,13 +3713,13 @@ }, { "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": "This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date for the item is in the future. The order is not ready for shipment." } ] }, "FulfillmentChannel": { "type": "string", - "description": "Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN).", + "description": "Whether the order was fulfilled by Amazon (`AFN`) or by the seller (`MFN`).", "enum": [ "MFN", "AFN" @@ -3448,15 +3737,15 @@ }, "SalesChannel": { "type": "string", - "description": "The sales channel of the first item in the order." + "description": "The sales channel for the first item in the order." }, "OrderChannel": { "type": "string", - "description": "The order channel of the first item in the order." + "description": "The order channel for the first item in the order." }, "ShipServiceLevel": { "type": "string", - "description": "The shipment service level of the order." + "description": "The order's shipment service level." }, "OrderTotal": { "$ref": "#/components/schemas/Money" @@ -3474,7 +3763,7 @@ }, "PaymentMethod": { "type": "string", - "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": "The payment method for the order. This property is limited to COD and 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.", "enum": [ "COD", "CVS", @@ -3504,7 +3793,7 @@ }, "ShipmentServiceLevelCategory": { "type": "string", - "description": "The shipment service level category of the order.\n\n**Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, `Standard`." + "description": "The shipment service level category for the order.\n\n**Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, and `Standard`." }, "EasyShipShipmentStatus": { "$ref": "#/components/schemas/EasyShipShipmentStatus" @@ -3515,7 +3804,7 @@ }, "OrderType": { "type": "string", - "description": "The type of the order.", + "description": "The order's type.", "enum": [ "StandardOrder", "LongLeadTimeOrder", @@ -3548,19 +3837,19 @@ }, "EarliestShipDate": { "type": "string", - "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 start of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders.\n\n__Note__: `EarliestShipDate` might not be returned for orders placed before February 1, 2013." }, "LatestShipDate": { "type": "string", - "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 end of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders.\n\n__Note__: `LatestShipDate` might not be returned for orders placed before February 1, 2013." }, "EarliestDeliveryDate": { "type": "string", - "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 start of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders." }, "LatestDeliveryDate": { "type": "string", - "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": "The end of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders that do not have a `PendingAvailability`, `Pending`, or `Canceled` status." }, "IsBusinessOrder": { "type": "boolean", @@ -3572,15 +3861,15 @@ }, "IsPremiumOrder": { "type": "boolean", - "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": "When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, refer to \"Premium Shipping Options\" in the Seller Central Help for your marketplace." }, "IsGlobalExpressEnabled": { "type": "boolean", - "description": "When true, the order is a GlobalExpress order." + "description": "When true, the order is a `GlobalExpress` order." }, "ReplacedOrderId": { "type": "string", - "description": "The order ID value for the order that is being replaced. Returned only if `IsReplacementOrder` = true." + "description": "The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true." }, "IsReplacementOrder": { "type": "boolean", @@ -3588,11 +3877,11 @@ }, "PromiseResponseDueDate": { "type": "string", - "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": "Indicates the date by which the seller must respond to the buyer with an estimated ship date. Only returned for Sourcing on Demand orders." }, "IsEstimatedShipDateSet": { "type": "boolean", - "description": "When true, the estimated ship date is specified for the order. Returned only for Sourcing on Demand orders." + "description": "When true, the estimated ship date is set for the order. Only returned for Sourcing on Demand orders." }, "IsSoldByAB": { "type": "boolean", @@ -3615,11 +3904,11 @@ "x-docgen-enum-table-extension": [ { "value": "INDIVIDUAL", - "description": "Buyer should be issued an individual invoice." + "description": "Issues an individual invoice to the buyer." }, { "value": "BUSINESS", - "description": "Buyer should be issued a business invoice. Tax information is available in `BuyerTaxInformation` structure." + "description": "Issues a business invoice to the buyer. Tax information is available in `BuyerTaxInformation`." } ] }, @@ -3690,7 +3979,7 @@ }, "PurchaseOrderNumber": { "type": "string", - "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 purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } }, "description": "Buyer information for an order." @@ -3748,14 +4037,21 @@ }, "ReviewDate": { "type": "string", - "description": "The date the order was reviewed. In ISO 8601 date time format." + "description": "The date the order was reviewed. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format." }, "ExternalReviewerId": { "type": "string", "description": "The identifier for the order's regulated information reviewer." + }, + "ValidVerificationDetails": { + "type": "array", + "description": "A list of valid verification details that may be provided and the criteria required for when the verification detail can be provided.", + "items": { + "$ref": "#/components/schemas/ValidVerificationDetail" + } } }, - "description": "The verification status of the order along with associated approval or rejection metadata." + "description": "The verification status of the order, along with associated approval or rejection metadata." }, "RejectionReason": { "required": [ @@ -3773,7 +4069,84 @@ "description": "The description of this rejection reason." } }, - "description": "The reason for rejecting the order's regulated information. Not present if the order isn't rejected." + "description": "The reason for rejecting the order's regulated information. This is only present if the order is rejected." + }, + "PrescriptionDetail": { + "required": [ + "clinicId", + "expirationDate", + "prescriptionId", + "refillsRemaining", + "totalRefillsAuthorized", + "usageInstructions", + "writtenQuantity" + ], + "type": "object", + "properties": { + "prescriptionId": { + "type": "string", + "description": "The identifier for the prescription used to verify the regulated product." + }, + "expirationDate": { + "type": "string", + "description": "The expiration date of the prescription used to verify the regulated product, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.", + "format": "date-time" + }, + "writtenQuantity": { + "minimum": 1, + "type": "integer", + "description": "The number of units in each fill as provided in the prescription." + }, + "totalRefillsAuthorized": { + "minimum": 0, + "type": "integer", + "description": "The total number of refills written in the original prescription used to verify the regulated product. If a prescription originally had no refills, this value must be 0." + }, + "refillsRemaining": { + "minimum": 0, + "type": "integer", + "description": "The number of refills remaining for the prescription used to verify the regulated product. If a prescription originally had 10 total refills, this value must be `10` for the first order, `9` for the second order, and `0` for the eleventh order. If a prescription originally had no refills, this value must be 0." + }, + "clinicId": { + "type": "string", + "description": "The identifier for the clinic which provided the prescription used to verify the regulated product." + }, + "usageInstructions": { + "type": "string", + "description": "The instructions for the prescription as provided by the approver of the regulated product." + } + }, + "description": "Information about the prescription that is used to verify a regulated product. This must be provided once per order and reflect the seller\u2019s own records. Only approved orders can have prescriptions." + }, + "ValidVerificationDetail": { + "required": [ + "ValidVerificationStatuses", + "VerificationDetailType" + ], + "type": "object", + "properties": { + "VerificationDetailType": { + "type": "string", + "description": "A supported type of verification detail. The type indicates which verification detail could be shared while updating the regulated order. Valid value: `prescriptionDetail`." + }, + "ValidVerificationStatuses": { + "type": "array", + "description": "A list of valid verification statuses where the associated verification detail type may be provided. For example, if the value of this field is [\"Approved\"], calls to provide the associated verification detail will fail for orders with a `VerificationStatus` of `Pending`, `Rejected`, `Expired`, or `Cancelled`.", + "items": { + "$ref": "#/components/schemas/VerificationStatus" + } + } + }, + "description": "The types of verification details that may be provided for the order and the criteria required for when the type of verification detail can be provided. The types of verification details allowed depend on the type of regulated product and will not change order to order." + }, + "VerificationDetails": { + "type": "object", + "properties": { + "prescriptionDetail": { + "$ref": "#/components/schemas/PrescriptionDetail" + } + }, + "description": "Additional information related to the verification of a regulated order." }, "VerificationStatus": { "type": "string", @@ -3835,11 +4208,11 @@ "properties": { "FieldId": { "type": "string", - "description": "The unique identifier for the field." + "description": "The unique identifier of the field." }, "FieldLabel": { "type": "string", - "description": "The name for the field." + "description": "The name of the field." }, "FieldType": { "type": "string", @@ -3851,17 +4224,17 @@ "x-docgen-enum-table-extension": [ { "value": "Text", - "description": "This field is a text representation of a response collected from the regulatory form." + "description": "This field is a text representation of the response collected from the regulatory form." }, { "value": "FileAttachment", - "description": "This field contains the link to an attachment collected from the regulatory form." + "description": "This field contains a link to an attachment collected from the regulatory form." } ] }, "FieldValue": { "type": "string", - "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 content of the field as collected in regulatory form. Note that `FileAttachment` type fields contain a URL where you can download the attachment." } }, "description": "A field collected from the regulatory form." @@ -3878,7 +4251,7 @@ }, "BuyerCompanyName": { "type": "string", - "description": "The company name of the contact buyer. For Invoice By Amazon (IBA) orders, the buyer company should be Amazon entities." + "description": "The company name of the contact buyer. For IBA orders, the buyer company must be Amazon entities." }, "ShippingAddress": { "$ref": "#/components/schemas/Address" @@ -3942,7 +4315,7 @@ }, "Phone": { "type": "string", - "description": "The phone number of the buyer.\n\n**Note**: \n1. This attribute is only available for shipping address.\n2. The buyer `Phone` number is suppressed in some cases, including but not limited to \na. `Phone` is suppressed for all Fulfillment by Amazon (FBA) orders.\nb. `Phone` is suppressed for the shipped MFN(Fulfilled by the seller) order when current date is past Latest Delivery Date." + "description": "The phone number of the buyer.\n\n**Note**: \n1. This attribute is only available for shipping address.\n2. In some cases, the buyer phone number is suppressed: \na. Phone is suppressed for all `AFN` (fulfilled by Amazon) orders.\nb. Phone is suppressed for the shipped `MFN` (fulfilled by seller) order when the current date is past the Latest Delivery Date." }, "ExtendedFields": { "$ref": "#/components/schemas/AddressExtendedFields" @@ -3977,7 +4350,7 @@ }, "StreetNumber": { "type": "string", - "description": "The house number/building number/property number in the street." + "description": "The house, building, or property number associated with the location's street address." }, "Complement": { "type": "string", @@ -3985,10 +4358,10 @@ }, "Neighborhood": { "type": "string", - "description": "The neighborhood. It's smaller than a region and an integral part of an address. It is used in some countries like Brazil." + "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, - "description": "The container of extended address fields. For example, street name, street number. Only available with Brazil shipping addresses as of now." + "description": "The container for address extended fields (such as `street name` and `street number`). Currently only available with Brazil shipping addresses." }, "DeliveryPreferences": { "type": "object", @@ -4026,7 +4399,7 @@ }, "ExceptionDates": { "type": "array", - "description": "Dates when the business is closed in the next 30 days.", + "description": "Dates when the business is closed during the next 30 days.", "items": { "$ref": "#/components/schemas/ExceptionDates" } @@ -4200,7 +4573,7 @@ }, "PaymentMethod": { "type": "string", - "description": "A sub-payment method for a COD order.\n\n**Possible values**:\n* `COD`: Cash On Delivery.\n* `GC`: Gift Card.\n* `PointsAccount`: Amazon Points.\n* `Invoice`: Invoice." + "description": "A sub-payment method for a COD order.\n\n**Possible values**:\n* `COD`: Cash on delivery \n* `GC`: Gift card \n* `PointsAccount`: Amazon Points\n* `Invoice`: Invoice" } }, "description": "Information about a sub-payment method used to pay for a COD order." @@ -4251,7 +4624,7 @@ "description": "The buyer's tax identifier." } }, - "description": "The tax classification for the order." + "description": "The tax classification of the order." }, "OrderItemsList": { "required": [ @@ -4291,11 +4664,11 @@ "properties": { "ASIN": { "type": "string", - "description": "The Amazon Standard Identification Number (ASIN) of the item." + "description": "The item's Amazon Standard Identification Number (ASIN)." }, "SellerSKU": { "type": "string", - "description": "The seller stock keeping unit (SKU) of the item." + "description": "The item's seller stock keeping unit (SKU)." }, "OrderItemId": { "type": "string", @@ -4310,7 +4683,7 @@ }, "Title": { "type": "string", - "description": "The name of the item." + "description": "The item's name." }, "QuantityOrdered": { "type": "integer", @@ -4361,46 +4734,46 @@ }, "IsGift": { "type": "string", - "description": "Indicates whether the item is a gift.\n\n**Possible values**: `true`, `false`." + "description": "Indicates whether the item is a gift.\n\n**Possible values**: `true` and `false`." }, "ConditionNote": { "type": "string", - "description": "The condition of the item as described by the seller." + "description": "The condition of the item, as described by the seller." }, "ConditionId": { "type": "string", - "description": "The condition of the item.\n\n**Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, `Club`." + "description": "The condition of the item.\n\n**Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, and `Club`." }, "ConditionSubtypeId": { "type": "string", - "description": "The subcondition of the item.\n\n**Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, `Other`." + "description": "The subcondition of the item.\n\n**Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, and `Other`." }, "ScheduledDeliveryStartDate": { "type": "string", - "description": "The start date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format." + "description": "The start date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format." }, "ScheduledDeliveryEndDate": { "type": "string", - "description": "The end date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format." + "description": "The end date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format." }, "PriceDesignation": { "type": "string", - "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, refer to [Amazon Business](https://business.amazon.com). \n\n**Possible values**: `BusinessPrice` - A special price that is available only for Amazon Business orders." + "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 values**: `BusinessPrice`" }, "TaxCollection": { "$ref": "#/components/schemas/TaxCollection" }, "SerialNumberRequired": { "type": "boolean", - "description": "When true, the product type for this item has a serial number.\n\nReturned only for Amazon Easy Ship orders." + "description": "When true, the product type for this item has a serial number.\n\n Only returned for Amazon Easy Ship orders." }, "IsTransparency": { "type": "boolean", - "description": "When true, the ASIN is enrolled in Transparency and the Transparency serial number that needs to be submitted can be determined by the following:\n\n**1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN).\n**2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number will be applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.\n**QR code SN:** Submit the URL that the QR code generates." + "description": "When true, the ASIN is enrolled in Transparency. The Transparency serial number that you must submit is determined by:\n\n**1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN).\n**2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.\n**QR code SN:** Submit the URL that the QR code generates." }, "IossNumber": { "type": "string", - "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 IOSS number of the marketplace. 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." }, "StoreChainStoreId": { "type": "string", @@ -4445,10 +4818,29 @@ }, "ShippingConstraints": { "$ref": "#/components/schemas/ShippingConstraints" + }, + "AmazonPrograms": { + "$ref": "#/components/schemas/AmazonPrograms" } }, "description": "A single order item." }, + "AmazonPrograms": { + "required": [ + "Programs" + ], + "type": "object", + "properties": { + "Programs": { + "type": "array", + "description": "A list of the programs that are associated with the specified order item.\n\n**Possible values**: `SUBSCRIBE_AND_SAVE`", + "items": { + "type": "string" + } + } + }, + "description": "Contains the list of programs that are associated with an item.\n\nPossible programs are:\n - **Subscribe and Save**: Offers recurring, scheduled deliveries to Amazon customers and Amazon Business customers for their frequently ordered products." + }, "SubstitutionPreferences": { "required": [ "SubstitutionType" @@ -4474,7 +4866,7 @@ }, { "value": "DO_NOT_SUBSTITUTE", - "description": "Do not provide substitute if item is not found." + "description": "Do not provide a substitute if item is not found." } ] }, @@ -4496,7 +4888,7 @@ "properties": { "ASIN": { "type": "string", - "description": "The Amazon Standard Identification Number (ASIN) of the item." + "description": "The item's Amazon Standard Identification Number (ASIN)." }, "QuantityOrdered": { "type": "integer", @@ -4504,11 +4896,11 @@ }, "SellerSKU": { "type": "string", - "description": "The seller stock keeping unit (SKU) of the item." + "description": "The item's seller stock keeping unit (SKU)." }, "Title": { "type": "string", - "description": "The title of the item." + "description": "The item's title." }, "Measurement": { "$ref": "#/components/schemas/Measurement" @@ -4525,7 +4917,7 @@ "properties": { "Unit": { "type": "string", - "description": "The unit of measure for this measurement.", + "description": "The unit of measure.", "enum": [ "OUNCES", "POUNDS", @@ -4555,105 +4947,105 @@ "x-docgen-enum-table-extension": [ { "value": "OUNCES", - "description": "Indicates the item's measurement is measured in ounces." + "description": "The item is measured in ounces." }, { "value": "POUNDS", - "description": "Indicates the item's measurement is measured in pounds." + "description": "The item is measured in pounds." }, { "value": "KILOGRAMS", - "description": "Indicates the item's measurement is measured in kilograms." + "description": "The item is measured in kilograms." }, { "value": "GRAMS", - "description": "Indicates the item's measurement is measured in grams." + "description": "The item is measured in grams." }, { "value": "MILLIGRAMS", - "description": "Indicates the item's measurement is measured in milligrams." + "description": "The item is measured in milligrams." }, { "value": "INCHES", - "description": "Indicates the item's measurement is measured in inches." + "description": "The item is measured in inches." }, { "value": "FEET", - "description": "Indicates the item's measurement is measured in feet." + "description": "The item is measured in feet." }, { "value": "METERS", - "description": "Indicates the item's measurement is measured in meters." + "description": "The item is measured in meters." }, { "value": "CENTIMETERS", - "description": "Indicates the item's measurement is measured in centimeters." + "description": "The item is measured in centimeters." }, { "value": "MILLIMETERS", - "description": "Indicates the item's measurement is measured in millimeters." + "description": "The item is measured in millimeters." }, { "value": "SQUARE_METERS", - "description": "Indicates the item's measurement is measured in square meters." + "description": "The item is measured in square meters." }, { "value": "SQUARE_CENTIMETERS", - "description": "Indicates the item's measurement is measured in square centimeters." + "description": "The item is measured in square centimeters." }, { "value": "SQUARE_FEET", - "description": "Indicates the item's measurement is measured in square feet." + "description": "The item is measured in square feet." }, { "value": "SQUARE_INCHES", - "description": "Indicates the item's measurement is measured in square inches." + "description": "The item is measured in square inches." }, { "value": "GALLONS", - "description": "Indicates the item's measurement is measured in gallons." + "description": "The item is measured in gallons." }, { "value": "PINTS", - "description": "Indicates the item's measurement is measured in pints." + "description": "The item is measured in pints." }, { "value": "QUARTS", - "description": "Indicates the item's measurement is measured in quarts." + "description": "The item is measured in quarts." }, { "value": "FLUID_OUNCES", - "description": "Indicates the item's measurement is measured in fluid ounces." + "description": "The item is measured in fluid ounces." }, { "value": "LITERS", - "description": "Indicates the item's measurement is measured in liters." + "description": "The item is measured in liters." }, { "value": "CUBIC_METERS", - "description": "Indicates the item's measurement is measured in cubic meters." + "description": "The item is measured in cubic meters." }, { "value": "CUBIC_FEET", - "description": "Indicates the item's measurement is measured in cubic feet." + "description": "The item is measured in cubic feet." }, { "value": "CUBIC_INCHES", - "description": "Indicates the item's measurement is measured in cubic inches." + "description": "The item is measured in cubic inches." }, { "value": "CUBIC_CENTIMETERS", - "description": "Indicates the item's measurement is measured in cubic centimeters." + "description": "The item is measured in cubic centimeters." }, { "value": "COUNT", - "description": "Indicates the item's measurement is measured by count." + "description": "The item is measured by count." } ] }, "Value": { "type": "number", - "description": "The value of the measurement." + "description": "The measurement value." } }, "description": "Measurement information for an order item." @@ -4673,7 +5065,7 @@ "$ref": "#/components/schemas/AssociationType" } }, - "description": "An item associated with an order item. For example, a tire installation service purchased with tires." + "description": "An item that is associated with an order item. For example, a tire installation service that is purchased with tires." }, "AssociationType": { "type": "string", @@ -4737,7 +5129,7 @@ }, "GiftMessageText": { "type": "string", - "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (Fulfilled by the seller) orders." + "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (fulfilled by seller) orders." }, "GiftWrapLevel": { "type": "string", @@ -4781,7 +5173,7 @@ "properties": { "CustomizedURL": { "type": "string", - "description": "The location of a zip file containing Amazon Custom data." + "description": "The location of a ZIP file containing Amazon Custom data." } }, "description": "Buyer information for custom orders from the Amazon Custom program." @@ -4845,16 +5237,25 @@ "properties": { "FulfillmentSupplySourceId": { "type": "string", - "description": "Denotes the recommended `sourceId` where the order should be fulfilled from." + "description": "The `sourceId` of the location from where you want the order fulfilled." } }, - "description": "Contains the instructions about the fulfillment like where should it be fulfilled from." + "description": "Contains the instructions about the fulfillment, such as the location from where you want the order filled." }, "ShippingConstraints": { "type": "object", "properties": { "PalletDelivery": { "$ref": "#/components/schemas/ConstraintType" + }, + "SignatureConfirmation": { + "$ref": "#/components/schemas/ConstraintType" + }, + "RecipientIdentityVerification": { + "$ref": "#/components/schemas/ConstraintType" + }, + "RecipientAgeVerification": { + "$ref": "#/components/schemas/ConstraintType" } }, "description": "Delivery constraints applicable to this order." @@ -4892,7 +5293,7 @@ }, "PurchaseOrderNumber": { "type": "string", - "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 purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } }, "description": "Buyer information." @@ -4911,7 +5312,7 @@ }, "GiftMessageText": { "type": "string", - "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (Fulfilled by the seller) orders." + "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (fulfilled by seller) orders." }, "GiftWrapLevel": { "type": "string", @@ -4962,7 +5363,7 @@ }, "EasyShipShipmentStatus": { "type": "string", - "description": "The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.", + "description": "The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.", "enum": [ "PendingSchedule", "PendingPickUp", @@ -5093,7 +5494,7 @@ }, "codCollectionMethod": { "type": "string", - "description": "The cod collection method, support in JP only. ", + "description": "The COD collection method (only supported in the JP marketplace).", "enum": [ "DirectPayment" ] @@ -5128,11 +5529,11 @@ }, "carrierCode": { "type": "string", - "description": "Identifies the carrier that will deliver the package. This field is required for all marketplaces. For the acceptable `CarrierCode` value, refer to the list of CarrierCode." + "description": "Identifies the carrier that will deliver the package. This field is required for all marketplaces. For more information, refer to the [`CarrierCode` announcement](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\" " + "description": "Carrier Name that will deliver the package. Required when `carrierCode` is \"Others\" " }, "shippingMethod": { "type": "string", @@ -5149,7 +5550,7 @@ }, "shipFromSupplySourceId": { "type": "string", - "description": "The unique identifier of the supply source." + "description": "The unique identifier for the supply source." }, "orderItems": { "$ref": "#/components/schemas/ConfirmShipmentOrderItemsList" @@ -5173,11 +5574,11 @@ "properties": { "orderItemId": { "type": "string", - "description": "The unique identifier of the order item." + "description": "The order item's unique identifier." }, "quantity": { "type": "integer", - "description": "The quantity of the item." + "description": "The item's quantity." }, "transparencyCodes": { "$ref": "#/components/schemas/TransparencyCodeList" @@ -5194,7 +5595,7 @@ }, "TransparencyCode": { "type": "string", - "description": "The Transparency code associated with the item." + "description": "The transparency code associated with the item." }, "PackageReferenceId": { "type": "string", diff --git a/resources/models/seller/product-pricing/v2022-05-01.json b/resources/models/seller/product-pricing/v2022-05-01.json index a143050f9..466536ac3 100644 --- a/resources/models/seller/product-pricing/v2022-05-01.json +++ b/resources/models/seller/product-pricing/v2022-05-01.json @@ -1824,9 +1824,6 @@ "description": "A list of error responses returned when a request is unsuccessful." }, "FeaturedOfferExpectedPriceResponseBody": { - "required": [ - "offerIdentifier" - ], "type": "object", "properties": { "offerIdentifier": { diff --git a/resources/models/seller/sellers/v1.json b/resources/models/seller/sellers/v1.json index 669f8a825..09c5b7079 100644 --- a/resources/models/seller/sellers/v1.json +++ b/resources/models/seller/sellers/v1.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "Selling Partner API for Sellers", - "description": "The Selling Partner API for Sellers lets you retrieve information on behalf of sellers about their seller account, such as the marketplaces they participate in. Along with listing the marketplaces that a seller can sell in, the API also provides additional information about the marketplace such as the default language and the default currency. The API also provides seller-specific information such as whether the seller has suspended listings in that marketplace.", + "description": "The [Selling Partner API for Sellers](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) (Sellers API) provides essential information about seller accounts, such as:\n\n- The marketplaces a seller can list in\n- The default language and currency of a marketplace\n- Whether the seller has suspended listings\n\nRefer to the [Sellers API reference](https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference) for details about this API's operations, data types, and schemas.", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" @@ -24,14 +24,14 @@ "tags": [ "SellersV1" ], - "description": "Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller's participation in those marketplaces.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.016 | 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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of marketplaces where the seller can list items and information about the seller's participation in those marketplaces.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.016 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getMarketplaceParticipations", "responses": { "200": { "description": "Marketplace participations successfully retrieved.", "headers": { "x-amzn-RequestId": { - "description": "unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -82,7 +82,7 @@ "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -106,7 +106,7 @@ "description": "403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -124,7 +124,7 @@ "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -148,7 +148,7 @@ "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -172,7 +172,7 @@ "description": "The entity of the request is in a format not supported by the requested resource.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -196,7 +196,7 @@ "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -220,7 +220,7 @@ "description": "Encountered an unexpected condition which prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -244,7 +244,7 @@ "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { - "description": "Unique request reference id.", + "description": "Unique request reference identifier.", "schema": { "type": "string" } @@ -266,6 +266,310 @@ } } } + }, + "/sellers/v1/account": { + "get": { + "tags": [ + "SellersV1" + ], + "description": "Returns information about a seller account and its marketplaces.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.016 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getAccount", + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + }, + "example": { + "payload": { + "businessType": "PRIVATE_LIMITED", + "marketplaceLevelAttributes": [ + { + "marketplace": { + "id": "ATVPDKIKX0DER", + "name": "United States", + "countryCode": "US", + "domainName": "www.amazon.com" + }, + "storeName": "BestSellerStore", + "listingStatus": "ACTIVE", + "sellingPlan": "PROFESSIONAL" + } + ], + "business": { + "name": "BestSeller Inc.", + "nonLatinName": "\u30d9\u30b9\u30c8\u30bb\u30e9\u30fc\u682a\u5f0f\u4f1a\u793e", + "registeredBusinessAddress": { + "addressLine1": "123 Main St", + "addressLine2": "Suite 500", + "city": "Seattle", + "stateOrProvinceCode": "WA", + "postalCode": "98101", + "countryCode": "US" + }, + "companyRegistrationNumber": "123456789" + }, + "primaryContact": { + "name": "John Doe", + "nonLatinName": "\u30b8\u30e7\u30f3\u30fb\u30c9\u30a5", + "address": { + "addressLine1": "456 Oak St", + "addressLine2": "Apt 12", + "city": "Seattle", + "stateOrProvinceCode": "WA", + "postalCode": "98102", + "countryCode": "US" + } + } + } + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "response": { + "payload": { + "marketplaceLevelAttributes": [ + { + "marketplace": { + "id": "ATVPDKIKX0DER", + "name": "United States", + "countryCode": "US", + "domainName": "www.amazon.com" + }, + "storeName": "BestSellerStore", + "listingStatus": "ACTIVE", + "sellingPlan": "PROFESSIONAL" + } + ], + "businessType": "SOLE_PROPRIETORSHIP", + "business": { + "name": "BestSeller Inc.", + "registeredBusinessAddress": { + "addressLine1": "123 Main St", + "addressLine2": "Suite 500", + "city": "Seattle", + "stateOrProvinceCode": "WA", + "postalCode": "98101", + "countryCode": "US" + }, + "companyTaxIdentificationNumber": "TAX123456" + }, + "primaryContact": { + "name": "John Doe", + "nonLatinName": "\u30b8\u30e7\u30f3\u30fb\u30c9\u30a5", + "address": { + "addressLine1": "456 Oak St", + "addressLine2": "Apt 12", + "city": "Seattle", + "stateOrProvinceCode": "WA", + "postalCode": "98102", + "countryCode": "US" + } + } + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + }, + "example": { + "errors": [ + { + "code": "400", + "message": "Validation failed for obfuscatedId:ACUULBDVZHYZ1" + } + ] + } + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "response": { + "errors": [ + { + "code": "400", + "message": "Validation failed for obfuscatedId:ACUULBDVZHYZ1" + } + ] + } + } + ] + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + }, + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAccountResponse" + } + } + } + } + } + } } }, "components": { @@ -279,7 +583,7 @@ "properties": { "code": { "type": "string", - "description": "An error code that identifies the type of error that occured." + "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", @@ -287,7 +591,7 @@ }, "details": { "type": "string", - "description": "Additional details that can help the caller understand or fix the issue." + "description": "Additional details that can help you understand or fix the issue." } }, "description": "Error response returned when the request is unsuccessful." @@ -340,7 +644,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the getMarketplaceParticipations operation." + "description": "The response schema for the `getMarketplaceParticipations` operation." }, "Marketplace": { "required": [ @@ -359,7 +663,7 @@ }, "name": { "type": "string", - "description": "Marketplace name." + "description": "The marketplace name." }, "countryCode": { "pattern": "^([A-Z]{2})$", @@ -379,7 +683,7 @@ "description": "The domain name of the marketplace." } }, - "description": "Detailed information about an Amazon market where a seller can list items for sale and customers can view and purchase items." + "description": "Information about an Amazon marketplace where a seller can list items and customers can view and purchase items." }, "Participation": { "required": [ @@ -389,14 +693,237 @@ "type": "object", "properties": { "isParticipating": { - "type": "boolean" + "type": "boolean", + "description": "If `true`, the seller participates in the marketplace. Otherwise `false`." }, "hasSuspendedListings": { "type": "boolean", - "description": "Specifies if the seller has suspended listings. True if the seller Listing Status is set to Inactive, otherwise False." + "description": "Specifies if the seller has suspended listings. `true` if the seller Listing Status is set to Inactive, otherwise `false`." + } + }, + "description": "Information that is specific to a seller in a marketplace." + }, + "GetAccountResponse": { + "type": "object", + "properties": { + "payload": { + "$ref": "#/components/schemas/Account" + }, + "errors": { + "$ref": "#/components/schemas/ErrorList" + } + }, + "description": "The response schema for the `getAccount` operation." + }, + "MarketplaceLevelAttributes": { + "required": [ + "listingStatus", + "marketplace", + "sellingPlan", + "storeName" + ], + "type": "object", + "properties": { + "marketplace": { + "$ref": "#/components/schemas/Marketplace" + }, + "storeName": { + "type": "string", + "description": "The name of the seller's store as displayed in the marketplace." + }, + "listingStatus": { + "type": "string", + "description": "The current status of the seller's listings.", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ACTIVE", + "description": "The seller's listings are currently active." + }, + { + "value": "INACTIVE", + "description": "The seller's listings are currently inactive." + } + ] + }, + "sellingPlan": { + "type": "string", + "description": "The selling plan details.", + "enum": [ + "PROFESSIONAL", + "INDIVIDUAL" + ], + "x-docgen-enum-table-extension": [ + { + "value": "PROFESSIONAL", + "description": "The seller has a professional selling plan." + }, + { + "value": "INDIVIDUAL", + "description": "The seller has an individual selling plan." + } + ] + } + }, + "description": "Attributes that define the seller's presence and status within a specific marketplace. These attributes include the marketplace details, store name, listing status, and the selling plan the seller is subscribed to." + }, + "Account": { + "required": [ + "businessType", + "marketplaceLevelAttributes" + ], + "type": "object", + "properties": { + "marketplaceLevelAttributes": { + "type": "array", + "description": "A list of details of the marketplaces where the seller account is active.", + "items": { + "$ref": "#/components/schemas/MarketplaceLevelAttributes" + } + }, + "businessType": { + "type": "string", + "description": "The type of business registered for the seller account.", + "enum": [ + "CHARITY", + "CRAFTSMAN", + "NATURAL_PERSON_COMPANY", + "PUBLIC_LISTED", + "PRIVATE_LIMITED", + "SOLE_PROPRIETORSHIP", + "STATE_OWNED", + "INDIVIDUAL" + ], + "x-docgen-enum-table-extension": [ + { + "value": "CHARITY", + "description": "The business is registered as a charity." + }, + { + "value": "CRAFTSMAN", + "description": "The business is registered as a craftsman." + }, + { + "value": "NATURAL_PERSON_COMPANY", + "description": "The business is a natural person company." + }, + { + "value": "PUBLIC_LISTED", + "description": "The business is a publicly listed company." + }, + { + "value": "PRIVATE_LIMITED", + "description": "The business is a private limited company." + }, + { + "value": "SOLE_PROPRIETORSHIP", + "description": "The business is a sole proprietorship." + }, + { + "value": "STATE_OWNED", + "description": "The business is state-owned." + }, + { + "value": "INDIVIDUAL", + "description": "The entity is not a business but an individual." + } + ] + }, + "business": { + "$ref": "#/components/schemas/Business" + }, + "primaryContact": { + "$ref": "#/components/schemas/PrimaryContact" + } + }, + "description": "The response schema for the `getAccount` operation." + }, + "Business": { + "required": [ + "name", + "registeredBusinessAddress" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The registered business name." + }, + "registeredBusinessAddress": { + "$ref": "#/components/schemas/Address" + }, + "companyRegistrationNumber": { + "type": "string", + "description": "The seller's company registration number, if applicable. This field will be absent for individual sellers and sole proprietorships." + }, + "companyTaxIdentificationNumber": { + "type": "string", + "description": "The seller's company tax identification number, if applicable. This field will be present for certain business types only, such as sole proprietorships." + }, + "nonLatinName": { + "type": "string", + "description": "The non-Latin script version of the registered business name, if applicable." + } + }, + "description": "Information about the seller's business. Certain fields may be omitted depending on the seller's `businessType`." + }, + "Address": { + "required": [ + "addressLine1", + "countryCode" + ], + "type": "object", + "properties": { + "addressLine1": { + "type": "string", + "description": "Street address information." + }, + "addressLine2": { + "type": "string", + "description": "Additional street address information." + }, + "countryCode": { + "type": "string", + "description": "The country code in two-character ISO 3166-1 alpha-2 format." + }, + "stateOrProvinceCode": { + "type": "string", + "description": "The state or province code." + }, + "city": { + "type": "string", + "description": "The city." + }, + "postalCode": { + "type": "string", + "description": "The postal code." + } + }, + "description": "Represents an address" + }, + "PrimaryContact": { + "required": [ + "address", + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The full name of the seller's primary contact." + }, + "address": { + "$ref": "#/components/schemas/Address" + }, + "nonLatinName": { + "type": "string", + "description": "The non-Latin script version of the primary contact's name, if applicable." } }, - "description": "Detailed information that is specific to a seller in a Marketplace." + "description": "Information about the seller's primary contact." } } }, diff --git a/resources/models/seller/shipping/v2.json b/resources/models/seller/shipping/v2.json index 74160772f..d09484322 100644 --- a/resources/models/seller/shipping/v2.json +++ b/resources/models/seller/shipping/v2.json @@ -6117,6 +6117,9 @@ }, "packageDocumentDetail": { "$ref": "#/components/schemas/PackageDocumentDetail" + }, + "benefits": { + "$ref": "#/components/schemas/Benefits" } }, "description": "The payload for the getShipmentDocuments operation." @@ -6238,6 +6241,9 @@ }, "promise": { "$ref": "#/components/schemas/Promise" + }, + "benefits": { + "$ref": "#/components/schemas/Benefits" } }, "description": "The payload for the purchaseShipment operation." @@ -6860,7 +6866,7 @@ "$ref": "#/components/schemas/ExcludedBenefits" } }, - "description": "Representing the included/excluded benefits that we offer for each ShippingOffering/Rate. Benefits being services provided by Amazon when sellers purchase shipping through Amazon." + "description": "Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC." }, "IncludedBenefits": { "type": "array", @@ -6879,19 +6885,27 @@ "ExcludedBenefit": { "required": [ "benefit", - "reasonCode" + "reasonCodes" ], "type": "object", "properties": { "benefit": { "type": "string" }, - "reasonCode": { - "type": "string" + "reasonCodes": { + "$ref": "#/components/schemas/ExcludedBenefitReasonCodes" } }, "description": "Object representing an excluded benefit that is excluded for an ShippingOffering/Rate." }, + "ExcludedBenefitReasonCodes": { + "minItems": 1, + "type": "array", + "description": "List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer.", + "items": { + "type": "string" + } + }, "ServiceSelection": { "required": [ "serviceId" diff --git a/resources/models/vendor/orders/v1.json b/resources/models/vendor/orders/v1.json index e8a9c62b8..79cf7dc8d 100644 --- a/resources/models/vendor/orders/v1.json +++ b/resources/models/vendor/orders/v1.json @@ -24,7 +24,7 @@ "tags": [ "OrdersV1" ], - "description": "Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getPurchaseOrders", "parameters": [ { @@ -41,7 +41,7 @@ { "name": "createdAfter", "in": "query", - "description": "Purchase orders that became available after this time will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -50,7 +50,7 @@ { "name": "createdBefore", "in": "query", - "description": "Purchase orders that became available before this time will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -99,7 +99,7 @@ { "name": "includeDetails", "in": "query", - "description": "When `true`, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is `true`.", + "description": "When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.", "schema": { "type": "string", "format": "boolean" @@ -108,7 +108,7 @@ { "name": "changedAfter", "in": "query", - "description": "Purchase orders that changed after this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -117,7 +117,7 @@ { "name": "changedBefore", "in": "query", - "description": "Purchase orders that changed before this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -126,7 +126,7 @@ { "name": "poItemState", "in": "query", - "description": "Current state of the purchase order item. If this value is `Cancelled`, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.", + "description": "Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.", "schema": { "type": "string", "enum": [ @@ -149,7 +149,7 @@ { "name": "isPOChanged", "in": "query", - "description": "When `true`, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is `false`.", + "description": "When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.", "schema": { "type": "string", "format": "boolean" @@ -382,11 +382,13 @@ "isBackOrderAllowed": true, "netCost": { "amount": "94.97", - "currencyCode": "USD" + "currencyCode": "USD", + "unitOfMeasure": "POUNDS" }, "listPrice": { "amount": "94.97", - "currencyCode": "USD" + "currencyCode": "USD", + "unitOfMeasure": "POUNDS" } } ] @@ -937,7 +939,8 @@ "isBackOrderAllowed": true, "netCost": { "amount": "94.97", - "currencyCode": "INR" + "currencyCode": "INR", + "unitOfMeasure": "POUNDS" } } ] @@ -1008,13 +1011,19 @@ } }, "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.", + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1057,6 +1066,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1075,6 +1090,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1093,6 +1114,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1111,6 +1138,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1129,7 +1162,7 @@ "tags": [ "OrdersV1" ], - "description": "Returns a purchase order based on the `purchaseOrderNumber` value that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a purchase order based on the `purchaseOrderNumber` value that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getPurchaseOrder", "parameters": [ { @@ -1431,13 +1464,19 @@ } }, "401": { - "description": "The request's authorization header is not formatted correctly or does not contain a valid token.", + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1449,13 +1488,19 @@ } }, "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.", + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1498,6 +1543,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1516,6 +1567,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1534,6 +1591,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1552,6 +1615,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1570,10 +1639,9 @@ "tags": [ "OrdersV1" ], - "description": "Submits acknowledgements for one or more purchase orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Submits acknowledgements for one or more purchase orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "submitAcknowledgement", "requestBody": { - "description": "Submits acknowledgements for one or more purchase orders from a vendor.", "content": { "application/json": { "schema": { @@ -1726,13 +1794,19 @@ } }, "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized,` `Expired Token`, or `Invalid Signature`.", + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1775,6 +1849,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1793,6 +1873,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1811,6 +1897,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1829,6 +1921,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1847,6 +1945,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -1866,7 +1970,7 @@ "tags": [ "OrdersV1" ], - "description": "Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getPurchaseOrdersStatus", "parameters": [ { @@ -1923,7 +2027,7 @@ { "name": "createdAfter", "in": "query", - "description": "Purchase orders that became available after this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -1932,7 +2036,7 @@ { "name": "createdBefore", "in": "query", - "description": "Purchase orders that became available before this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -1941,7 +2045,7 @@ { "name": "updatedAfter", "in": "query", - "description": "Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -1950,7 +2054,7 @@ { "name": "updatedBefore", "in": "query", - "description": "Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO 8601 date/time format.", + "description": "Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.", "schema": { "type": "string", "format": "date-time" @@ -2812,13 +2916,19 @@ } }, "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include `Access Denied`, `Unauthorized`, `Expired Token`, or `Invalid Signature`.", + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -2861,6 +2971,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -2879,6 +2995,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -2897,6 +3019,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -2915,6 +3043,12 @@ "schema": { "type": "string" } + }, + "x-amzn-RateLimit-Limit": { + "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.", + "schema": { + "type": "string" + } } }, "content": { @@ -2941,7 +3075,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the `getPurchaseOrders` operation." + "description": "The response schema for the getPurchaseOrders operation." }, "GetPurchaseOrderResponse": { "type": "object", @@ -2953,7 +3087,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the `getPurchaseOrder` operation." + "description": "The response schema for the getPurchaseOrder operation." }, "OrderList": { "type": "object", @@ -2963,23 +3097,20 @@ }, "orders": { "type": "array", - "description": "Represents an individual order within the `OrderList`.", "items": { "$ref": "#/components/schemas/Order" } } - }, - "description": "A list of orders returned as response." + } }, "Pagination": { "type": "object", "properties": { "nextToken": { "type": "string", - "description": "A generated string used to pass information to your next request. If `NextToken` is returned, pass the value of `NextToken` to the next request. If `NextToken` is not returned, there are no more purchase order items to return." + "description": "A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more purchase order items to return." } - }, - "description": "The pagination elements required to retrieve the remaining data." + } }, "Order": { "required": [ @@ -3003,11 +3134,11 @@ "x-docgen-enum-table-extension": [ { "value": "New", - "description": "The purchase order is newly created and needs to be acknowledged by the vendor." + "description": "The purchase order is newly created and needs to be acknowledged by vendor." }, { "value": "Acknowledged", - "description": "The purchase order has been acknowledged by the vendor." + "description": "The purchase order has been acknowledged by vendor." }, { "value": "Closed", @@ -3018,8 +3149,7 @@ "orderDetails": { "$ref": "#/components/schemas/OrderDetails" } - }, - "description": "Represents an order placed by Amazon, including the purchase order number, current state, and order details." + } }, "OrderDetails": { "required": [ @@ -3031,17 +3161,17 @@ "properties": { "purchaseOrderDate": { "type": "string", - "description": "The date the purchase order was placed. Must be in ISO 8601 date/time format.", + "description": "The date the purchase order was placed. Must be in ISO-8601 date/time format.", "format": "date-time" }, "purchaseOrderChangedDate": { "type": "string", - "description": "The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than 'purchaseOrderDate'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO 8601 date/time format.", + "description": "The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than 'purchaseOrderDate'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO-8601 date/time format.", "format": "date-time" }, "purchaseOrderStateChangedDate": { "type": "string", - "description": "The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'. Must be in ISO 8601 date/time format.", + "description": "The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'. Must be in ISO-8601 date/time format.", "format": "date-time" }, "purchaseOrderType": { @@ -3242,12 +3372,12 @@ "portOfDelivery": { "maxLength": 64, "type": "string", - "description": "The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the `internationalCommercialTerms` is `FOB`." + "description": "The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the internationalCommercialTerms is FOB." }, "importContainers": { "maxLength": 64, "type": "string", - "description": "Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: `$NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE`. The list of values for the container type is: `40'`(40-foot container), `40'HC` (40-foot high-capacity container), `45'`, `45'HC`, `30'`, `30'HC`, `20'`, `20'HC`." + "description": "Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: $NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE. The list of values for the container type is: 40'(40-foot container), 40'HC (40-foot high-capacity container), 45', 45'HC, 30', 30'HC, 20', 20'HC." }, "shippingInstructions": { "type": "string", @@ -3258,7 +3388,7 @@ }, "DateTimeInterval": { "type": "string", - "description": "Defines a date time interval according to ISO 8601. Interval is separated by double hyphen (--)." + "description": "Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--)." }, "PartyIdentification": { "required": [ @@ -3276,8 +3406,7 @@ "taxInfo": { "$ref": "#/components/schemas/TaxRegistrationDetails" } - }, - "description": "Name, address and tax details of a party." + } }, "TaxRegistrationDetails": { "required": [ @@ -3306,7 +3435,7 @@ }, "taxRegistrationNumber": { "type": "string", - "description": "Tax registration number for the entity. For example, `VAT ID`." + "description": "Tax registration number for the entity. For example, VAT ID." } }, "description": "Tax registration details of the entity." @@ -3353,7 +3482,7 @@ }, "postalCode": { "type": "string", - "description": "The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation." + "description": "The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation." }, "countryCode": { "maxLength": 2, @@ -3400,8 +3529,7 @@ "listPrice": { "$ref": "#/components/schemas/Money" } - }, - "description": "Represents an individual item in an order, including item details, quantities, pricing, and backorder information." + } }, "Money": { "type": "object", @@ -3413,9 +3541,37 @@ }, "amount": { "$ref": "#/components/schemas/Decimal" + }, + "unitOfMeasure": { + "type": "string", + "description": "The unit of measure for prices of items sold by weight. If this field is absent, the item is sold by eaches.", + "enum": [ + "POUNDS", + "OUNCES", + "GRAMS", + "KILOGRAMS" + ], + "x-docgen-enum-table-extension": [ + { + "value": "POUNDS", + "description": "Priced per Pound." + }, + { + "value": "OUNCES", + "description": "Priced per Ounce." + }, + { + "value": "GRAMS", + "description": "Priced per Gram." + }, + { + "value": "KILOGRAMS", + "description": "Priced per Kilogram." + } + ] } }, - "description": "An amount of money, including units in the form of currency." + "description": "An amount of money. Includes the currency code and an optional unit of measure for items priced by weight." }, "Decimal": { "type": "string", @@ -3431,7 +3587,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the `submitAcknowledgement` operation" + "description": "The response schema for the submitAcknowledgement operation" }, "TransactionId": { "type": "object", @@ -3440,8 +3596,7 @@ "type": "string", "description": "GUID assigned by Amazon to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction." } - }, - "description": "Response containing the transaction ID." + } }, "ErrorList": { "required": [ @@ -3464,13 +3619,12 @@ "properties": { "acknowledgements": { "type": "array", - "description": "An array of order acknowledgements to be submitted.", "items": { "$ref": "#/components/schemas/OrderAcknowledgement" } } }, - "description": "The request schema for the `submitAcknowledgment` operation." + "description": "The request schema for the submitAcknowledgment operation." }, "OrderAcknowledgement": { "required": [ @@ -3490,7 +3644,7 @@ }, "acknowledgementDate": { "type": "string", - "description": "The date and time when the purchase order is acknowledged, in ISO 8601 date/time format.", + "description": "The date and time when the purchase order is acknowledged, in ISO-8601 date/time format.", "format": "date-time" }, "items": { @@ -3500,8 +3654,7 @@ "$ref": "#/components/schemas/OrderAcknowledgementItem" } } - }, - "description": "Represents an acknowledgement for an order, including the purchase order number, selling party details, acknowledgement date, and a list of acknowledged items." + } }, "OrderAcknowledgementItem": { "required": [ @@ -3567,7 +3720,7 @@ }, { "value": "Backordered", - "description": "Vendor placed a backorder to fulfill the original order and provides a `scheduledShipDate` or `scheduledDeliveryDate` which is different than the `expectedShipDate` or `expectedDeliveryDate` provided in the purchase order." + "description": "Vendor placed a backorder to fulfill the original order and provides a scheduledShipDate or scheduledDeliveryDate which is different than the expectedShipDate or expectedDeliveryDate provided in the purchase order." }, { "value": "Rejected", @@ -3580,12 +3733,12 @@ }, "scheduledShipDate": { "type": "string", - "description": "Estimated ship date per line item. Must be in ISO 8601 date/time format.", + "description": "Estimated ship date per line item. Must be in ISO-8601 date/time format.", "format": "date-time" }, "scheduledDeliveryDate": { "type": "string", - "description": "Estimated delivery date per line item. Must be in ISO 8601 date/time format.", + "description": "Estimated delivery date per line item. Must be in ISO-8601 date/time format.", "format": "date-time" }, "rejectionReason": { @@ -3611,8 +3764,7 @@ } ] } - }, - "description": "Represents the acknowledgement details for an individual order item, including the acknowledgement code, acknowledged quantity, scheduled ship and delivery dates, and rejection reason (if applicable)." + } }, "ItemQuantity": { "type": "object", @@ -3656,7 +3808,7 @@ "$ref": "#/components/schemas/ErrorList" } }, - "description": "The response schema for the `getPurchaseOrdersStatus` operation." + "description": "The response schema for the getPurchaseOrdersStatus operation." }, "OrderListStatus": { "type": "object", @@ -3666,13 +3818,11 @@ }, "ordersStatus": { "type": "array", - "description": "Represents an order status within the `OrderListStatus`.", "items": { "$ref": "#/components/schemas/OrderStatus" } } - }, - "description": "A list of order statuses." + } }, "OrderStatus": { "required": [ @@ -3709,12 +3859,12 @@ }, "purchaseOrderDate": { "type": "string", - "description": "The date the purchase order was placed. Must be in ISO 8601 date/time format.", + "description": "The date the purchase order was placed. Must be in ISO-8601 date/time format.", "format": "date-time" }, "lastUpdatedDate": { "type": "string", - "description": "The date when the purchase order was last updated. Must be in ISO 8601 date/time format.", + "description": "The date when the purchase order was last updated. Must be in ISO-8601 date/time format.", "format": "date-time" }, "sellingParty": { @@ -3854,21 +4004,20 @@ }, "lastReceiveDate": { "type": "string", - "description": "The date when the most recent item was received at the buyer's warehouse. Must be in ISO 8601 date/time format.", + "description": "The date when the most recent item was received at the buyer's warehouse. Must be in ISO-8601 date/time format.", "format": "date-time" } }, "description": "Item receive status at the buyer's warehouse." } - }, - "description": "Represents the current status of an order item, including acknowledgement and receiving details." + } }, "OrderedQuantityDetails": { "type": "object", "properties": { "updatedDate": { "type": "string", - "description": "The date when the line item quantity was updated by the buyer. Must be in ISO 8601 date/time format.", + "description": "The date when the line item quantity was updated by buyer. Must be in ISO-8601 date/time format.", "format": "date-time" }, "orderedQuantity": { @@ -3878,14 +4027,14 @@ "$ref": "#/components/schemas/ItemQuantity" } }, - "description": "Details of the item quantity ordered." + "description": "Details of item quantity ordered" }, "AcknowledgementStatusDetails": { "type": "object", "properties": { "acknowledgementDate": { "type": "string", - "description": "The date when the line item was confirmed by the vendor. Must be in ISO 8601 date/time format.", + "description": "The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format.", "format": "date-time" }, "acceptedQuantity": { @@ -3895,7 +4044,7 @@ "$ref": "#/components/schemas/ItemQuantity" } }, - "description": "Details of the item quantity ordered" + "description": "Details of item quantity ordered" }, "Error": { "required": [ diff --git a/src/Authentication/GetAccessTokenRequest.php b/src/Authentication/GetAccessTokenRequest.php index 3f3ba5f8f..2d8d98c55 100644 --- a/src/Authentication/GetAccessTokenRequest.php +++ b/src/Authentication/GetAccessTokenRequest.php @@ -31,7 +31,7 @@ public function __construct( protected string $refreshToken, protected ?GrantlessScope $scope = null, ) { - $this->authenticate(new NullAuthenticator()); + $this->authenticate(new NullAuthenticator); } public function resolveEndpoint(): string diff --git a/src/Generator/Commands/UpdateVersion.php b/src/Generator/Commands/UpdateVersion.php index e5c29b602..749bf9dd3 100644 --- a/src/Generator/Commands/UpdateVersion.php +++ b/src/Generator/Commands/UpdateVersion.php @@ -26,7 +26,7 @@ class UpdateVersion extends Command protected function execute(InputInterface $input, OutputInterface $output): int { $rawVersion = Package::version(); - $versionParser = new VersionParser(); + $versionParser = new VersionParser; // This will throw an exception if the version is invalid $currentVersion = $versionParser->normalize($rawVersion); diff --git a/src/Generator/Generators/BaseResourceGenerator.php b/src/Generator/Generators/BaseResourceGenerator.php index a2e981183..5898960a0 100644 --- a/src/Generator/Generators/BaseResourceGenerator.php +++ b/src/Generator/Generators/BaseResourceGenerator.php @@ -21,7 +21,7 @@ public function generate(ApiSpecification $specification): PhpFile|array ->setType(SellingPartnerApi::class) ->setProtected(); - $classFile = new PhpFile(); + $classFile = new PhpFile; $classFile->setStrictTypes() ->addNamespace(PACKAGE_NAMESPACE) ->addUse(SellingPartnerApi::class) diff --git a/src/Generator/Schema/SchemaVersion.php b/src/Generator/Schema/SchemaVersion.php index 4a1172210..814965ecd 100644 --- a/src/Generator/Schema/SchemaVersion.php +++ b/src/Generator/Schema/SchemaVersion.php @@ -123,7 +123,7 @@ public function refactor(): void */ public function download(): void { - $client = new Client(); + $client = new Client; $convertUrl = 'https://converter.swagger.io/api/convert'; if ($this->selector !== null) { diff --git a/src/Seller/AmazonWarehousingAndDistributionV20240509/Api.php b/src/Seller/AmazonWarehousingAndDistributionV20240509/Api.php index bb44c9b33..a5f483255 100644 --- a/src/Seller/AmazonWarehousingAndDistributionV20240509/Api.php +++ b/src/Seller/AmazonWarehousingAndDistributionV20240509/Api.php @@ -12,17 +12,20 @@ class Api extends BaseResource { /** * @param string $shipmentId ID for the shipment. A shipment contains the cases being inbounded. + * @param ?string $skuQuantities If equal to `SHOW`, the response includes the shipment SKU quantity details. + * + * Defaults to `HIDE`, in which case the response does not contain SKU quantities */ - public function getInboundShipment(string $shipmentId): Response + public function getInboundShipment(string $shipmentId, ?string $skuQuantities = null): Response { - $request = new GetInboundShipment($shipmentId); + $request = new GetInboundShipment($shipmentId, $skuQuantities); return $this->connector->send($request); } /** - * @param ?string $sortBy Field to sort results by. Required if `sortOrder` is provided. - * @param ?string $sortOrder Sort the response in `ASCENDING` or `DESCENDING` order. + * @param ?string $sortBy Field to sort results by. By default, the response will be sorted by UPDATED_AT. + * @param ?string $sortOrder Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. * @param ?string $shipmentStatus Filter by inbound shipment status. * @param ?\DateTimeInterface $updatedAfter List the inbound shipments that were updated after a certain time (inclusive). The date must be in ISO 8601 format. * @param ?\DateTimeInterface $updatedBefore List the inbound shipments that were updated before a certain time (inclusive). The date must be in ISO 8601 format. diff --git a/src/Seller/AmazonWarehousingAndDistributionV20240509/Dto/InventorySummary.php b/src/Seller/AmazonWarehousingAndDistributionV20240509/Dto/InventorySummary.php index a4fb7cfc4..5bf4d689c 100644 --- a/src/Seller/AmazonWarehousingAndDistributionV20240509/Dto/InventorySummary.php +++ b/src/Seller/AmazonWarehousingAndDistributionV20240509/Dto/InventorySummary.php @@ -17,11 +17,13 @@ final class InventorySummary extends Dto /** * @param string $sku The seller or merchant SKU. * @param ?InventoryDetails $inventoryDetails Additional inventory details. This object is only displayed if the details parameter in the request is set to `SHOW`. + * @param ?int $totalInboundQuantity Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Center * @param ?int $totalOnhandQuantity Total quantity that is present in AWD distribution centers. */ public function __construct( public readonly string $sku, public readonly ?InventoryDetails $inventoryDetails = null, + public readonly ?int $totalInboundQuantity = null, public readonly ?int $totalOnhandQuantity = null, ) {} } diff --git a/src/Seller/AmazonWarehousingAndDistributionV20240509/Dto/SkuQuantity.php b/src/Seller/AmazonWarehousingAndDistributionV20240509/Dto/SkuQuantity.php new file mode 100644 index 000000000..1ae99a59b --- /dev/null +++ b/src/Seller/AmazonWarehousingAndDistributionV20240509/Dto/SkuQuantity.php @@ -0,0 +1,27 @@ +json()); } + + public function defaultQuery(): array + { + return array_filter(['skuQuantities' => $this->skuQuantities]); + } } diff --git a/src/Seller/AmazonWarehousingAndDistributionV20240509/Requests/ListInboundShipments.php b/src/Seller/AmazonWarehousingAndDistributionV20240509/Requests/ListInboundShipments.php index b52149c03..066ce72a7 100644 --- a/src/Seller/AmazonWarehousingAndDistributionV20240509/Requests/ListInboundShipments.php +++ b/src/Seller/AmazonWarehousingAndDistributionV20240509/Requests/ListInboundShipments.php @@ -25,8 +25,8 @@ class ListInboundShipments extends Request protected Method $method = Method::GET; /** - * @param ?string $sortBy Field to sort results by. Required if `sortOrder` is provided. - * @param ?string $sortOrder Sort the response in `ASCENDING` or `DESCENDING` order. + * @param ?string $sortBy Field to sort results by. By default, the response will be sorted by UPDATED_AT. + * @param ?string $sortOrder Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order. * @param ?string $shipmentStatus Filter by inbound shipment status. * @param ?\DateTimeInterface $updatedAfter List the inbound shipments that were updated after a certain time (inclusive). The date must be in ISO 8601 format. * @param ?\DateTimeInterface $updatedBefore List the inbound shipments that were updated before a certain time (inclusive). The date must be in ISO 8601 format. diff --git a/src/Seller/AmazonWarehousingAndDistributionV20240509/Responses/InboundShipment.php b/src/Seller/AmazonWarehousingAndDistributionV20240509/Responses/InboundShipment.php index fd48a1cce..070ae8fd1 100644 --- a/src/Seller/AmazonWarehousingAndDistributionV20240509/Responses/InboundShipment.php +++ b/src/Seller/AmazonWarehousingAndDistributionV20240509/Responses/InboundShipment.php @@ -15,12 +15,14 @@ use SellingPartnerApi\Seller\AmazonWarehousingAndDistributionV20240509\Dto\CarrierCode; use SellingPartnerApi\Seller\AmazonWarehousingAndDistributionV20240509\Dto\DistributionPackageQuantity; use SellingPartnerApi\Seller\AmazonWarehousingAndDistributionV20240509\Dto\InventoryQuantity; +use SellingPartnerApi\Seller\AmazonWarehousingAndDistributionV20240509\Dto\SkuQuantity; final class InboundShipment extends Response { protected static array $complexArrayTypes = [ 'shipmentContainerQuantities' => DistributionPackageQuantity::class, 'receivedQuantity' => InventoryQuantity::class, + 'shipmentSkuQuantities' => SkuQuantity::class, ]; /** @@ -35,6 +37,7 @@ final class InboundShipment extends Response * @param ?string $externalReferenceId Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record. * @param InventoryQuantity[]|null $receivedQuantity Quantity received (at the receiving end) as part of this shipment. * @param ?\DateTimeInterface $shipBy Timestamp when the shipment will be shipped. + * @param SkuQuantity[]|null $shipmentSkuQuantities Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW. * @param ?string $trackingId Carrier-unique tracking ID for this shipment. * @param ?\DateTimeInterface $updatedAt Timestamp when the shipment was updated. The date is returned in ISO 8601 format. * @param ?string $warehouseReferenceId An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking. @@ -51,6 +54,7 @@ public function __construct( public readonly ?string $externalReferenceId = null, public readonly ?array $receivedQuantity = null, public readonly ?\DateTimeInterface $shipBy = null, + public readonly ?array $shipmentSkuQuantities = null, public readonly ?string $trackingId = null, public readonly ?\DateTimeInterface $updatedAt = null, public readonly ?string $warehouseReferenceId = null, diff --git a/src/Seller/ApplicationManagementV20231130/Api.php b/src/Seller/ApplicationManagementV20231130/Api.php index 7ea508a29..5545103b1 100644 --- a/src/Seller/ApplicationManagementV20231130/Api.php +++ b/src/Seller/ApplicationManagementV20231130/Api.php @@ -10,7 +10,7 @@ class Api extends BaseResource { public function rotateApplicationClientSecret(): Response { - $request = new RotateApplicationClientSecret(); + $request = new RotateApplicationClientSecret; return $this->connector->send($request); } diff --git a/src/Seller/CatalogItemsV0/Dto/IdentifierType.php b/src/Seller/CatalogItemsV0/Dto/IdentifierType.php index 04ca149be..ca73e389a 100644 --- a/src/Seller/CatalogItemsV0/Dto/IdentifierType.php +++ b/src/Seller/CatalogItemsV0/Dto/IdentifierType.php @@ -16,10 +16,6 @@ final class IdentifierType extends Dto { protected static array $attributeMap = ['marketplaceAsin' => 'MarketplaceASIN', 'skuIdentifier' => 'SKUIdentifier']; - /** - * @param ?AsinIdentifier $marketplaceAsin - * @param ?SellerSkuIdentifier $skuIdentifier - */ public function __construct( public readonly ?AsinIdentifier $marketplaceAsin = null, public readonly ?SellerSkuIdentifier $skuIdentifier = null, diff --git a/src/Seller/CatalogItemsV0/Dto/RelationshipType.php b/src/Seller/CatalogItemsV0/Dto/RelationshipType.php index ee76ba866..eb362a9d1 100644 --- a/src/Seller/CatalogItemsV0/Dto/RelationshipType.php +++ b/src/Seller/CatalogItemsV0/Dto/RelationshipType.php @@ -41,7 +41,6 @@ final class RelationshipType extends Dto ]; /** - * @param ?IdentifierType $identifiers * @param ?string $color The color variation of the item. * @param ?string $edition The edition variation of the item. * @param ?string $flavor The flavor variation of the item. diff --git a/src/Seller/CatalogItemsV0/Responses/ListCatalogItemsResponse.php b/src/Seller/CatalogItemsV0/Responses/ListCatalogItemsResponse.php index 5a8c1cce4..f7d09a30d 100644 --- a/src/Seller/CatalogItemsV0/Responses/ListCatalogItemsResponse.php +++ b/src/Seller/CatalogItemsV0/Responses/ListCatalogItemsResponse.php @@ -17,7 +17,6 @@ final class ListCatalogItemsResponse extends Response { /** - * @param ?ListMatchingItemsResponse $payload * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ public function __construct( diff --git a/src/Seller/FBAInventoryV1/Dto/InventorySummary.php b/src/Seller/FBAInventoryV1/Dto/InventorySummary.php index 23fd2d119..5dbcea269 100644 --- a/src/Seller/FBAInventoryV1/Dto/InventorySummary.php +++ b/src/Seller/FBAInventoryV1/Dto/InventorySummary.php @@ -23,6 +23,7 @@ final class InventorySummary extends Dto * @param ?\DateTimeInterface $lastUpdatedTime The date and time that any quantity was last updated. * @param ?string $productName The localized language product title of the item within the specific marketplace. * @param ?int $totalQuantity The total number of units in an inbound shipment or in Amazon fulfillment centers. + * @param ?string[] $stores A list of seller-enrolled stores that apply to this seller SKU. */ public function __construct( public readonly ?string $asin = null, @@ -33,5 +34,6 @@ public function __construct( public readonly ?\DateTimeInterface $lastUpdatedTime = null, public readonly ?string $productName = null, public readonly ?int $totalQuantity = null, + public readonly ?array $stores = null, ) {} } diff --git a/src/Seller/FBAOutboundV20200701/Api.php b/src/Seller/FBAOutboundV20200701/Api.php index 4ba384218..77ca2f1d1 100644 --- a/src/Seller/FBAOutboundV20200701/Api.php +++ b/src/Seller/FBAOutboundV20200701/Api.php @@ -170,10 +170,15 @@ public function getFeatures(string $marketplaceId): Response * @param string $featureName The name of the feature for which to return a list of eligible inventory. * @param string $marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature. * @param ?string $nextToken A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page. + * @param ?\DateTimeInterface $queryStartDate A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ */ - public function getFeatureInventory(string $featureName, string $marketplaceId, ?string $nextToken = null): Response - { - $request = new GetFeatureInventory($featureName, $marketplaceId, $nextToken); + public function getFeatureInventory( + string $featureName, + string $marketplaceId, + ?string $nextToken = null, + ?\DateTimeInterface $queryStartDate = null, + ): Response { + $request = new GetFeatureInventory($featureName, $marketplaceId, $nextToken, $queryStartDate); return $this->connector->send($request); } diff --git a/src/Seller/FBAOutboundV20200701/Dto/DeliveryDocument.php b/src/Seller/FBAOutboundV20200701/Dto/DeliveryDocument.php new file mode 100644 index 000000000..564b28464 --- /dev/null +++ b/src/Seller/FBAOutboundV20200701/Dto/DeliveryDocument.php @@ -0,0 +1,25 @@ + DeliveryDocument::class]; + + /** + * @param DeliveryDocument[]|null $deliveryDocumentList A list of delivery documents for a package. + * @param ?DropOffLocation $dropOffLocation The preferred location to leave packages at the destination address. + */ + public function __construct( + public readonly ?array $deliveryDocumentList = null, + public readonly ?DropOffLocation $dropOffLocation = null, + ) {} +} diff --git a/src/Seller/FBAOutboundV20200701/Dto/FulfillmentShipmentPackage.php b/src/Seller/FBAOutboundV20200701/Dto/FulfillmentShipmentPackage.php index 73fa3c0d2..da6d3b991 100644 --- a/src/Seller/FBAOutboundV20200701/Dto/FulfillmentShipmentPackage.php +++ b/src/Seller/FBAOutboundV20200701/Dto/FulfillmentShipmentPackage.php @@ -19,7 +19,8 @@ final class FulfillmentShipmentPackage extends Dto * @param string $carrierCode Identifies the carrier who will deliver the shipment to the recipient. * @param ?string $trackingNumber The tracking number, if provided, can be used to obtain tracking and delivery information. * @param ?\DateTimeInterface $estimatedArrivalDate Date timestamp - * @param ?LockerDetails $lockerDetails The locker details, if provided can be used to access locker delivery box. + * @param ?LockerDetails $lockerDetails The locker details, which you can use to access the locker delivery box. + * @param ?DeliveryInformation $deliveryInformation The delivery information for the package. This information is available after the package is delivered. */ public function __construct( public readonly int $packageNumber, @@ -27,5 +28,6 @@ public function __construct( public readonly ?string $trackingNumber = null, public readonly ?\DateTimeInterface $estimatedArrivalDate = null, public readonly ?LockerDetails $lockerDetails = null, + public readonly ?DeliveryInformation $deliveryInformation = null, ) {} } diff --git a/src/Seller/FBAOutboundV20200701/Requests/GetFeatureInventory.php b/src/Seller/FBAOutboundV20200701/Requests/GetFeatureInventory.php index 59d631c8e..6117557cc 100644 --- a/src/Seller/FBAOutboundV20200701/Requests/GetFeatureInventory.php +++ b/src/Seller/FBAOutboundV20200701/Requests/GetFeatureInventory.php @@ -27,11 +27,13 @@ class GetFeatureInventory extends Request * @param string $featureName The name of the feature for which to return a list of eligible inventory. * @param string $marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature. * @param ?string $nextToken A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page. + * @param ?\DateTimeInterface $queryStartDate A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ */ public function __construct( protected string $featureName, protected string $marketplaceId, protected ?string $nextToken = null, + protected ?\DateTimeInterface $queryStartDate = null, ) {} public function resolveEndpoint(): string @@ -52,6 +54,10 @@ public function createDtoFromResponse(Response $response): GetFeatureInventoryRe public function defaultQuery(): array { - return array_filter(['marketplaceId' => $this->marketplaceId, 'nextToken' => $this->nextToken]); + return array_filter([ + 'marketplaceId' => $this->marketplaceId, + 'nextToken' => $this->nextToken, + 'queryStartDate' => $this->queryStartDate?->format('Y-m-d\TH:i:s\Z'), + ]); } } diff --git a/src/Seller/FinancesV0/Api.php b/src/Seller/FinancesV0/Api.php index 90c6877d9..785a80ef8 100644 --- a/src/Seller/FinancesV0/Api.php +++ b/src/Seller/FinancesV0/Api.php @@ -12,10 +12,10 @@ class Api extends BaseResource { /** - * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - * @param ?\DateTimeInterface $financialEventGroupStartedBefore A date used for selecting financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned. - * @param ?\DateTimeInterface $financialEventGroupStartedAfter A date used for selecting financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be no later than two minutes before the request was submitted. - * @param ?string $nextToken A string token returned in the response of your previous request. + * @param ?int $maxResultsPerPage The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * @param ?\DateTimeInterface $financialEventGroupStartedBefore A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned. + * @param ?\DateTimeInterface $financialEventGroupStartedAfter A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request. + * @param ?string $nextToken The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. */ public function listFinancialEventGroups( ?int $maxResultsPerPage = null, @@ -30,10 +30,14 @@ public function listFinancialEventGroups( /** * @param string $eventGroupId The identifier of the financial event group to which the events belong. - * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - * @param ?\DateTimeInterface $postedAfter A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. - * @param ?\DateTimeInterface $postedBefore A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two minutes. - * @param ?string $nextToken A string token returned in the response of your previous request. + * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * @param ?\DateTimeInterface $postedAfter The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. + * @param ?\DateTimeInterface $postedBefore The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * + * The date-time must be later than `PostedAfter` and more than two minutes before the requestd was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. + * + * **Default:** Two minutes before the time of the request. + * @param ?string $nextToken The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. */ public function listFinancialEventsByGroupId( string $eventGroupId, @@ -49,8 +53,8 @@ public function listFinancialEventsByGroupId( /** * @param string $orderId An Amazon-defined order identifier, in 3-7-7 format. - * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - * @param ?string $nextToken A string token returned in the response of your previous request. + * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * @param ?string $nextToken The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. */ public function listFinancialEventsByOrderId( string $orderId, @@ -63,10 +67,14 @@ public function listFinancialEventsByOrderId( } /** - * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - * @param ?\DateTimeInterface $postedAfter A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. - * @param ?\DateTimeInterface $postedBefore A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes. - * @param ?string $nextToken A string token returned in the response of your previous request. + * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * @param ?\DateTimeInterface $postedAfter The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. + * @param ?\DateTimeInterface $postedBefore The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * + * The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. + * + * **Default:** Two minutes before the time of the request. + * @param ?string $nextToken The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. */ public function listFinancialEvents( ?int $maxResultsPerPage = null, diff --git a/src/Seller/FinancesV0/Dto/AdhocDisbursementEvent.php b/src/Seller/FinancesV0/Dto/AdhocDisbursementEvent.php index d1cdc282b..17b846a2c 100644 --- a/src/Seller/FinancesV0/Dto/AdhocDisbursementEvent.php +++ b/src/Seller/FinancesV0/Dto/AdhocDisbursementEvent.php @@ -22,10 +22,8 @@ final class AdhocDisbursementEvent extends Dto ]; /** - * @param ?string $transactionType Indicates the type of transaction. - * - * Example: "Disbursed to Amazon Gift Card balance" - * @param ?\DateTimeInterface $postedDate + * @param ?string $transactionType The type of transaction. For example, "Disbursed to Amazon Gift Card balance". + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $transactionId The identifier for the transaction. * @param ?Currency $transactionAmount A currency type and amount. */ diff --git a/src/Seller/FinancesV0/Dto/AdjustmentEvent.php b/src/Seller/FinancesV0/Dto/AdjustmentEvent.php index 41b4dadd4..190c37bf4 100644 --- a/src/Seller/FinancesV0/Dto/AdjustmentEvent.php +++ b/src/Seller/FinancesV0/Dto/AdjustmentEvent.php @@ -28,22 +28,15 @@ final class AdjustmentEvent extends Dto * * Possible values: * - * * FBAInventoryReimbursement - An FBA inventory reimbursement to a seller's account. This occurs if a seller's inventory is damaged. - * - * * ReserveEvent - A reserve event that is generated at the time of a settlement period closing. This occurs when some money from a seller's account is held back. - * - * * PostageBilling - The amount paid by a seller for shipping labels. - * - * * PostageRefund - The reimbursement of shipping labels purchased for orders that were canceled or refunded. - * - * * LostOrDamagedReimbursement - An Amazon Easy Ship reimbursement to a seller's account for a package that we lost or damaged. - * - * * CanceledButPickedUpReimbursement - An Amazon Easy Ship reimbursement to a seller's account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace. - * - * * ReimbursementClawback - An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace. - * - * * SellerRewards - An award credited to a seller's account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace. - * @param ?\DateTimeInterface $postedDate + * * `FBAInventoryReimbursement`: An FBA inventory reimbursement to a seller's account. This occurs if a seller's inventory is damaged. + * * `ReserveEvent`: A reserve event that is generated at the time a settlement period closes. This occurs when some money from a seller's account is held back. + * * `PostageBilling`: The amount paid by a seller for shipping labels. + * * `PostageRefund`: The reimbursement of shipping labels purchased for orders that were canceled or refunded. + * * `LostOrDamagedReimbursement`: An Amazon Easy Ship reimbursement to a seller's account for a package that we lost or damaged. + * * `CanceledButPickedUpReimbursement`: An Amazon Easy Ship reimbursement to a seller's account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace. + * * `ReimbursementClawback`: An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace. + * * `SellerRewards`: An award credited to a seller's account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace. + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?Currency $adjustmentAmount A currency type and amount. * @param AdjustmentItem[]|null $adjustmentItemList A list of information about items in an adjustment to the seller's account. */ diff --git a/src/Seller/FinancesV0/Dto/AdjustmentItem.php b/src/Seller/FinancesV0/Dto/AdjustmentItem.php index 4a5ed4b9d..8a1e0a70f 100644 --- a/src/Seller/FinancesV0/Dto/AdjustmentItem.php +++ b/src/Seller/FinancesV0/Dto/AdjustmentItem.php @@ -25,7 +25,7 @@ final class AdjustmentItem extends Dto ]; /** - * @param ?string $quantity Represents the number of units in the seller's inventory when the AdustmentType is FBAInventoryReimbursement. + * @param ?string $quantity Represents the number of units in the seller's inventory when the `AdjustmentType` is `FBAInventoryReimbursement`. * @param ?Currency $perUnitAmount A currency type and amount. * @param ?Currency $totalAmount A currency type and amount. * @param ?string $sellerSku The seller SKU of the item. The seller SKU is qualified by the seller's seller ID, which is included with every call to the Selling Partner API. diff --git a/src/Seller/FinancesV0/Dto/AffordabilityExpenseEvent.php b/src/Seller/FinancesV0/Dto/AffordabilityExpenseEvent.php index af65ede1d..2d15badd1 100644 --- a/src/Seller/FinancesV0/Dto/AffordabilityExpenseEvent.php +++ b/src/Seller/FinancesV0/Dto/AffordabilityExpenseEvent.php @@ -31,15 +31,14 @@ final class AffordabilityExpenseEvent extends Dto * @param Currency $taxTypeSgst A currency type and amount. * @param Currency $taxTypeIgst A currency type and amount. * @param ?string $amazonOrderId An Amazon-defined identifier for an order. - * @param ?\DateTimeInterface $postedDate - * @param ?string $marketplaceId An encrypted, Amazon-defined marketplace identifier. - * @param ?string $transactionType Indicates the type of transaction. + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * @param ?string $marketplaceId The Amazon-defined marketplace identifier. + * @param ?string $transactionType The type of transaction. * * Possible values: * - * * Charge - For an affordability promotion expense. - * - * * Refund - For an affordability promotion expense reversal. + * * `Charge`: an affordability promotion expense. + * * `Refund`: an affordability promotion expense reversal. * @param ?Currency $baseExpense A currency type and amount. * @param ?Currency $totalExpense A currency type and amount. */ diff --git a/src/Seller/FinancesV0/Dto/CapacityReservationBillingEvent.php b/src/Seller/FinancesV0/Dto/CapacityReservationBillingEvent.php index 8a695a4dc..72c11744a 100644 --- a/src/Seller/FinancesV0/Dto/CapacityReservationBillingEvent.php +++ b/src/Seller/FinancesV0/Dto/CapacityReservationBillingEvent.php @@ -22,8 +22,8 @@ final class CapacityReservationBillingEvent extends Dto ]; /** - * @param ?string $transactionType Indicates the type of transaction. For example, FBA Inventory Fee - * @param ?\DateTimeInterface $postedDate + * @param ?string $transactionType The transaction type. For example, FBA Inventory Fee. + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $description A short description of the capacity reservation billing event. * @param ?Currency $transactionAmount A currency type and amount. */ diff --git a/src/Seller/FinancesV0/Dto/ChargeRefundEvent.php b/src/Seller/FinancesV0/Dto/ChargeRefundEvent.php index a5cc3d19d..beed0a82b 100644 --- a/src/Seller/FinancesV0/Dto/ChargeRefundEvent.php +++ b/src/Seller/FinancesV0/Dto/ChargeRefundEvent.php @@ -24,13 +24,9 @@ final class ChargeRefundEvent extends Dto protected static array $complexArrayTypes = ['chargeRefundTransactions' => ChargeRefundTransaction::class]; /** - * @param ?\DateTimeInterface $postedDate - * @param ?string $reasonCode The reason given for a charge refund. - * - * Example: `SubscriptionFeeCorrection` - * @param ?string $reasonCodeDescription A description of the Reason Code. - * - * Example: `SubscriptionFeeCorrection` + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * @param ?string $reasonCode The reason given for a charge refund. For example, `SubscriptionFeeCorrection`. + * @param ?string $reasonCodeDescription A description of the Reason Code. For example, `SubscriptionFeeCorrection`. * @param ChargeRefundTransaction[]|null $chargeRefundTransactions A list of `ChargeRefund` transactions */ public function __construct( diff --git a/src/Seller/FinancesV0/Dto/CouponPaymentEvent.php b/src/Seller/FinancesV0/Dto/CouponPaymentEvent.php index 92e52ee95..b654c4d5d 100644 --- a/src/Seller/FinancesV0/Dto/CouponPaymentEvent.php +++ b/src/Seller/FinancesV0/Dto/CouponPaymentEvent.php @@ -26,7 +26,7 @@ final class CouponPaymentEvent extends Dto ]; /** - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $couponId A coupon identifier. * @param ?string $sellerCouponDescription The description provided by the seller when they created the coupon. * @param ?int $clipOrRedemptionCount The number of coupon clips or redemptions. @@ -36,67 +36,67 @@ final class CouponPaymentEvent extends Dto * * Possible values: * - * * Principal - The selling price of the order item, equal to the selling price of the item multiplied by the quantity ordered. + * * `Principal`: The selling price of the order item, which is equal to the selling price of the item multiplied by the quantity ordered. * - * * Tax - The tax collected by the seller on the Principal. + * * `Tax`: The tax on the principal that is collected by the seller. * - * * MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal. + * * `MarketplaceFacilitatorTax-Principal`: The tax that is withheld on the principal. * - * * MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge. + * * `MarketplaceFacilitatorTax-Shipping`: The tax that is withheld on the `ShippingCharge`. * - * * MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge. + * * `MarketplaceFacilitatorTax-Giftwrap`: The tax that is withheld on the Giftwrap charge. * - * * MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges. + * * `MarketplaceFacilitatorTax-Other`: The tax that is withheld on other miscellaneous charges. * - * * Discount - The promotional discount for an order item. + * * `Discount`: The promotional discount for an order item. * - * * TaxDiscount - The tax amount deducted for promotional rebates. + * * `TaxDiscount`: The tax that is deducted for promotional rebates. * - * * CODItemCharge - The COD charge for an order item. + * * `CODItemCharge`: The COD charge for an order item. * - * * CODItemTaxCharge - The tax collected by the seller on a CODItemCharge. + * * `CODItemTaxCharge`: The tax that is collected by the seller on a `CODItemCharge`. * - * * CODOrderCharge - The COD charge for an order. + * * `CODOrderCharge`: The COD charge for an order. * - * * CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge. + * * `CODOrderTaxCharge`: The tax that is collected by the seller on a `CODOrderCharge`. * - * * CODShippingCharge - Shipping charges for a COD order. + * * `CODShippingCharge`: Shipping charges for a COD order. * - * * CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge. + * * `CODShippingTaxCharge`: The tax that is collected by the seller on a `CODShippingCharge`. * - * * ShippingCharge - The shipping charge. + * * `ShippingCharge`: The shipping charge. * - * * ShippingTax - The tax collected by the seller on a ShippingCharge. + * * `ShippingTax`: The tax that is collected by the seller on a `ShippingCharge`. * - * * Goodwill - The amount given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. + * * `Goodwill`: The amount of money that is given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. * - * * Giftwrap - The gift wrap charge. + * * `Giftwrap`: The gift wrap charge. * - * * GiftwrapTax - The tax collected by the seller on a Giftwrap charge. + * * `GiftwrapTax`: The tax that is collected by the seller on a gift wrap charge. * - * * RestockingFee - The charge applied to the buyer when returning a product in certain categories. + * * `RestockingFee`: The charge that is applied to the buyer when returning a product in certain categories. * - * * ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event we are at fault. + * * `ReturnShipping`: The amount of money that is given to the buyer to compensate for shipping the item back if we are at fault. * - * * PointsFee - The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. + * * `PointsFee`: The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. * - * * GenericDeduction - A generic bad debt deduction. + * * `GenericDeduction`: A generic bad debt deduction. * - * * FreeReplacementReturnShipping - The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. + * * `FreeReplacementReturnShipping`: The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. * - * * PaymentMethodFee - The fee collected for certain payment methods in certain marketplaces. + * * `PaymentMethodFee`: The fee that is collected for certain payment methods in certain marketplaces. * - * * ExportCharge - The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. + * * `ExportCharge`: The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. * - * * SAFE-TReimbursement - The SAFE-T claim amount for the item. + * * `SAFE-TReimbursement`: The SAFE-T claim amount for the item. * - * * TCS-CGST - Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). + * * `TCS-CGST`: Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). * - * * TCS-SGST - Tax Collected at Source for State Goods and Services Tax (SGST). + * * `TCS-SGST`: Tax Collected at Source for State Goods and Services Tax (SGST). * - * * TCS-IGST - Tax Collected at Source for Integrated Goods and Services Tax (IGST). + * * `TCS-IGST`: Tax Collected at Source for Integrated Goods and Services Tax (IGST). * - * * TCS-UTGST - Tax Collected at Source for Union Territories Goods and Services Tax (UTGST). + * * `TCS-UTGST`: Tax Collected at Source for Union Territories Goods and Services Tax (UTGST). * @param ?Currency $totalAmount A currency type and amount. */ public function __construct( diff --git a/src/Seller/FinancesV0/Dto/Currency.php b/src/Seller/FinancesV0/Dto/Currency.php index 863e20d6a..cadd07148 100644 --- a/src/Seller/FinancesV0/Dto/Currency.php +++ b/src/Seller/FinancesV0/Dto/Currency.php @@ -18,7 +18,7 @@ final class Currency extends Dto /** * @param ?string $currencyCode The three-digit currency code in ISO 4217 format. - * @param ?float $currencyAmount + * @param ?float $currencyAmount A signed decimal number. */ public function __construct( public readonly ?string $currencyCode = null, diff --git a/src/Seller/FinancesV0/Dto/DebtRecoveryEvent.php b/src/Seller/FinancesV0/Dto/DebtRecoveryEvent.php index 495aa3dee..1d79ba04e 100644 --- a/src/Seller/FinancesV0/Dto/DebtRecoveryEvent.php +++ b/src/Seller/FinancesV0/Dto/DebtRecoveryEvent.php @@ -32,11 +32,9 @@ final class DebtRecoveryEvent extends Dto * * Possible values: * - * * DebtPayment - * - * * DebtPaymentFailure - * - * *DebtAdjustment + * * `DebtPayment` + * * `DebtPaymentFailure` + * * `DebtAdjustment` * @param ?Currency $recoveryAmount A currency type and amount. * @param ?Currency $overPaymentCredit A currency type and amount. * @param DebtRecoveryItem[]|null $debtRecoveryItemList A list of debt recovery item information. diff --git a/src/Seller/FinancesV0/Dto/DebtRecoveryItem.php b/src/Seller/FinancesV0/Dto/DebtRecoveryItem.php index 8d2f9c22d..ff9cb21ae 100644 --- a/src/Seller/FinancesV0/Dto/DebtRecoveryItem.php +++ b/src/Seller/FinancesV0/Dto/DebtRecoveryItem.php @@ -24,8 +24,8 @@ final class DebtRecoveryItem extends Dto /** * @param ?Currency $recoveryAmount A currency type and amount. * @param ?Currency $originalAmount A currency type and amount. - * @param ?\DateTimeInterface $groupBeginDate - * @param ?\DateTimeInterface $groupEndDate + * @param ?\DateTimeInterface $groupBeginDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * @param ?\DateTimeInterface $groupEndDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. */ public function __construct( public readonly ?Currency $recoveryAmount = null, diff --git a/src/Seller/FinancesV0/Dto/DirectPayment.php b/src/Seller/FinancesV0/Dto/DirectPayment.php index e333d0230..4a721bcba 100644 --- a/src/Seller/FinancesV0/Dto/DirectPayment.php +++ b/src/Seller/FinancesV0/Dto/DirectPayment.php @@ -24,17 +24,17 @@ final class DirectPayment extends Dto * * Possible values: * - * * StoredValueCardRevenue - The amount that is deducted from the seller's account because the seller received money through a stored value card. + * * `StoredValueCardRevenue` - The amount that is deducted from the seller's account because the seller received money through a stored value card. * - * * StoredValueCardRefund - The amount that Amazon returns to the seller if the order that is bought using a stored value card is refunded. + * * `StoredValueCardRefund` - The amount that Amazon returns to the seller if the order that is purchased using a stored value card is refunded. * - * * PrivateLabelCreditCardRevenue - The amount that is deducted from the seller's account because the seller received money through a private label credit card offered by Amazon. + * * `PrivateLabelCreditCardRevenue` - The amount that is deducted from the seller's account because the seller received money through a private label credit card offered by Amazon. * - * * PrivateLabelCreditCardRefund - The amount that Amazon returns to the seller if the order that is bought using a private label credit card offered by Amazon is refunded. + * * `PrivateLabelCreditCardRefund` - The amount that Amazon returns to the seller if the order that is purchased using a private label credit card offered by Amazon is refunded. * - * * CollectOnDeliveryRevenue - The COD amount that the seller collected directly from the buyer. + * * `CollectOnDeliveryRevenue` - The COD amount that the seller collected directly from the buyer. * - * * CollectOnDeliveryRefund - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded. + * * `CollectOnDeliveryRefund` - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded. * @param ?Currency $directPaymentAmount A currency type and amount. */ public function __construct( diff --git a/src/Seller/FinancesV0/Dto/FailedAdhocDisbursementEvent.php b/src/Seller/FinancesV0/Dto/FailedAdhocDisbursementEvent.php index 70da4c450..1b9d5570e 100644 --- a/src/Seller/FinancesV0/Dto/FailedAdhocDisbursementEvent.php +++ b/src/Seller/FinancesV0/Dto/FailedAdhocDisbursementEvent.php @@ -25,19 +25,13 @@ final class FailedAdhocDisbursementEvent extends Dto ]; /** - * @param ?string $fundsTransfersType The type of fund transfer. - * - * Example "Refund" + * @param ?string $fundsTransfersType The type of fund transfer. For example, `Refund`. * @param ?string $transferId The transfer identifier. * @param ?string $disbursementId The disbursement identifier. - * @param ?string $paymentDisbursementType The type of payment for disbursement. - * - * Example `CREDIT_CARD` - * @param ?string $status The status of the failed `AdhocDisbursement`. - * - * Example `HARD_DECLINED` + * @param ?string $paymentDisbursementType The type of payment for disbursement. For example, `CREDIT_CARD`. + * @param ?string $status The status of the failed `AdhocDisbursement`. For example, `HARD_DECLINED`. * @param ?Currency $transferAmount A currency type and amount. - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. */ public function __construct( public readonly ?string $fundsTransfersType = null, diff --git a/src/Seller/FinancesV0/Dto/FbaLiquidationEvent.php b/src/Seller/FinancesV0/Dto/FbaLiquidationEvent.php index 4a488954e..8e5dca3c0 100644 --- a/src/Seller/FinancesV0/Dto/FbaLiquidationEvent.php +++ b/src/Seller/FinancesV0/Dto/FbaLiquidationEvent.php @@ -22,7 +22,7 @@ final class FbaLiquidationEvent extends Dto ]; /** - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $originalRemovalOrderId The identifier for the original removal order. * @param ?Currency $liquidationProceedsAmount A currency type and amount. * @param ?Currency $liquidationFeeAmount A currency type and amount. diff --git a/src/Seller/FinancesV0/Dto/FinancialEventGroup.php b/src/Seller/FinancesV0/Dto/FinancialEventGroup.php index 117e9b136..8678c9bba 100644 --- a/src/Seller/FinancesV0/Dto/FinancialEventGroup.php +++ b/src/Seller/FinancesV0/Dto/FinancialEventGroup.php @@ -34,18 +34,17 @@ final class FinancialEventGroup extends Dto * * Possible values: * - * * Open - * - * * Closed + * * `Open` + * * `Closed` * @param ?string $fundTransferStatus The status of the fund transfer. * @param ?Currency $originalTotal A currency type and amount. * @param ?Currency $convertedTotal A currency type and amount. - * @param ?\DateTimeInterface $fundTransferDate + * @param ?\DateTimeInterface $fundTransferDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $traceId The trace identifier used by sellers to look up transactions externally. * @param ?string $accountTail The account tail of the payment instrument. * @param ?Currency $beginningBalance A currency type and amount. - * @param ?\DateTimeInterface $financialEventGroupStart - * @param ?\DateTimeInterface $financialEventGroupEnd + * @param ?\DateTimeInterface $financialEventGroupStart A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * @param ?\DateTimeInterface $financialEventGroupEnd A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. */ public function __construct( public readonly ?string $financialEventGroupId = null, diff --git a/src/Seller/FinancesV0/Dto/FinancialEvents.php b/src/Seller/FinancesV0/Dto/FinancialEvents.php index 44b862557..a7a2e925f 100644 --- a/src/Seller/FinancesV0/Dto/FinancialEvents.php +++ b/src/Seller/FinancesV0/Dto/FinancialEvents.php @@ -93,8 +93,8 @@ final class FinancialEvents extends Dto * @param ShipmentEvent[]|null $guaranteeClaimEventList A list of shipment event information. * @param ShipmentEvent[]|null $chargebackEventList A list of shipment event information. * @param PayWithAmazonEvent[]|null $payWithAmazonEventList A list of events related to the seller's Pay with Amazon account. - * @param SolutionProviderCreditEvent[]|null $serviceProviderCreditEventList A list of information about solution provider credits. - * @param RetrochargeEvent[]|null $retrochargeEventList A list of information about Retrocharge or RetrochargeReversal events. + * @param SolutionProviderCreditEvent[]|null $serviceProviderCreditEventList A list of `SolutionProviderCreditEvent`. + * @param RetrochargeEvent[]|null $retrochargeEventList A list of information about `Retrocharge` or `RetrochargeReversal` events. * @param RentalTransactionEvent[]|null $rentalTransactionEventList A list of rental transaction event information. * @param ProductAdsPaymentEvent[]|null $productAdsPaymentEventList A list of sponsored products payment events. * @param ServiceFeeEvent[]|null $serviceFeeEventList A list of information about service fee events. @@ -102,7 +102,7 @@ final class FinancialEvents extends Dto * @param DebtRecoveryEvent[]|null $debtRecoveryEventList A list of debt recovery event information. * @param LoanServicingEvent[]|null $loanServicingEventList A list of loan servicing events. * @param AdjustmentEvent[]|null $adjustmentEventList A list of adjustment event information for the seller's account. - * @param SafetReimbursementEvent[]|null $safetReimbursementEventList A list of SAFETReimbursementEvents. + * @param SafetReimbursementEvent[]|null $safetReimbursementEventList A list of `SAFETReimbursementEvent`. * @param SellerReviewEnrollmentPaymentEvent[]|null $sellerReviewEnrollmentPaymentEventList A list of information about fee events for the Early Reviewer Program. * @param FbaLiquidationEvent[]|null $fbaLiquidationEventList A list of FBA inventory liquidation payment events. * @param CouponPaymentEvent[]|null $couponPaymentEventList A list of coupon payment event information. @@ -111,13 +111,13 @@ final class FinancialEvents extends Dto * @param AffordabilityExpenseEvent[]|null $affordabilityExpenseEventList A list of expense information related to an affordability promotion. * @param AffordabilityExpenseEvent[]|null $affordabilityExpenseReversalEventList A list of expense information related to an affordability promotion. * @param RemovalShipmentEvent[]|null $removalShipmentEventList A list of removal shipment event information. - * @param RemovalShipmentAdjustmentEvent[]|null $removalShipmentAdjustmentEventList A comma-delimited list of Removal shipmentAdjustment details for FBA inventory. + * @param RemovalShipmentAdjustmentEvent[]|null $removalShipmentAdjustmentEventList A comma-delimited list of `RemovalShipmentAdjustment` details for FBA inventory. * @param TrialShipmentEvent[]|null $trialShipmentEventList A list of information about trial shipment financial events. * @param TdsReimbursementEvent[]|null $tdsReimbursementEventList A list of `TDSReimbursementEvent` items. * @param AdhocDisbursementEvent[]|null $adhocDisbursementEventList A list of `AdhocDisbursement` events. - * @param TaxWithholdingEvent[]|null $taxWithholdingEventList A list of `TaxWithholding` events. + * @param TaxWithholdingEvent[]|null $taxWithholdingEventList A list of tax withholding events. * @param ChargeRefundEvent[]|null $chargeRefundEventList A list of charge refund events. - * @param FailedAdhocDisbursementEvent[]|null $failedAdhocDisbursementEventList A list of `FailedAdhocDisbursementEvent`s. + * @param FailedAdhocDisbursementEvent[]|null $failedAdhocDisbursementEventList A list of `FailedAdhocDisbursementEvent`. * @param ValueAddedServiceChargeEvent[]|null $valueAddedServiceChargeEventList A list of `ValueAddedServiceCharge` events. * @param CapacityReservationBillingEvent[]|null $capacityReservationBillingEventList A list of `CapacityReservationBillingEvent` events. */ diff --git a/src/Seller/FinancesV0/Dto/ImagingServicesFeeEvent.php b/src/Seller/FinancesV0/Dto/ImagingServicesFeeEvent.php index e188df91d..6409659b3 100644 --- a/src/Seller/FinancesV0/Dto/ImagingServicesFeeEvent.php +++ b/src/Seller/FinancesV0/Dto/ImagingServicesFeeEvent.php @@ -26,7 +26,7 @@ final class ImagingServicesFeeEvent extends Dto /** * @param ?string $imagingRequestBillingItemId The identifier for the imaging services request. * @param ?string $asin The Amazon Standard Identification Number (ASIN) of the item for which the imaging service was requested. - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param FeeComponent[]|null $feeList A list of fee component information. */ public function __construct( diff --git a/src/Seller/FinancesV0/Dto/ListFinancialEventsPayload.php b/src/Seller/FinancesV0/Dto/ListFinancialEventsPayload.php index 570f24c10..0a6e22263 100644 --- a/src/Seller/FinancesV0/Dto/ListFinancialEventsPayload.php +++ b/src/Seller/FinancesV0/Dto/ListFinancialEventsPayload.php @@ -18,7 +18,7 @@ final class ListFinancialEventsPayload extends Dto /** * @param ?string $nextToken When present and not empty, pass this string token in the next request to return the next response page. - * @param ?FinancialEvents $financialEvents Contains all information related to a financial event. + * @param ?FinancialEvents $financialEvents All the information that is related to a financial event. */ public function __construct( public readonly ?string $nextToken = null, diff --git a/src/Seller/FinancesV0/Dto/LoanServicingEvent.php b/src/Seller/FinancesV0/Dto/LoanServicingEvent.php index d503b14a4..6af4fb1f6 100644 --- a/src/Seller/FinancesV0/Dto/LoanServicingEvent.php +++ b/src/Seller/FinancesV0/Dto/LoanServicingEvent.php @@ -25,11 +25,11 @@ final class LoanServicingEvent extends Dto * * Possible values: * - * * LoanAdvance + * * `LoanAdvance` * - * * LoanPayment + * * `LoanPayment` * - * * LoanRefund + * * `LoanRefund` */ public function __construct( public readonly ?Currency $loanAmount = null, diff --git a/src/Seller/FinancesV0/Dto/NetworkComminglingTransactionEvent.php b/src/Seller/FinancesV0/Dto/NetworkComminglingTransactionEvent.php index 30d109c76..f7c746614 100644 --- a/src/Seller/FinancesV0/Dto/NetworkComminglingTransactionEvent.php +++ b/src/Seller/FinancesV0/Dto/NetworkComminglingTransactionEvent.php @@ -30,10 +30,10 @@ final class NetworkComminglingTransactionEvent extends Dto * * Possible values: * - * * NetCo - A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace. + * * `NetCo`: A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace. * - * * ComminglingVAT - A commingling VAT transaction. Available only in the UK, Spain, France, Germany, and Italy marketplaces. - * @param ?\DateTimeInterface $postedDate + * * `ComminglingVAT`: A commingling VAT transaction. Available only in the Spain, UK, France, Germany, and Italy marketplaces. + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $netCoTransactionId The identifier for the network item swap. * @param ?string $swapReason The reason for the network item swap. * @param ?string $asin The Amazon Standard Identification Number (ASIN) of the swapped item. diff --git a/src/Seller/FinancesV0/Dto/PayWithAmazonEvent.php b/src/Seller/FinancesV0/Dto/PayWithAmazonEvent.php index 1fc02c45d..8cd91af5d 100644 --- a/src/Seller/FinancesV0/Dto/PayWithAmazonEvent.php +++ b/src/Seller/FinancesV0/Dto/PayWithAmazonEvent.php @@ -31,89 +31,89 @@ final class PayWithAmazonEvent extends Dto /** * @param ?string $sellerOrderId An order identifier that is specified by the seller. - * @param ?\DateTimeInterface $transactionPostedDate + * @param ?\DateTimeInterface $transactionPostedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $businessObjectType The type of business object. * @param ?string $salesChannel The sales channel for the transaction. * @param ?ChargeComponent $charge A charge on the seller's account. * * Possible values: * - * * Principal - The selling price of the order item, equal to the selling price of the item multiplied by the quantity ordered. + * * `Principal`: The selling price of the order item, which is equal to the selling price of the item multiplied by the quantity ordered. * - * * Tax - The tax collected by the seller on the Principal. + * * `Tax`: The tax on the principal that is collected by the seller. * - * * MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal. + * * `MarketplaceFacilitatorTax-Principal`: The tax that is withheld on the principal. * - * * MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge. + * * `MarketplaceFacilitatorTax-Shipping`: The tax that is withheld on the `ShippingCharge`. * - * * MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge. + * * `MarketplaceFacilitatorTax-Giftwrap`: The tax that is withheld on the Giftwrap charge. * - * * MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges. + * * `MarketplaceFacilitatorTax-Other`: The tax that is withheld on other miscellaneous charges. * - * * Discount - The promotional discount for an order item. + * * `Discount`: The promotional discount for an order item. * - * * TaxDiscount - The tax amount deducted for promotional rebates. + * * `TaxDiscount`: The tax that is deducted for promotional rebates. * - * * CODItemCharge - The COD charge for an order item. + * * `CODItemCharge`: The COD charge for an order item. * - * * CODItemTaxCharge - The tax collected by the seller on a CODItemCharge. + * * `CODItemTaxCharge`: The tax that is collected by the seller on a `CODItemCharge`. * - * * CODOrderCharge - The COD charge for an order. + * * `CODOrderCharge`: The COD charge for an order. * - * * CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge. + * * `CODOrderTaxCharge`: The tax that is collected by the seller on a `CODOrderCharge`. * - * * CODShippingCharge - Shipping charges for a COD order. + * * `CODShippingCharge`: Shipping charges for a COD order. * - * * CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge. + * * `CODShippingTaxCharge`: The tax that is collected by the seller on a `CODShippingCharge`. * - * * ShippingCharge - The shipping charge. + * * `ShippingCharge`: The shipping charge. * - * * ShippingTax - The tax collected by the seller on a ShippingCharge. + * * `ShippingTax`: The tax that is collected by the seller on a `ShippingCharge`. * - * * Goodwill - The amount given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. + * * `Goodwill`: The amount of money that is given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. * - * * Giftwrap - The gift wrap charge. + * * `Giftwrap`: The gift wrap charge. * - * * GiftwrapTax - The tax collected by the seller on a Giftwrap charge. + * * `GiftwrapTax`: The tax that is collected by the seller on a gift wrap charge. * - * * RestockingFee - The charge applied to the buyer when returning a product in certain categories. + * * `RestockingFee`: The charge that is applied to the buyer when returning a product in certain categories. * - * * ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event we are at fault. + * * `ReturnShipping`: The amount of money that is given to the buyer to compensate for shipping the item back if we are at fault. * - * * PointsFee - The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. + * * `PointsFee`: The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. * - * * GenericDeduction - A generic bad debt deduction. + * * `GenericDeduction`: A generic bad debt deduction. * - * * FreeReplacementReturnShipping - The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. + * * `FreeReplacementReturnShipping`: The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. * - * * PaymentMethodFee - The fee collected for certain payment methods in certain marketplaces. + * * `PaymentMethodFee`: The fee that is collected for certain payment methods in certain marketplaces. * - * * ExportCharge - The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. + * * `ExportCharge`: The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. * - * * SAFE-TReimbursement - The SAFE-T claim amount for the item. + * * `SAFE-TReimbursement`: The SAFE-T claim amount for the item. * - * * TCS-CGST - Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). + * * `TCS-CGST`: Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). * - * * TCS-SGST - Tax Collected at Source for State Goods and Services Tax (SGST). + * * `TCS-SGST`: Tax Collected at Source for State Goods and Services Tax (SGST). * - * * TCS-IGST - Tax Collected at Source for Integrated Goods and Services Tax (IGST). + * * `TCS-IGST`: Tax Collected at Source for Integrated Goods and Services Tax (IGST). * - * * TCS-UTGST - Tax Collected at Source for Union Territories Goods and Services Tax (UTGST). + * * `TCS-UTGST`: Tax Collected at Source for Union Territories Goods and Services Tax (UTGST). * @param FeeComponent[]|null $feeList A list of fee component information. * @param ?string $paymentAmountType The type of payment. * * Possible values: * - * * Sales + * * `Sales` * @param ?string $amountDescription A short description of this payment event. * @param ?string $fulfillmentChannel The fulfillment channel. * * Possible values: * - * * AFN - Amazon Fulfillment Network (Fulfillment by Amazon) + * * `AFN`: Amazon Fulfillment Network (Fulfillment by Amazon) * - * * MFN - Merchant Fulfillment Network (self-fulfilled) - * @param ?string $storeName The store name where the event occurred. + * * `MFN`: Merchant Fulfillment Network (self-fulfilled) + * @param ?string $storeName The name of the store where the event occurred. */ public function __construct( public readonly ?string $sellerOrderId = null, diff --git a/src/Seller/FinancesV0/Dto/ProductAdsPaymentEvent.php b/src/Seller/FinancesV0/Dto/ProductAdsPaymentEvent.php index 9ab9cd7bb..1bd07e075 100644 --- a/src/Seller/FinancesV0/Dto/ProductAdsPaymentEvent.php +++ b/src/Seller/FinancesV0/Dto/ProductAdsPaymentEvent.php @@ -15,15 +15,15 @@ final class ProductAdsPaymentEvent extends Dto { /** - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $transactionType Indicates if the transaction is for a charge or a refund. * * Possible values: * - * * charge - Charge + * * `charge` * - * * refund - Refund - * @param ?string $invoiceId Identifier for the invoice that the transaction appears in. + * * `refund` + * @param ?string $invoiceId The identifier for the invoice that includes the transaction. * @param ?Currency $baseValue A currency type and amount. * @param ?Currency $taxValue A currency type and amount. * @param ?Currency $transactionValue A currency type and amount. diff --git a/src/Seller/FinancesV0/Dto/RemovalShipmentAdjustmentEvent.php b/src/Seller/FinancesV0/Dto/RemovalShipmentAdjustmentEvent.php index 61b32bdd0..a23c99774 100644 --- a/src/Seller/FinancesV0/Dto/RemovalShipmentAdjustmentEvent.php +++ b/src/Seller/FinancesV0/Dto/RemovalShipmentAdjustmentEvent.php @@ -28,7 +28,7 @@ final class RemovalShipmentAdjustmentEvent extends Dto ]; /** - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $adjustmentEventId The unique identifier for the adjustment event. * @param ?string $merchantOrderId The merchant removal orderId. * @param ?string $orderId The orderId for shipping inventory. @@ -36,8 +36,8 @@ final class RemovalShipmentAdjustmentEvent extends Dto * * Possible values: * - * * WHOLESALE_LIQUIDATION. - * @param RemovalShipmentItemAdjustment[]|null $removalShipmentItemAdjustmentList A comma-delimited list of Removal shipmentItemAdjustment details for FBA inventory. + * * `WHOLESALE_LIQUIDATION`. + * @param RemovalShipmentItemAdjustment[]|null $removalShipmentItemAdjustmentList A comma-delimited list of `RemovalShipmentItemAdjustment` details for FBA inventory. */ public function __construct( public readonly ?\DateTimeInterface $postedDate = null, diff --git a/src/Seller/FinancesV0/Dto/RemovalShipmentEvent.php b/src/Seller/FinancesV0/Dto/RemovalShipmentEvent.php index 6a230f931..717f2cd37 100644 --- a/src/Seller/FinancesV0/Dto/RemovalShipmentEvent.php +++ b/src/Seller/FinancesV0/Dto/RemovalShipmentEvent.php @@ -19,27 +19,30 @@ final class RemovalShipmentEvent extends Dto 'merchantOrderId' => 'MerchantOrderId', 'orderId' => 'OrderId', 'transactionType' => 'TransactionType', + 'storeName' => 'StoreName', 'removalShipmentItemList' => 'RemovalShipmentItemList', ]; protected static array $complexArrayTypes = ['removalShipmentItemList' => RemovalShipmentItem::class]; /** - * @param ?\DateTimeInterface $postedDate - * @param ?string $merchantOrderId The merchant removal orderId. + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * @param ?string $merchantOrderId The merchant removal `orderId`. * @param ?string $orderId The identifier for the removal shipment order. * @param ?string $transactionType The type of removal order. * * Possible values: * - * * WHOLESALE_LIQUIDATION - * @param RemovalShipmentItem[]|null $removalShipmentItemList A list of information about removal shipment items. + * * `WHOLESALE_LIQUIDATION` + * @param ?string $storeName The name of the store where the event occurred. + * @param RemovalShipmentItem[]|null $removalShipmentItemList A list of `RemovalShipmentItem`. */ public function __construct( public readonly ?\DateTimeInterface $postedDate = null, public readonly ?string $merchantOrderId = null, public readonly ?string $orderId = null, public readonly ?string $transactionType = null, + public readonly ?string $storeName = null, public readonly ?array $removalShipmentItemList = null, ) {} } diff --git a/src/Seller/FinancesV0/Dto/RemovalShipmentItem.php b/src/Seller/FinancesV0/Dto/RemovalShipmentItem.php index 5211f53ef..1fc9d7cbe 100644 --- a/src/Seller/FinancesV0/Dto/RemovalShipmentItem.php +++ b/src/Seller/FinancesV0/Dto/RemovalShipmentItem.php @@ -27,13 +27,12 @@ final class RemovalShipmentItem extends Dto /** * @param ?string $removalShipmentItemId An identifier for an item in a removal shipment. - * @param ?string $taxCollectionModel The tax collection model applied to the item. + * @param ?string $taxCollectionModel The tax collection model that is applied to the item. * * Possible values: * - * * MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. - * - * * Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon. + * * `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. + * * `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon. * @param ?string $fulfillmentNetworkSku The Amazon fulfillment network SKU for the item. * @param ?int $quantity The quantity of the item. * @param ?Currency $revenue A currency type and amount. diff --git a/src/Seller/FinancesV0/Dto/RemovalShipmentItemAdjustment.php b/src/Seller/FinancesV0/Dto/RemovalShipmentItemAdjustment.php index 673f35199..25849d843 100644 --- a/src/Seller/FinancesV0/Dto/RemovalShipmentItemAdjustment.php +++ b/src/Seller/FinancesV0/Dto/RemovalShipmentItemAdjustment.php @@ -26,15 +26,14 @@ final class RemovalShipmentItemAdjustment extends Dto /** * @param ?string $removalShipmentItemId An identifier for an item in a removal shipment. - * @param ?string $taxCollectionModel The tax collection model applied to the item. + * @param ?string $taxCollectionModel The tax collection model that is applied to the item. * * Possible values: * - * * MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. - * - * * Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon. + * * `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. + * * `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon. * @param ?string $fulfillmentNetworkSku The Amazon fulfillment network SKU for the item. - * @param ?int $adjustedQuantity Adjusted quantity of removal shipmentItemAdjustment items. + * @param ?int $adjustedQuantity Adjusted quantity of `RemovalShipmentItemAdjustment` items. * @param ?Currency $revenueAdjustment A currency type and amount. * @param ?Currency $taxAmountAdjustment A currency type and amount. * @param ?Currency $taxWithheldAdjustment A currency type and amount. diff --git a/src/Seller/FinancesV0/Dto/RentalTransactionEvent.php b/src/Seller/FinancesV0/Dto/RentalTransactionEvent.php index c518267c0..03444c138 100644 --- a/src/Seller/FinancesV0/Dto/RentalTransactionEvent.php +++ b/src/Seller/FinancesV0/Dto/RentalTransactionEvent.php @@ -39,21 +39,21 @@ final class RentalTransactionEvent extends Dto * * Possible values: * - * * RentalCustomerPayment-Buyout - Transaction type that represents when the customer wants to buy out a rented item. + * * `RentalCustomerPayment-Buyout`: A transaction type that represents when the customer wants to buy out a rented item. * - * * RentalCustomerPayment-Extension - Transaction type that represents when the customer wants to extend the rental period. + * * `RentalCustomerPayment-Extension`: A transaction type that represents when the customer wants to extend the rental period. * - * * RentalCustomerRefund-Buyout - Transaction type that represents when the customer requests a refund for the buyout of the rented item. + * * `RentalCustomerRefund-Buyout`: A transaction type that represents when the customer requests a refund for the buyout of the rented item. * - * * RentalCustomerRefund-Extension - Transaction type that represents when the customer requests a refund over the extension on the rented item. + * * `RentalCustomerRefund-Extension`: A transaction type that represents when the customer requests a refund over the extension on the rented item. * - * * RentalHandlingFee - Transaction type that represents the fee that Amazon charges sellers who rent through Amazon. + * * `RentalHandlingFee`: A transaction type that represents the fee that Amazon charges sellers who rent through Amazon. * - * * RentalChargeFailureReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a failed charge. + * * `RentalChargeFailureReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a failed charge. * - * * RentalLostItemReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a lost item. - * @param ?int $extensionLength The number of days that the buyer extended an already rented item. This value is only returned for RentalCustomerPayment-Extension and RentalCustomerRefund-Extension events. - * @param ?\DateTimeInterface $postedDate + * * `RentalLostItemReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a lost item. + * @param ?int $extensionLength The number of days that the buyer extended an already rented item. This value is only returned for `RentalCustomerPayment-Extension` and `RentalCustomerRefund-Extension` events. + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ChargeComponent[]|null $rentalChargeList A list of charge information on the seller's account. * @param FeeComponent[]|null $rentalFeeList A list of fee component information. * @param ?string $marketplaceName The name of the marketplace. diff --git a/src/Seller/FinancesV0/Dto/RetrochargeEvent.php b/src/Seller/FinancesV0/Dto/RetrochargeEvent.php index 2478fb59d..c757eb87f 100644 --- a/src/Seller/FinancesV0/Dto/RetrochargeEvent.php +++ b/src/Seller/FinancesV0/Dto/RetrochargeEvent.php @@ -31,11 +31,11 @@ final class RetrochargeEvent extends Dto * * Possible values: * - * * Retrocharge + * * `Retrocharge` * - * * RetrochargeReversal + * * `RetrochargeReversal` * @param ?string $amazonOrderId An Amazon-defined identifier for an order. - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?Currency $baseTax A currency type and amount. * @param ?Currency $shippingTax A currency type and amount. * @param ?string $marketplaceName The name of the marketplace where the retrocharge event occurred. diff --git a/src/Seller/FinancesV0/Dto/SafetReimbursementEvent.php b/src/Seller/FinancesV0/Dto/SafetReimbursementEvent.php index 318c6c4d1..3ea011322 100644 --- a/src/Seller/FinancesV0/Dto/SafetReimbursementEvent.php +++ b/src/Seller/FinancesV0/Dto/SafetReimbursementEvent.php @@ -25,11 +25,11 @@ final class SafetReimbursementEvent extends Dto protected static array $complexArrayTypes = ['safetReimbursementItemList' => SafetReimbursementItem::class]; /** - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $safetClaimId A SAFE-T claim identifier. * @param ?Currency $reimbursedAmount A currency type and amount. * @param ?string $reasonCode Indicates why the seller was reimbursed. - * @param SafetReimbursementItem[]|null $safetReimbursementItemList A list of SAFETReimbursementItems. + * @param SafetReimbursementItem[]|null $safetReimbursementItemList A list of `SAFETReimbursementItem`. */ public function __construct( public readonly ?\DateTimeInterface $postedDate = null, diff --git a/src/Seller/FinancesV0/Dto/SellerDealPaymentEvent.php b/src/Seller/FinancesV0/Dto/SellerDealPaymentEvent.php index e7a6e2116..3b167aeeb 100644 --- a/src/Seller/FinancesV0/Dto/SellerDealPaymentEvent.php +++ b/src/Seller/FinancesV0/Dto/SellerDealPaymentEvent.php @@ -15,11 +15,11 @@ final class SellerDealPaymentEvent extends Dto { /** - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $dealId The unique identifier of the deal. * @param ?string $dealDescription The internal description of the deal. - * @param ?string $eventType The type of event: SellerDealComplete. - * @param ?string $feeType The type of fee: RunLightningDealFee. + * @param ?string $eventType The type of event: `SellerDealComplete`. + * @param ?string $feeType The type of fee: `RunLightningDealFee`. * @param ?Currency $feeAmount A currency type and amount. * @param ?Currency $taxAmount A currency type and amount. * @param ?Currency $totalAmount A currency type and amount. diff --git a/src/Seller/FinancesV0/Dto/SellerReviewEnrollmentPaymentEvent.php b/src/Seller/FinancesV0/Dto/SellerReviewEnrollmentPaymentEvent.php index 2379862a6..2926badd9 100644 --- a/src/Seller/FinancesV0/Dto/SellerReviewEnrollmentPaymentEvent.php +++ b/src/Seller/FinancesV0/Dto/SellerReviewEnrollmentPaymentEvent.php @@ -24,7 +24,7 @@ final class SellerReviewEnrollmentPaymentEvent extends Dto ]; /** - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $enrollmentId An enrollment identifier. * @param ?string $parentAsin The Amazon Standard Identification Number (ASIN) of the item that was enrolled in the Early Reviewer Program. * @param ?FeeComponent $feeComponent A fee associated with the event. @@ -32,67 +32,67 @@ final class SellerReviewEnrollmentPaymentEvent extends Dto * * Possible values: * - * * Principal - The selling price of the order item, equal to the selling price of the item multiplied by the quantity ordered. + * * `Principal`: The selling price of the order item, which is equal to the selling price of the item multiplied by the quantity ordered. * - * * Tax - The tax collected by the seller on the Principal. + * * `Tax`: The tax on the principal that is collected by the seller. * - * * MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal. + * * `MarketplaceFacilitatorTax-Principal`: The tax that is withheld on the principal. * - * * MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge. + * * `MarketplaceFacilitatorTax-Shipping`: The tax that is withheld on the `ShippingCharge`. * - * * MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge. + * * `MarketplaceFacilitatorTax-Giftwrap`: The tax that is withheld on the Giftwrap charge. * - * * MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges. + * * `MarketplaceFacilitatorTax-Other`: The tax that is withheld on other miscellaneous charges. * - * * Discount - The promotional discount for an order item. + * * `Discount`: The promotional discount for an order item. * - * * TaxDiscount - The tax amount deducted for promotional rebates. + * * `TaxDiscount`: The tax that is deducted for promotional rebates. * - * * CODItemCharge - The COD charge for an order item. + * * `CODItemCharge`: The COD charge for an order item. * - * * CODItemTaxCharge - The tax collected by the seller on a CODItemCharge. + * * `CODItemTaxCharge`: The tax that is collected by the seller on a `CODItemCharge`. * - * * CODOrderCharge - The COD charge for an order. + * * `CODOrderCharge`: The COD charge for an order. * - * * CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge. + * * `CODOrderTaxCharge`: The tax that is collected by the seller on a `CODOrderCharge`. * - * * CODShippingCharge - Shipping charges for a COD order. + * * `CODShippingCharge`: Shipping charges for a COD order. * - * * CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge. + * * `CODShippingTaxCharge`: The tax that is collected by the seller on a `CODShippingCharge`. * - * * ShippingCharge - The shipping charge. + * * `ShippingCharge`: The shipping charge. * - * * ShippingTax - The tax collected by the seller on a ShippingCharge. + * * `ShippingTax`: The tax that is collected by the seller on a `ShippingCharge`. * - * * Goodwill - The amount given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. + * * `Goodwill`: The amount of money that is given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. * - * * Giftwrap - The gift wrap charge. + * * `Giftwrap`: The gift wrap charge. * - * * GiftwrapTax - The tax collected by the seller on a Giftwrap charge. + * * `GiftwrapTax`: The tax that is collected by the seller on a gift wrap charge. * - * * RestockingFee - The charge applied to the buyer when returning a product in certain categories. + * * `RestockingFee`: The charge that is applied to the buyer when returning a product in certain categories. * - * * ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event we are at fault. + * * `ReturnShipping`: The amount of money that is given to the buyer to compensate for shipping the item back if we are at fault. * - * * PointsFee - The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. + * * `PointsFee`: The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. * - * * GenericDeduction - A generic bad debt deduction. + * * `GenericDeduction`: A generic bad debt deduction. * - * * FreeReplacementReturnShipping - The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. + * * `FreeReplacementReturnShipping`: The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. * - * * PaymentMethodFee - The fee collected for certain payment methods in certain marketplaces. + * * `PaymentMethodFee`: The fee that is collected for certain payment methods in certain marketplaces. * - * * ExportCharge - The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. + * * `ExportCharge`: The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. * - * * SAFE-TReimbursement - The SAFE-T claim amount for the item. + * * `SAFE-TReimbursement`: The SAFE-T claim amount for the item. * - * * TCS-CGST - Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). + * * `TCS-CGST`: Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). * - * * TCS-SGST - Tax Collected at Source for State Goods and Services Tax (SGST). + * * `TCS-SGST`: Tax Collected at Source for State Goods and Services Tax (SGST). * - * * TCS-IGST - Tax Collected at Source for Integrated Goods and Services Tax (IGST). + * * `TCS-IGST`: Tax Collected at Source for Integrated Goods and Services Tax (IGST). * - * * TCS-UTGST - Tax Collected at Source for Union Territories Goods and Services Tax (UTGST). + * * `TCS-UTGST`: Tax Collected at Source for Union Territories Goods and Services Tax (UTGST). * @param ?Currency $totalAmount A currency type and amount. */ public function __construct( diff --git a/src/Seller/FinancesV0/Dto/ServiceFeeEvent.php b/src/Seller/FinancesV0/Dto/ServiceFeeEvent.php index 7b8a6665b..428b4e9f0 100644 --- a/src/Seller/FinancesV0/Dto/ServiceFeeEvent.php +++ b/src/Seller/FinancesV0/Dto/ServiceFeeEvent.php @@ -22,6 +22,7 @@ final class ServiceFeeEvent extends Dto 'fnSku' => 'FnSKU', 'feeDescription' => 'FeeDescription', 'asin' => 'ASIN', + 'storeName' => 'StoreName', ]; protected static array $complexArrayTypes = ['feeList' => FeeComponent::class]; @@ -34,6 +35,7 @@ final class ServiceFeeEvent extends Dto * @param ?string $fnSku A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center. * @param ?string $feeDescription A short description of the service fee event. * @param ?string $asin The Amazon Standard Identification Number (ASIN) of the item. + * @param ?string $storeName The name of the store where the event occurred. */ public function __construct( public readonly ?string $amazonOrderId = null, @@ -43,5 +45,6 @@ public function __construct( public readonly ?string $fnSku = null, public readonly ?string $feeDescription = null, public readonly ?string $asin = null, + public readonly ?string $storeName = null, ) {} } diff --git a/src/Seller/FinancesV0/Dto/ShipmentEvent.php b/src/Seller/FinancesV0/Dto/ShipmentEvent.php index d52f9fc3e..a462889a5 100644 --- a/src/Seller/FinancesV0/Dto/ShipmentEvent.php +++ b/src/Seller/FinancesV0/Dto/ShipmentEvent.php @@ -18,6 +18,7 @@ final class ShipmentEvent extends Dto 'amazonOrderId' => 'AmazonOrderId', 'sellerOrderId' => 'SellerOrderId', 'marketplaceName' => 'MarketplaceName', + 'storeName' => 'StoreName', 'orderChargeList' => 'OrderChargeList', 'orderChargeAdjustmentList' => 'OrderChargeAdjustmentList', 'shipmentFeeList' => 'ShipmentFeeList', @@ -46,6 +47,7 @@ final class ShipmentEvent extends Dto * @param ?string $amazonOrderId An Amazon-defined identifier for an order. * @param ?string $sellerOrderId A seller-defined identifier for an order. * @param ?string $marketplaceName The name of the marketplace where the event occurred. + * @param ?string $storeName The name of the store where the event occurred. * @param ChargeComponent[]|null $orderChargeList A list of charge information on the seller's account. * @param ChargeComponent[]|null $orderChargeAdjustmentList A list of charge information on the seller's account. * @param FeeComponent[]|null $shipmentFeeList A list of fee component information. @@ -53,7 +55,7 @@ final class ShipmentEvent extends Dto * @param FeeComponent[]|null $orderFeeList A list of fee component information. * @param FeeComponent[]|null $orderFeeAdjustmentList A list of fee component information. * @param DirectPayment[]|null $directPaymentList A list of direct payment information. - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ShipmentItem[]|null $shipmentItemList A list of shipment items. * @param ShipmentItem[]|null $shipmentItemAdjustmentList A list of shipment items. */ @@ -61,6 +63,7 @@ public function __construct( public readonly ?string $amazonOrderId = null, public readonly ?string $sellerOrderId = null, public readonly ?string $marketplaceName = null, + public readonly ?string $storeName = null, public readonly ?array $orderChargeList = null, public readonly ?array $orderChargeAdjustmentList = null, public readonly ?array $shipmentFeeList = null, diff --git a/src/Seller/FinancesV0/Dto/SolutionProviderCreditEvent.php b/src/Seller/FinancesV0/Dto/SolutionProviderCreditEvent.php index a084a7dd2..c8d2bebe3 100644 --- a/src/Seller/FinancesV0/Dto/SolutionProviderCreditEvent.php +++ b/src/Seller/FinancesV0/Dto/SolutionProviderCreditEvent.php @@ -37,7 +37,7 @@ final class SolutionProviderCreditEvent extends Dto * @param ?string $providerId The Amazon-defined identifier of the solution provider. * @param ?string $providerStoreName The store name where the payment event occurred. * @param ?Currency $transactionAmount A currency type and amount. - * @param ?\DateTimeInterface $transactionCreationDate + * @param ?\DateTimeInterface $transactionCreationDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. */ public function __construct( public readonly ?string $providerTransactionType = null, diff --git a/src/Seller/FinancesV0/Dto/TaxWithheldComponent.php b/src/Seller/FinancesV0/Dto/TaxWithheldComponent.php index df029b667..311813f04 100644 --- a/src/Seller/FinancesV0/Dto/TaxWithheldComponent.php +++ b/src/Seller/FinancesV0/Dto/TaxWithheldComponent.php @@ -26,9 +26,8 @@ final class TaxWithheldComponent extends Dto * * Possible values: * - * * MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. - * - * * Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon. + * * `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. + * * `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon. * @param ChargeComponent[]|null $taxesWithheld A list of charge information on the seller's account. */ public function __construct( diff --git a/src/Seller/FinancesV0/Dto/TaxWithholdingEvent.php b/src/Seller/FinancesV0/Dto/TaxWithholdingEvent.php index a51bdc838..8051c9cbe 100644 --- a/src/Seller/FinancesV0/Dto/TaxWithholdingEvent.php +++ b/src/Seller/FinancesV0/Dto/TaxWithholdingEvent.php @@ -22,10 +22,10 @@ final class TaxWithholdingEvent extends Dto ]; /** - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?Currency $baseAmount A currency type and amount. * @param ?Currency $withheldAmount A currency type and amount. - * @param ?TaxWithholdingPeriod $taxWithholdingPeriod Period which taxwithholding on seller's account is calculated. + * @param ?TaxWithholdingPeriod $taxWithholdingPeriod The period during which tax withholding on a seller's account is calculated. */ public function __construct( public readonly ?\DateTimeInterface $postedDate = null, diff --git a/src/Seller/FinancesV0/Dto/TaxWithholdingPeriod.php b/src/Seller/FinancesV0/Dto/TaxWithholdingPeriod.php index e6c61fa46..43dde73f4 100644 --- a/src/Seller/FinancesV0/Dto/TaxWithholdingPeriod.php +++ b/src/Seller/FinancesV0/Dto/TaxWithholdingPeriod.php @@ -17,8 +17,8 @@ final class TaxWithholdingPeriod extends Dto protected static array $attributeMap = ['startDate' => 'StartDate', 'endDate' => 'EndDate']; /** - * @param ?\DateTimeInterface $startDate - * @param ?\DateTimeInterface $endDate + * @param ?\DateTimeInterface $startDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * @param ?\DateTimeInterface $endDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. */ public function __construct( public readonly ?\DateTimeInterface $startDate = null, diff --git a/src/Seller/FinancesV0/Dto/TdsReimbursementEvent.php b/src/Seller/FinancesV0/Dto/TdsReimbursementEvent.php index 8040a44a2..3d498d90b 100644 --- a/src/Seller/FinancesV0/Dto/TdsReimbursementEvent.php +++ b/src/Seller/FinancesV0/Dto/TdsReimbursementEvent.php @@ -21,7 +21,7 @@ final class TdsReimbursementEvent extends Dto ]; /** - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $tdsOrderId The Tax-Deducted-at-Source (TDS) identifier. * @param ?Currency $reimbursedAmount A currency type and amount. */ diff --git a/src/Seller/FinancesV0/Dto/TrialShipmentEvent.php b/src/Seller/FinancesV0/Dto/TrialShipmentEvent.php index 4e628917d..7bc07e78f 100644 --- a/src/Seller/FinancesV0/Dto/TrialShipmentEvent.php +++ b/src/Seller/FinancesV0/Dto/TrialShipmentEvent.php @@ -27,7 +27,7 @@ final class TrialShipmentEvent extends Dto /** * @param ?string $amazonOrderId An Amazon-defined identifier for an order. * @param ?string $financialEventGroupId The identifier of the financial event group. - * @param ?\DateTimeInterface $postedDate + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $sku The seller SKU of the item. The seller SKU is qualified by the seller's seller ID, which is included with every call to the Selling Partner API. * @param FeeComponent[]|null $feeList A list of fee component information. */ diff --git a/src/Seller/FinancesV0/Dto/ValueAddedServiceChargeEvent.php b/src/Seller/FinancesV0/Dto/ValueAddedServiceChargeEvent.php index 795da5e2f..20abda53f 100644 --- a/src/Seller/FinancesV0/Dto/ValueAddedServiceChargeEvent.php +++ b/src/Seller/FinancesV0/Dto/ValueAddedServiceChargeEvent.php @@ -22,10 +22,8 @@ final class ValueAddedServiceChargeEvent extends Dto ]; /** - * @param ?string $transactionType Indicates the type of transaction. - * - * Example: 'Other Support Service fees' - * @param ?\DateTimeInterface $postedDate + * @param ?string $transactionType The transaction type. For example, 'Other Support Service fees' + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param ?string $description A short description of the service charge event. * @param ?Currency $transactionAmount A currency type and amount. */ diff --git a/src/Seller/FinancesV0/Requests/ListFinancialEventGroups.php b/src/Seller/FinancesV0/Requests/ListFinancialEventGroups.php index 5964bb452..c7c726106 100644 --- a/src/Seller/FinancesV0/Requests/ListFinancialEventGroups.php +++ b/src/Seller/FinancesV0/Requests/ListFinancialEventGroups.php @@ -24,10 +24,10 @@ class ListFinancialEventGroups extends Request protected Method $method = Method::GET; /** - * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - * @param ?\DateTimeInterface $financialEventGroupStartedBefore A date used for selecting financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned. - * @param ?\DateTimeInterface $financialEventGroupStartedAfter A date used for selecting financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be no later than two minutes before the request was submitted. - * @param ?string $nextToken A string token returned in the response of your previous request. + * @param ?int $maxResultsPerPage The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * @param ?\DateTimeInterface $financialEventGroupStartedBefore A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned. + * @param ?\DateTimeInterface $financialEventGroupStartedAfter A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request. + * @param ?string $nextToken The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. */ public function __construct( protected ?int $maxResultsPerPage = null, diff --git a/src/Seller/FinancesV0/Requests/ListFinancialEvents.php b/src/Seller/FinancesV0/Requests/ListFinancialEvents.php index b39756f4c..cb35ce875 100644 --- a/src/Seller/FinancesV0/Requests/ListFinancialEvents.php +++ b/src/Seller/FinancesV0/Requests/ListFinancialEvents.php @@ -24,10 +24,14 @@ class ListFinancialEvents extends Request protected Method $method = Method::GET; /** - * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - * @param ?\DateTimeInterface $postedAfter A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. - * @param ?\DateTimeInterface $postedBefore A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes. - * @param ?string $nextToken A string token returned in the response of your previous request. + * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * @param ?\DateTimeInterface $postedAfter The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. + * @param ?\DateTimeInterface $postedBefore The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * + * The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. + * + * **Default:** Two minutes before the time of the request. + * @param ?string $nextToken The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. */ public function __construct( protected ?int $maxResultsPerPage = null, diff --git a/src/Seller/FinancesV0/Requests/ListFinancialEventsByGroupId.php b/src/Seller/FinancesV0/Requests/ListFinancialEventsByGroupId.php index cf8ced217..a81806f81 100644 --- a/src/Seller/FinancesV0/Requests/ListFinancialEventsByGroupId.php +++ b/src/Seller/FinancesV0/Requests/ListFinancialEventsByGroupId.php @@ -25,10 +25,14 @@ class ListFinancialEventsByGroupId extends Request /** * @param string $eventGroupId The identifier of the financial event group to which the events belong. - * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - * @param ?\DateTimeInterface $postedAfter A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. - * @param ?\DateTimeInterface $postedBefore A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two minutes. - * @param ?string $nextToken A string token returned in the response of your previous request. + * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * @param ?\DateTimeInterface $postedAfter The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. + * @param ?\DateTimeInterface $postedBefore The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * + * The date-time must be later than `PostedAfter` and more than two minutes before the requestd was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. + * + * **Default:** Two minutes before the time of the request. + * @param ?string $nextToken The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. */ public function __construct( protected string $eventGroupId, diff --git a/src/Seller/FinancesV0/Requests/ListFinancialEventsByOrderId.php b/src/Seller/FinancesV0/Requests/ListFinancialEventsByOrderId.php index 572f76d51..e1905ac9d 100644 --- a/src/Seller/FinancesV0/Requests/ListFinancialEventsByOrderId.php +++ b/src/Seller/FinancesV0/Requests/ListFinancialEventsByOrderId.php @@ -25,8 +25,8 @@ class ListFinancialEventsByOrderId extends Request /** * @param string $orderId An Amazon-defined order identifier, in 3-7-7 format. - * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with 'InvalidInput'. - * @param ?string $nextToken A string token returned in the response of your previous request. + * @param ?int $maxResultsPerPage The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`. + * @param ?string $nextToken The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. */ public function __construct( protected string $orderId, diff --git a/src/Seller/FinancesV0/Responses/ListFinancialEventGroupsResponse.php b/src/Seller/FinancesV0/Responses/ListFinancialEventGroupsResponse.php index 1bbfa4de1..4d94312d9 100644 --- a/src/Seller/FinancesV0/Responses/ListFinancialEventGroupsResponse.php +++ b/src/Seller/FinancesV0/Responses/ListFinancialEventGroupsResponse.php @@ -17,7 +17,7 @@ final class ListFinancialEventGroupsResponse extends Response { /** - * @param ?ListFinancialEventGroupsPayload $payload The payload for the listFinancialEventGroups operation. + * @param ?ListFinancialEventGroupsPayload $payload The payload for the `listFinancialEventGroups` operation. * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ public function __construct( diff --git a/src/Seller/FinancesV0/Responses/ListFinancialEventsResponse.php b/src/Seller/FinancesV0/Responses/ListFinancialEventsResponse.php index 3fedc31fb..2f5000a34 100644 --- a/src/Seller/FinancesV0/Responses/ListFinancialEventsResponse.php +++ b/src/Seller/FinancesV0/Responses/ListFinancialEventsResponse.php @@ -17,7 +17,7 @@ final class ListFinancialEventsResponse extends Response { /** - * @param ?ListFinancialEventsPayload $payload The payload for the listFinancialEvents operation. + * @param ?ListFinancialEventsPayload $payload The payload for the `listFinancialEvents` operation. * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ public function __construct( diff --git a/src/Seller/FinancesV20240619/Api.php b/src/Seller/FinancesV20240619/Api.php new file mode 100644 index 000000000..31f8019ef --- /dev/null +++ b/src/Seller/FinancesV20240619/Api.php @@ -0,0 +1,31 @@ +connector->send($request); + } +} diff --git a/src/Seller/FinancesV20240619/Dto/AmazonPayContext.php b/src/Seller/FinancesV20240619/Dto/AmazonPayContext.php new file mode 100644 index 000000000..32f469a42 --- /dev/null +++ b/src/Seller/FinancesV20240619/Dto/AmazonPayContext.php @@ -0,0 +1,27 @@ + ItemRelatedIdentifier::class, + 'breakdowns' => Breakdown::class, + 'contexts' => Context::class, + ]; + + /** + * @param ?string $description A description of the items in a transaction. + * @param ItemRelatedIdentifier[]|null $relatedIdentifiers Related business identifiers of the item in the transaction. + * @param ?Currency $totalAmount A currency type and amount. + * @param Breakdown[]|null $breakdowns A list of breakdowns that provide details on how the total amount is calculated for the transaction. + * @param Context[]|null $contexts A list of additional information about the item. + */ + public function __construct( + public readonly ?string $description = null, + public readonly ?array $relatedIdentifiers = null, + public readonly ?Currency $totalAmount = null, + public readonly ?array $breakdowns = null, + public readonly ?array $contexts = null, + ) {} +} diff --git a/src/Seller/FinancesV20240619/Dto/ItemRelatedIdentifier.php b/src/Seller/FinancesV20240619/Dto/ItemRelatedIdentifier.php new file mode 100644 index 000000000..ab3ab7ad2 --- /dev/null +++ b/src/Seller/FinancesV20240619/Dto/ItemRelatedIdentifier.php @@ -0,0 +1,25 @@ + RelatedIdentifier::class, + 'items' => Item::class, + 'contexts' => Context::class, + 'breakdowns' => Breakdown::class, + ]; + + /** + * @param ?SellingPartnerMetadata $sellingPartnerMetadata Metadata that describes the seller. + * @param RelatedIdentifier[]|null $relatedIdentifiers Related business identifiers of the transaction. + * @param ?string $transactionType The type of transaction. + * + * **Possible value:** `Shipment` + * @param ?string $transactionId The unique identifier of the transaction. + * @param ?string $transactionStatus The status of the transaction. + * + * **Possible values:** + * + * * `Deferred` + * * `Released` + * @param ?string $description Describes the reasons for the transaction. + * + * **Example:** 'Order Payment', 'Refund Order' + * @param ?\DateTimeInterface $postedDate A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * @param ?Currency $totalAmount A currency type and amount. + * @param ?MarketplaceDetails $marketplaceDetails Information about the marketplace where the transaction occurred. + * @param Item[]|null $items A list of items in the transaction. + * @param Context[]|null $contexts A list of additional information about the item. + * @param Breakdown[]|null $breakdowns A list of breakdowns that provide details on how the total amount is calculated for the transaction. + */ + public function __construct( + public readonly ?SellingPartnerMetadata $sellingPartnerMetadata = null, + public readonly ?array $relatedIdentifiers = null, + public readonly ?string $transactionType = null, + public readonly ?string $transactionId = null, + public readonly ?string $transactionStatus = null, + public readonly ?string $description = null, + public readonly ?\DateTimeInterface $postedDate = null, + public readonly ?Currency $totalAmount = null, + public readonly ?MarketplaceDetails $marketplaceDetails = null, + public readonly ?array $items = null, + public readonly ?array $contexts = null, + public readonly ?array $breakdowns = null, + ) {} +} diff --git a/src/Seller/FinancesV20240619/Requests/ListTransactions.php b/src/Seller/FinancesV20240619/Requests/ListTransactions.php new file mode 100644 index 000000000..50a2a4fc1 --- /dev/null +++ b/src/Seller/FinancesV20240619/Requests/ListTransactions.php @@ -0,0 +1,70 @@ +status(); + $responseCls = match ($status) { + 200 => ListTransactionsResponse::class, + 400, 403, 404, 415, 413, 429, 500, 503 => ErrorList::class, + default => throw new Exception("Unhandled response status: {$status}") + }; + + return $responseCls::deserialize($response->json()); + } + + public function defaultQuery(): array + { + return array_filter([ + 'postedAfter' => $this->postedAfter?->format('Y-m-d\TH:i:s\Z'), + 'postedBefore' => $this->postedBefore?->format('Y-m-d\TH:i:s\Z'), + 'marketplaceId' => $this->marketplaceId, + 'nextToken' => $this->nextToken, + ]); + } +} diff --git a/src/Seller/FinancesV20240619/Responses/ErrorList.php b/src/Seller/FinancesV20240619/Responses/ErrorList.php new file mode 100644 index 000000000..4820558c0 --- /dev/null +++ b/src/Seller/FinancesV20240619/Responses/ErrorList.php @@ -0,0 +1,26 @@ + Error::class]; + + /** + * @param Error[] $errors The error responses that are returned when the request is unsuccessful. + */ + public function __construct( + public readonly array $errors, + ) {} +} diff --git a/src/Seller/FinancesV20240619/Responses/ListTransactionsResponse.php b/src/Seller/FinancesV20240619/Responses/ListTransactionsResponse.php new file mode 100644 index 000000000..a59bd8ca6 --- /dev/null +++ b/src/Seller/FinancesV20240619/Responses/ListTransactionsResponse.php @@ -0,0 +1,28 @@ + Transaction::class]; + + /** + * @param ?string $nextToken The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * @param Transaction[]|null $transactions A list of transactions within the specified time period. + */ + public function __construct( + public readonly ?string $nextToken = null, + public readonly ?array $transactions = null, + ) {} +} diff --git a/src/Seller/InvoicesV20240619/Api.php b/src/Seller/InvoicesV20240619/Api.php new file mode 100644 index 000000000..8f314400b --- /dev/null +++ b/src/Seller/InvoicesV20240619/Api.php @@ -0,0 +1,136 @@ +connector->send($request); + } + + /** + * @param string $invoicesDocumentId The export document identifier. + */ + public function getInvoicesDocument(string $invoicesDocumentId): Response + { + $request = new GetInvoicesDocument($invoicesDocumentId); + + return $this->connector->send($request); + } + + /** + * @param string $marketplaceId The returned exports match the specified marketplace. + * @param ?\DateTimeInterface $dateStart The earliest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 30 days ago. + * @param ?string $nextToken The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * @param ?int $pageSize The maximum number of invoices to return in a single call. + * + * Minimum: 1 + * + * Maximum: 100 + * @param ?\DateTimeInterface $dateEnd The latest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default value is the time of the request. + * @param ?string $status Return exports matching the status specified. + */ + public function getInvoicesExports( + string $marketplaceId, + ?\DateTimeInterface $dateStart = null, + ?string $nextToken = null, + ?int $pageSize = null, + ?\DateTimeInterface $dateEnd = null, + ?string $status = null, + ): Response { + $request = new GetInvoicesExports($marketplaceId, $dateStart, $nextToken, $pageSize, $dateEnd, $status); + + return $this->connector->send($request); + } + + /** + * @param ExportInvoicesRequest $exportInvoicesRequest The information required to create the export request. + */ + public function createInvoicesExport(ExportInvoicesRequest $exportInvoicesRequest): Response + { + $request = new CreateInvoicesExport($exportInvoicesRequest); + + return $this->connector->send($request); + } + + /** + * @param string $exportId The unique identifier for the export. + */ + public function getInvoicesExport(string $exportId): Response + { + $request = new GetInvoicesExport($exportId); + + return $this->connector->send($request); + } + + /** + * @param string $marketplaceId The response includes only the invoices that match the specified marketplace. + * @param ?string $transactionIdentifierName The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options. + * @param ?int $pageSize The maximum number of invoices you want to return in a single call. + * + * Minimum: 1 + * + * Maximum: 200 + * @param ?\DateTimeInterface $dateEnd The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the current date-time. + * @param ?string $transactionType The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options. + * @param ?string $transactionIdentifierId The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field. + * @param ?\DateTimeInterface $dateStart The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request. + * @param ?string $series Return invoices with the specified series number. + * @param ?string $nextToken The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages. + * @param ?string $sortOrder Sort the invoices in the response in ascending or descending order. + * @param ?string $invoiceType The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options. + * @param ?array $statuses A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options. + * + * Min count: 1 + * @param ?string $externalInvoiceId Return invoices that match this external ID. This is typically the Government Invoice ID. + * @param ?string $sortBy The attribute by which you want to sort the invoices in the response. + */ + public function getInvoices( + string $marketplaceId, + ?string $transactionIdentifierName = null, + ?int $pageSize = null, + ?\DateTimeInterface $dateEnd = null, + ?string $transactionType = null, + ?string $transactionIdentifierId = null, + ?\DateTimeInterface $dateStart = null, + ?string $series = null, + ?string $nextToken = null, + ?string $sortOrder = null, + ?string $invoiceType = null, + ?array $statuses = null, + ?string $externalInvoiceId = null, + ?string $sortBy = null, + ): Response { + $request = new GetInvoices($marketplaceId, $transactionIdentifierName, $pageSize, $dateEnd, $transactionType, $transactionIdentifierId, $dateStart, $series, $nextToken, $sortOrder, $invoiceType, $statuses, $externalInvoiceId, $sortBy); + + return $this->connector->send($request); + } + + /** + * @param string $invoiceId The invoice identifier. + * @param string $marketplaceId The marketplace from which you want the invoice. + */ + public function getInvoice(string $invoiceId, string $marketplaceId): Response + { + $request = new GetInvoice($invoiceId, $marketplaceId); + + return $this->connector->send($request); + } +} diff --git a/src/Seller/InvoicesV20240619/Dto/AttributeOption.php b/src/Seller/InvoicesV20240619/Dto/AttributeOption.php new file mode 100644 index 000000000..327bdd122 --- /dev/null +++ b/src/Seller/InvoicesV20240619/Dto/AttributeOption.php @@ -0,0 +1,25 @@ + TransactionIdentifier::class]; + + /** + * @param ?\DateTimeInterface $date The date and time the invoice is issued. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. + * @param ?string $errorCode If the invoice is in an error state, this attribute displays the error code. + * @param ?string $externalInvoiceId The invoice identifier that is used by an external party. This is typically the government agency that authorized the invoice. + * @param ?string $govResponse The response message from the government authority when there is an error during invoice issuance. + * @param ?string $id The invoice identifier. + * @param ?string $invoiceType The classification of the invoice type. This varies across marketplaces. Use the `getInvoicesAttributes` operation to check `invoiceType` options. + * @param ?string $series Use this identifier in conjunction with `externalInvoiceId` to identify invoices from the same seller. + * @param ?string $status The invoice status classification. Use the `getInvoicesAttributes` operation to check invoice status options. + * @param TransactionIdentifier[]|null $transactionIds List with identifiers for the transactions associated to the invoice. + * @param ?string $transactionType Classification of the transaction that originated this invoice. Use the `getInvoicesAttributes` operation to check `transactionType` options. + */ + public function __construct( + public readonly ?\DateTimeInterface $date = null, + public readonly ?string $errorCode = null, + public readonly ?string $externalInvoiceId = null, + public readonly ?string $govResponse = null, + public readonly ?string $id = null, + public readonly ?string $invoiceType = null, + public readonly ?string $series = null, + public readonly ?string $status = null, + public readonly ?array $transactionIds = null, + public readonly ?string $transactionType = null, + ) {} +} diff --git a/src/Seller/InvoicesV20240619/Dto/InvoicesAttributes.php b/src/Seller/InvoicesV20240619/Dto/InvoicesAttributes.php new file mode 100644 index 000000000..d0b9782ed --- /dev/null +++ b/src/Seller/InvoicesV20240619/Dto/InvoicesAttributes.php @@ -0,0 +1,36 @@ + AttributeOption::class, + 'invoiceTypeOptions' => AttributeOption::class, + 'transactionIdentifierNameOptions' => AttributeOption::class, + 'transactionTypeOptions' => AttributeOption::class, + ]; + + /** + * @param AttributeOption[]|null $invoiceStatusOptions A list of all the options that are available for the invoice status attribute. + * @param AttributeOption[]|null $invoiceTypeOptions A list of all the options that are available for the invoice type attribute. + * @param AttributeOption[]|null $transactionIdentifierNameOptions A list of all the options that are available for the transaction identifier name attribute. + * @param AttributeOption[]|null $transactionTypeOptions A list of all the options that are available for the transaction type attribute. + */ + public function __construct( + public readonly ?array $invoiceStatusOptions = null, + public readonly ?array $invoiceTypeOptions = null, + public readonly ?array $transactionIdentifierNameOptions = null, + public readonly ?array $transactionTypeOptions = null, + ) {} +} diff --git a/src/Seller/InvoicesV20240619/Dto/InvoicesDocument.php b/src/Seller/InvoicesV20240619/Dto/InvoicesDocument.php new file mode 100644 index 000000000..7d2bf7eb2 --- /dev/null +++ b/src/Seller/InvoicesV20240619/Dto/InvoicesDocument.php @@ -0,0 +1,25 @@ +status(); + $responseCls = match ($status) { + 202 => ExportInvoicesResponse::class, + 400, 401, 403, 404, 413, 415, 429, 500, 503 => ErrorList::class, + default => throw new Exception("Unhandled response status: {$status}") + }; + + return $responseCls::deserialize($response->json()); + } + + public function defaultBody(): array + { + return $this->exportInvoicesRequest->toArray(); + } +} diff --git a/src/Seller/InvoicesV20240619/Requests/GetInvoice.php b/src/Seller/InvoicesV20240619/Requests/GetInvoice.php new file mode 100644 index 000000000..3665fdb32 --- /dev/null +++ b/src/Seller/InvoicesV20240619/Requests/GetInvoice.php @@ -0,0 +1,57 @@ +invoiceId}"; + } + + public function createDtoFromResponse(Response $response): GetInvoiceResponse|ErrorList + { + $status = $response->status(); + $responseCls = match ($status) { + 200 => GetInvoiceResponse::class, + 400, 401, 403, 404, 413, 415, 429, 500, 503 => ErrorList::class, + default => throw new Exception("Unhandled response status: {$status}") + }; + + return $responseCls::deserialize($response->json()); + } + + public function defaultQuery(): array + { + return array_filter(['marketplaceId' => $this->marketplaceId]); + } +} diff --git a/src/Seller/InvoicesV20240619/Requests/GetInvoices.php b/src/Seller/InvoicesV20240619/Requests/GetInvoices.php new file mode 100644 index 000000000..7967ccab2 --- /dev/null +++ b/src/Seller/InvoicesV20240619/Requests/GetInvoices.php @@ -0,0 +1,102 @@ +status(); + $responseCls = match ($status) { + 200 => GetInvoicesResponse::class, + 400, 401, 403, 404, 413, 415, 429, 500, 503 => ErrorList::class, + default => throw new Exception("Unhandled response status: {$status}") + }; + + return $responseCls::deserialize($response->json()); + } + + public function defaultQuery(): array + { + return array_filter([ + 'marketplaceId' => $this->marketplaceId, + 'transactionIdentifierName' => $this->transactionIdentifierName, + 'pageSize' => $this->pageSize, + 'dateEnd' => $this->dateEnd?->format('Y-m-d\TH:i:s\Z'), + 'transactionType' => $this->transactionType, + 'transactionIdentifierId' => $this->transactionIdentifierId, + 'dateStart' => $this->dateStart?->format('Y-m-d\TH:i:s\Z'), + 'series' => $this->series, + 'nextToken' => $this->nextToken, + 'sortOrder' => $this->sortOrder, + 'invoiceType' => $this->invoiceType, + 'statuses' => $this->statuses, + 'externalInvoiceId' => $this->externalInvoiceId, + 'sortBy' => $this->sortBy, + ]); + } +} diff --git a/src/Seller/InvoicesV20240619/Requests/GetInvoicesAttributes.php b/src/Seller/InvoicesV20240619/Requests/GetInvoicesAttributes.php new file mode 100644 index 000000000..917a906e4 --- /dev/null +++ b/src/Seller/InvoicesV20240619/Requests/GetInvoicesAttributes.php @@ -0,0 +1,55 @@ +status(); + $responseCls = match ($status) { + 200 => GetInvoicesAttributesResponse::class, + 400, 401, 403, 404, 413, 415, 429, 500, 503 => ErrorList::class, + default => throw new Exception("Unhandled response status: {$status}") + }; + + return $responseCls::deserialize($response->json()); + } + + public function defaultQuery(): array + { + return array_filter(['marketplaceId' => $this->marketplaceId]); + } +} diff --git a/src/Seller/InvoicesV20240619/Requests/GetInvoicesDocument.php b/src/Seller/InvoicesV20240619/Requests/GetInvoicesDocument.php new file mode 100644 index 000000000..91afe9e70 --- /dev/null +++ b/src/Seller/InvoicesV20240619/Requests/GetInvoicesDocument.php @@ -0,0 +1,50 @@ +invoicesDocumentId}"; + } + + public function createDtoFromResponse(Response $response): GetInvoicesDocumentResponse|ErrorList + { + $status = $response->status(); + $responseCls = match ($status) { + 200 => GetInvoicesDocumentResponse::class, + 400, 401, 403, 404, 413, 415, 429, 500, 503 => ErrorList::class, + default => throw new Exception("Unhandled response status: {$status}") + }; + + return $responseCls::deserialize($response->json()); + } +} diff --git a/src/Seller/InvoicesV20240619/Requests/GetInvoicesExport.php b/src/Seller/InvoicesV20240619/Requests/GetInvoicesExport.php new file mode 100644 index 000000000..6bffe5070 --- /dev/null +++ b/src/Seller/InvoicesV20240619/Requests/GetInvoicesExport.php @@ -0,0 +1,50 @@ +exportId}"; + } + + public function createDtoFromResponse(Response $response): GetInvoicesExportResponse|ErrorList + { + $status = $response->status(); + $responseCls = match ($status) { + 200 => GetInvoicesExportResponse::class, + 400, 401, 403, 404, 413, 415, 429, 500, 503 => ErrorList::class, + default => throw new Exception("Unhandled response status: {$status}") + }; + + return $responseCls::deserialize($response->json()); + } +} diff --git a/src/Seller/InvoicesV20240619/Requests/GetInvoicesExports.php b/src/Seller/InvoicesV20240619/Requests/GetInvoicesExports.php new file mode 100644 index 000000000..8461b3b73 --- /dev/null +++ b/src/Seller/InvoicesV20240619/Requests/GetInvoicesExports.php @@ -0,0 +1,76 @@ +status(); + $responseCls = match ($status) { + 200 => GetInvoicesExportsResponse::class, + 400, 401, 403, 404, 413, 415, 429, 500, 503 => ErrorList::class, + default => throw new Exception("Unhandled response status: {$status}") + }; + + return $responseCls::deserialize($response->json()); + } + + public function defaultQuery(): array + { + return array_filter([ + 'marketplaceId' => $this->marketplaceId, + 'dateStart' => $this->dateStart?->format('Y-m-d\TH:i:s\Z'), + 'nextToken' => $this->nextToken, + 'pageSize' => $this->pageSize, + 'dateEnd' => $this->dateEnd?->format('Y-m-d\TH:i:s\Z'), + 'status' => $this->status, + ]); + } +} diff --git a/src/Seller/InvoicesV20240619/Responses/ErrorList.php b/src/Seller/InvoicesV20240619/Responses/ErrorList.php new file mode 100644 index 000000000..f6547c776 --- /dev/null +++ b/src/Seller/InvoicesV20240619/Responses/ErrorList.php @@ -0,0 +1,26 @@ + Error::class]; + + /** + * @param Error[] $errors List of errors. + */ + public function __construct( + public readonly array $errors, + ) {} +} diff --git a/src/Seller/InvoicesV20240619/Responses/ExportInvoicesResponse.php b/src/Seller/InvoicesV20240619/Responses/ExportInvoicesResponse.php new file mode 100644 index 000000000..f7d509873 --- /dev/null +++ b/src/Seller/InvoicesV20240619/Responses/ExportInvoicesResponse.php @@ -0,0 +1,23 @@ + Export::class]; + + /** + * @param Export[]|null $exports A list of exports. + * @param ?string $nextToken This token is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getInvoices` operation and include this token with the previous call parameters. + */ + public function __construct( + public readonly ?array $exports = null, + public readonly ?string $nextToken = null, + ) {} +} diff --git a/src/Seller/InvoicesV20240619/Responses/GetInvoicesResponse.php b/src/Seller/InvoicesV20240619/Responses/GetInvoicesResponse.php new file mode 100644 index 000000000..12e78d790 --- /dev/null +++ b/src/Seller/InvoicesV20240619/Responses/GetInvoicesResponse.php @@ -0,0 +1,28 @@ + Invoice::class]; + + /** + * @param Invoice[]|null $invoices A list of invoices. + * @param ?string $nextToken This token is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getInvoices` operation and include this token with the previous call parameters. + */ + public function __construct( + public readonly ?array $invoices = null, + public readonly ?string $nextToken = null, + ) {} +} diff --git a/src/Seller/ListingsItemsV20210801/Api.php b/src/Seller/ListingsItemsV20210801/Api.php index 3a3265b6c..3b17b7a6b 100644 --- a/src/Seller/ListingsItemsV20210801/Api.php +++ b/src/Seller/ListingsItemsV20210801/Api.php @@ -10,6 +10,7 @@ use SellingPartnerApi\Seller\ListingsItemsV20210801\Requests\GetListingsItem; use SellingPartnerApi\Seller\ListingsItemsV20210801\Requests\PatchListingsItem; use SellingPartnerApi\Seller\ListingsItemsV20210801\Requests\PutListingsItem; +use SellingPartnerApi\Seller\ListingsItemsV20210801\Requests\SearchListingsItems; class Api extends BaseResource { @@ -94,4 +95,35 @@ public function patchListingsItem( return $this->connector->send($request); } + + /** + * @param string $sellerId A selling partner identifier, such as a merchant account or vendor code. + * @param array $marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. + * @param ?array $identifiers A comma-delimited list of product identifiers to search for listings items by. + * + * **Note**: + * 1. Required when `identifiersType` is provided. + * @param ?string $identifiersType Type of product identifiers to search for listings items by. + * + * **Note**: + * 1. Required when `identifiers` is provided. + * @param ?int $pageSize Number of results to be returned per page. + * @param ?string $pageToken A token to fetch a certain page when there are multiple pages worth of results. + * @param ?array $includedData A comma-delimited list of data sets to include in the response. Default: summaries. + * @param ?string $issueLocale A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale. + */ + public function searchListingsItems( + string $sellerId, + array $marketplaceIds, + ?array $identifiers = null, + ?string $identifiersType = null, + ?int $pageSize = null, + ?string $pageToken = null, + ?array $includedData = null, + ?string $issueLocale = null, + ): Response { + $request = new SearchListingsItems($sellerId, $marketplaceIds, $identifiers, $identifiersType, $pageSize, $pageToken, $includedData, $issueLocale); + + return $this->connector->send($request); + } } diff --git a/src/Seller/ListingsItemsV20210801/Dto/Audience.php b/src/Seller/ListingsItemsV20210801/Dto/Audience.php new file mode 100644 index 000000000..78ecf659e --- /dev/null +++ b/src/Seller/ListingsItemsV20210801/Dto/Audience.php @@ -0,0 +1,31 @@ +sellerId}"; + } + + public function createDtoFromResponse(Response $response): ItemSearchResults|ErrorList + { + $status = $response->status(); + $responseCls = match ($status) { + 200 => ItemSearchResults::class, + 400, 403, 404, 413, 415, 429, 500, 503 => ErrorList::class, + default => throw new Exception("Unhandled response status: {$status}") + }; + + return $responseCls::deserialize($response->json()); + } + + public function defaultQuery(): array + { + return array_filter([ + 'marketplaceIds' => $this->marketplaceIds, + 'identifiers' => $this->identifiers, + 'identifiersType' => $this->identifiersType, + 'pageSize' => $this->pageSize, + 'pageToken' => $this->pageToken, + 'includedData' => $this->includedData, + 'issueLocale' => $this->issueLocale, + ]); + } +} diff --git a/src/Seller/ListingsItemsV20210801/Responses/ItemSearchResults.php b/src/Seller/ListingsItemsV20210801/Responses/ItemSearchResults.php new file mode 100644 index 000000000..b54d1fa33 --- /dev/null +++ b/src/Seller/ListingsItemsV20210801/Responses/ItemSearchResults.php @@ -0,0 +1,32 @@ + Item::class]; + + /** + * @param int $numberOfResults The total number of selling partner listings items found for the search criteria (only results up to the page count limit will be returned per request regardless of the number found). + * + * Note: The maximum number of items (SKUs) that can be returned and paged through is 1000. + * @param Item[] $items A list of listings items. + * @param ?Pagination $pagination When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there will be no `nextToken` key in the pagination object. + */ + public function __construct( + public readonly int $numberOfResults, + public readonly array $items, + public readonly ?Pagination $pagination = null, + ) {} +} diff --git a/src/Seller/MessagingV1/Dto/Embedded2.php b/src/Seller/MessagingV1/Dto/Embedded2.php index 5009d3deb..d46ac440c 100644 --- a/src/Seller/MessagingV1/Dto/Embedded2.php +++ b/src/Seller/MessagingV1/Dto/Embedded2.php @@ -14,9 +14,6 @@ final class Embedded2 extends Dto { - /** - * @param ?GetSchemaResponse $schema - */ public function __construct( public readonly ?GetSchemaResponse $schema = null, ) {} diff --git a/src/Seller/MessagingV1/Dto/GetMessagingActionResponse.php b/src/Seller/MessagingV1/Dto/GetMessagingActionResponse.php index ec492b3c2..c06b588d1 100644 --- a/src/Seller/MessagingV1/Dto/GetMessagingActionResponse.php +++ b/src/Seller/MessagingV1/Dto/GetMessagingActionResponse.php @@ -17,8 +17,6 @@ final class GetMessagingActionResponse extends Dto protected static array $attributeMap = ['links' => '_links', 'embedded' => '_embedded']; /** - * @param ?Links2 $links - * @param ?Embedded2 $embedded * @param ?MessagingAction $payload A simple object containing the name of the template. * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ diff --git a/src/Seller/MessagingV1/Dto/GetSchemaResponse.php b/src/Seller/MessagingV1/Dto/GetSchemaResponse.php index 82a08bf77..6ee57dce9 100644 --- a/src/Seller/MessagingV1/Dto/GetSchemaResponse.php +++ b/src/Seller/MessagingV1/Dto/GetSchemaResponse.php @@ -17,7 +17,6 @@ final class GetSchemaResponse extends Dto protected static array $attributeMap = ['links' => '_links']; /** - * @param ?Links3 $links * @param ?array[] $payload A JSON schema document describing the expected payload of the action. This object can be validated against http://json-schema.org/draft-04/schema. * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ diff --git a/src/Seller/MessagingV1/Responses/GetMessagingActionsForOrderResponse.php b/src/Seller/MessagingV1/Responses/GetMessagingActionsForOrderResponse.php index 81c1350a2..b22d6f7d4 100644 --- a/src/Seller/MessagingV1/Responses/GetMessagingActionsForOrderResponse.php +++ b/src/Seller/MessagingV1/Responses/GetMessagingActionsForOrderResponse.php @@ -20,8 +20,6 @@ final class GetMessagingActionsForOrderResponse extends Response protected static array $attributeMap = ['links' => '_links', 'embedded' => '_embedded']; /** - * @param ?Links $links - * @param ?Embedded $embedded * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ public function __construct( diff --git a/src/Seller/NotificationsV1/Api.php b/src/Seller/NotificationsV1/Api.php index 2fe6b5436..6cb858cb2 100644 --- a/src/Seller/NotificationsV1/Api.php +++ b/src/Seller/NotificationsV1/Api.php @@ -73,7 +73,7 @@ public function deleteSubscriptionById(string $subscriptionId, string $notificat public function getDestinations(): Response { - $request = new GetDestinations(); + $request = new GetDestinations; return $this->connector->send($request); } diff --git a/src/Seller/OrdersV0/Api.php b/src/Seller/OrdersV0/Api.php index f9eb922e1..b3078ae81 100644 --- a/src/Seller/OrdersV0/Api.php +++ b/src/Seller/OrdersV0/Api.php @@ -23,19 +23,19 @@ class Api extends BaseResource /** * @param array $marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. * - * Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `MarketplaceId` values. - * @param ?string $createdAfter A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in ISO 8601 format. + * Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values. + * @param ?string $createdAfter 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. * - * **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. You could specify `CreatedBefore` but not provide `LastUpdatedAfter` or `LastUpdatedBefore` when `CreatedAfter` is specified. - * @param ?string $createdBefore 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. + * **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. + * @param ?string $createdBefore 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. * - * **Note**: `CreatedBefore` is optional when `CreatedAfter` is specified. But if specified, `CreatedBefore` should be equal to or after the `CreatedAfter` date and at least 2 minutes before the current time. - * @param ?string $lastUpdatedAfter 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. + * **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. + * @param ?string $lastUpdatedAfter 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. * - * **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is specified. But if specified, `LastUpdatedBefore` should be equal to or after the `LastUpdatedAfter` date and at least 2 minutes before current time. - * @param ?string $lastUpdatedBefore 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. + * **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. + * @param ?string $lastUpdatedBefore 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. * - * **Note**: LastUpdatedBefore is optional when LastUpdatedAfter is set. But if specified, LastUpdatedBefore should be equal to or after the LastUpdatedAfter date and at least 2 minutes before current time. + * **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. * @param ?array $orderStatuses A list of `OrderStatus` values used to filter the results. * * **Possible values:** @@ -49,12 +49,12 @@ class Api extends BaseResource * - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.) * @param ?array $fulfillmentChannels 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). - * @param ?array $paymentMethods A list of payment method values. Used to select orders paid using the specified payment methods. + * **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller). + * @param ?array $paymentMethods A list of payment method values. Use this field to select orders that were paid with the specified payment methods. * - * **Possible values**: `COD` (Cash on delivery); `CVS` (Convenience store payment); `Other` (Any payment method other than `COD` or `CVS`). + * **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS). * @param ?string $buyerEmail The email address of a buyer. Used to select orders that contain the specified email address. - * @param ?string $sellerOrderId 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. + * @param ?string $sellerOrderId 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. * @param ?int $maxResultsPerPage A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. * @param ?array $easyShipShipmentStatuses 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. * @@ -84,14 +84,14 @@ class Api extends BaseResource * - `Errored` (The last submitted electronic invoice was rejected for this order.) * - `Accepted` (The last submitted electronic invoice was submitted and accepted.) * @param ?string $nextToken A string token returned in the response of your previous request. - * @param ?array $amazonOrderIds A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. - * @param ?string $actualFulfillmentSupplySourceId Denotes the recommended sourceId where the order should be fulfilled from. + * @param ?array $amazonOrderIds A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format. + * @param ?string $actualFulfillmentSupplySourceId The `sourceId` of the location from where you want the order fulfilled. * @param ?bool $isIspu When true, this order is marked to be picked up from a store rather than delivered. * @param ?string $storeChainStoreId The store chain store identifier. Linked to a specific store in a store chain. - * @param ?string $earliestDeliveryDateBefore A date used for selecting orders with a earliest delivery date before (or at) a specified time. The date must be in ISO 8601 format. - * @param ?string $earliestDeliveryDateAfter A date used for selecting orders with a earliest delivery date after (or at) a specified time. The date must be in ISO 8601 format. - * @param ?string $latestDeliveryDateBefore A date used for selecting orders with a latest delivery date before (or at) a specified time. The date must be in ISO 8601 format. - * @param ?string $latestDeliveryDateAfter A date used for selecting orders with a latest delivery date after (or at) a specified time. The date must be in ISO 8601 format. + * @param ?string $earliestDeliveryDateBefore 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. + * @param ?string $earliestDeliveryDateAfter 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. + * @param ?string $latestDeliveryDateBefore 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. + * @param ?string $latestDeliveryDateAfter 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. */ public function getOrders( array $marketplaceIds, diff --git a/src/Seller/OrdersV0/Dto/Address.php b/src/Seller/OrdersV0/Dto/Address.php index c970e44ae..81ccdc8b8 100644 --- a/src/Seller/OrdersV0/Dto/Address.php +++ b/src/Seller/OrdersV0/Dto/Address.php @@ -51,10 +51,10 @@ final class Address extends Dto * * **Note**: * 1. This attribute is only available for shipping address. - * 2. The buyer `Phone` number is suppressed in some cases, including but not limited to - * a. `Phone` is suppressed for all Fulfillment by Amazon (FBA) orders. - * b. `Phone` is suppressed for the shipped MFN(Fulfilled by the seller) order when current date is past Latest Delivery Date. - * @param ?AddressExtendedFields $extendedFields The container of extended address fields. For example, street name, street number. Only available with Brazil shipping addresses as of now. + * 2. In some cases, the buyer phone number is suppressed: + * a. Phone is suppressed for all `AFN` (fulfilled by Amazon) orders. + * b. Phone is suppressed for the shipped `MFN` (fulfilled by seller) order when the current date is past the Latest Delivery Date. + * @param ?AddressExtendedFields $extendedFields The container for address extended fields (such as `street name` and `street number`). Currently only available with Brazil shipping addresses. * @param ?string $addressType The address type of the shipping address. */ public function __construct( diff --git a/src/Seller/OrdersV0/Dto/AddressExtendedFields.php b/src/Seller/OrdersV0/Dto/AddressExtendedFields.php index ec8df381a..3261ce23b 100644 --- a/src/Seller/OrdersV0/Dto/AddressExtendedFields.php +++ b/src/Seller/OrdersV0/Dto/AddressExtendedFields.php @@ -23,9 +23,9 @@ final class AddressExtendedFields extends Dto /** * @param ?string $streetName The street name. - * @param ?string $streetNumber The house number/building number/property number in the street. + * @param ?string $streetNumber The house, building, or property number associated with the location's street address. * @param ?string $complement The floor number/unit number in the building/private house number. - * @param ?string $neighborhood The neighborhood. It's smaller than a region and an integral part of an address. It is used in some countries like Brazil. + * @param ?string $neighborhood The neighborhood. This value is only used in some countries (such as Brazil). */ public function __construct( public readonly ?string $streetName = null, diff --git a/src/Seller/OrdersV0/Dto/AmazonPrograms.php b/src/Seller/OrdersV0/Dto/AmazonPrograms.php new file mode 100644 index 000000000..6cc887900 --- /dev/null +++ b/src/Seller/OrdersV0/Dto/AmazonPrograms.php @@ -0,0 +1,27 @@ + 'Programs']; + + /** + * @param string[] $programs A list of the programs that are associated with the specified order item. + * + * **Possible values**: `SUBSCRIBE_AND_SAVE` + */ + public function __construct( + public readonly array $programs, + ) {} +} diff --git a/src/Seller/OrdersV0/Dto/BuyerCustomizedInfoDetail.php b/src/Seller/OrdersV0/Dto/BuyerCustomizedInfoDetail.php index d6dff43fb..022f1095a 100644 --- a/src/Seller/OrdersV0/Dto/BuyerCustomizedInfoDetail.php +++ b/src/Seller/OrdersV0/Dto/BuyerCustomizedInfoDetail.php @@ -17,7 +17,7 @@ final class BuyerCustomizedInfoDetail extends Dto protected static array $attributeMap = ['customizedUrl' => 'CustomizedURL']; /** - * @param ?string $customizedUrl The location of a zip file containing Amazon Custom data. + * @param ?string $customizedUrl The location of a ZIP file containing Amazon Custom data. */ public function __construct( public readonly ?string $customizedUrl = null, diff --git a/src/Seller/OrdersV0/Dto/BuyerInfo.php b/src/Seller/OrdersV0/Dto/BuyerInfo.php index a2e53b71a..f235d1746 100644 --- a/src/Seller/OrdersV0/Dto/BuyerInfo.php +++ b/src/Seller/OrdersV0/Dto/BuyerInfo.php @@ -29,7 +29,7 @@ final class BuyerInfo extends Dto * * **Note**: This attribute is only available in the Brazil marketplace. * @param ?BuyerTaxInfo $buyerTaxInfo Tax information about the buyer. - * @param ?string $purchaseOrderNumber The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout. + * @param ?string $purchaseOrderNumber The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout. */ public function __construct( public readonly ?string $buyerEmail = null, diff --git a/src/Seller/OrdersV0/Dto/ConfirmShipmentOrderItem.php b/src/Seller/OrdersV0/Dto/ConfirmShipmentOrderItem.php index 314f0dda9..63f7268a7 100644 --- a/src/Seller/OrdersV0/Dto/ConfirmShipmentOrderItem.php +++ b/src/Seller/OrdersV0/Dto/ConfirmShipmentOrderItem.php @@ -15,8 +15,8 @@ final class ConfirmShipmentOrderItem extends Dto { /** - * @param string $orderItemId The unique identifier of the order item. - * @param int $quantity The quantity of the item. + * @param string $orderItemId The order item's unique identifier. + * @param int $quantity The item's quantity. * @param ?string[] $transparencyCodes A list of order items. */ public function __construct( diff --git a/src/Seller/OrdersV0/Dto/ConfirmShipmentRequest.php b/src/Seller/OrdersV0/Dto/ConfirmShipmentRequest.php index 72b656f30..0d5c7f46d 100644 --- a/src/Seller/OrdersV0/Dto/ConfirmShipmentRequest.php +++ b/src/Seller/OrdersV0/Dto/ConfirmShipmentRequest.php @@ -17,7 +17,7 @@ final class ConfirmShipmentRequest extends Dto /** * @param PackageDetail $packageDetail Properties of packages * @param string $marketplaceId The unobfuscated marketplace identifier. - * @param ?string $codCollectionMethod The cod collection method, support in JP only. + * @param ?string $codCollectionMethod The COD collection method (only supported in the JP marketplace). */ public function __construct( public readonly PackageDetail $packageDetail, diff --git a/src/Seller/OrdersV0/Dto/FulfillmentInstruction.php b/src/Seller/OrdersV0/Dto/FulfillmentInstruction.php index 61b91b50c..1864eab63 100644 --- a/src/Seller/OrdersV0/Dto/FulfillmentInstruction.php +++ b/src/Seller/OrdersV0/Dto/FulfillmentInstruction.php @@ -17,7 +17,7 @@ final class FulfillmentInstruction extends Dto protected static array $attributeMap = ['fulfillmentSupplySourceId' => 'FulfillmentSupplySourceId']; /** - * @param ?string $fulfillmentSupplySourceId Denotes the recommended `sourceId` where the order should be fulfilled from. + * @param ?string $fulfillmentSupplySourceId The `sourceId` of the location from where you want the order fulfilled. */ public function __construct( public readonly ?string $fulfillmentSupplySourceId = null, diff --git a/src/Seller/OrdersV0/Dto/ItemBuyerInfo.php b/src/Seller/OrdersV0/Dto/ItemBuyerInfo.php index 4ff7c9bee..cd0f4c231 100644 --- a/src/Seller/OrdersV0/Dto/ItemBuyerInfo.php +++ b/src/Seller/OrdersV0/Dto/ItemBuyerInfo.php @@ -28,7 +28,7 @@ final class ItemBuyerInfo extends Dto * @param ?Money $giftWrapTax The monetary value of the order. * @param ?string $giftMessageText A gift message provided by the buyer. * - * **Note**: This attribute is only available for MFN (Fulfilled by the seller) orders. + * **Note**: This attribute is only available for MFN (fulfilled by seller) orders. * @param ?string $giftWrapLevel The gift wrap level specified by the buyer. */ public function __construct( diff --git a/src/Seller/OrdersV0/Dto/Measurement.php b/src/Seller/OrdersV0/Dto/Measurement.php index 777617e58..08a8de6a9 100644 --- a/src/Seller/OrdersV0/Dto/Measurement.php +++ b/src/Seller/OrdersV0/Dto/Measurement.php @@ -17,8 +17,8 @@ final class Measurement extends Dto protected static array $attributeMap = ['unit' => 'Unit', 'value' => 'Value']; /** - * @param string $unit The unit of measure for this measurement. - * @param float $value The value of the measurement. + * @param string $unit The unit of measure. + * @param float $value The measurement value. */ public function __construct( public readonly string $unit, diff --git a/src/Seller/OrdersV0/Dto/Order.php b/src/Seller/OrdersV0/Dto/Order.php index 2ec70d37b..0ca3d2894 100644 --- a/src/Seller/OrdersV0/Dto/Order.php +++ b/src/Seller/OrdersV0/Dto/Order.php @@ -71,42 +71,42 @@ final class Order extends Dto * @param string $purchaseDate The date when the order was created. * @param string $lastUpdateDate The date when the order was last updated. * - * **Note**: `LastUpdateDate` is returned with an incorrect date for orders that were last updated before 2009-04-01. + * __Note__: `LastUpdateDate` is returned with an incorrect date for orders that were last updated before 2009-04-01. * @param string $orderStatus The current order status. * @param ?string $sellerOrderId A seller-defined order identifier. - * @param ?string $fulfillmentChannel Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN). - * @param ?string $salesChannel The sales channel of the first item in the order. - * @param ?string $orderChannel The order channel of the first item in the order. - * @param ?string $shipServiceLevel The shipment service level of the order. + * @param ?string $fulfillmentChannel Whether the order was fulfilled by Amazon (`AFN`) or by the seller (`MFN`). + * @param ?string $salesChannel The sales channel for the first item in the order. + * @param ?string $orderChannel The order channel for the first item in the order. + * @param ?string $shipServiceLevel The order's shipment service level. * @param ?Money $orderTotal The monetary value of the order. * @param ?int $numberOfItemsShipped The number of items shipped. * @param ?int $numberOfItemsUnshipped The number of items unshipped. * @param PaymentExecutionDetailItem[]|null $paymentExecutionDetail A list of payment execution detail items. - * @param ?string $paymentMethod 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. + * @param ?string $paymentMethod The payment method for the order. This property is limited to COD and 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. * @param ?string[] $paymentMethodDetails A list of payment method detail items. * @param ?string $marketplaceId The identifier for the marketplace where the order was placed. - * @param ?string $shipmentServiceLevelCategory The shipment service level category of the order. + * @param ?string $shipmentServiceLevelCategory The shipment service level category for the order. * - * **Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, `Standard`. - * @param ?string $easyShipShipmentStatus The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders. + * **Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, and `Standard`. + * @param ?string $easyShipShipmentStatus The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders. * @param ?string $cbaDisplayableShippingLabel Custom ship label for Checkout by Amazon (CBA). - * @param ?string $orderType The type of the order. - * @param ?string $earliestShipDate 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. + * @param ?string $orderType The order's type. + * @param ?string $earliestShipDate The start of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. * - * **Note**: `EarliestShipDate` might not be returned for orders placed before February 1, 2013. - * @param ?string $latestShipDate 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. + * __Note__: `EarliestShipDate` might not be returned for orders placed before February 1, 2013. + * @param ?string $latestShipDate The end of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. * - * **Note**: `LatestShipDate` might not be returned for orders placed before February 1, 2013. - * @param ?string $earliestDeliveryDate 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. - * @param ?string $latestDeliveryDate 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. + * __Note__: `LatestShipDate` might not be returned for orders placed before February 1, 2013. + * @param ?string $earliestDeliveryDate The start of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. + * @param ?string $latestDeliveryDate The end of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders that do not have a `PendingAvailability`, `Pending`, or `Canceled` status. * @param ?bool $isBusinessOrder When true, the order is an Amazon Business order. An Amazon Business order is an order where the buyer is a Verified Business Buyer. * @param ?bool $isPrime When true, the order is a seller-fulfilled Amazon Prime order. - * @param ?bool $isPremiumOrder 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. - * @param ?bool $isGlobalExpressEnabled When true, the order is a GlobalExpress order. - * @param ?string $replacedOrderId The order ID value for the order that is being replaced. Returned only if `IsReplacementOrder` = true. + * @param ?bool $isPremiumOrder When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, refer to "Premium Shipping Options" in the Seller Central Help for your marketplace. + * @param ?bool $isGlobalExpressEnabled When true, the order is a `GlobalExpress` order. + * @param ?string $replacedOrderId The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true. * @param ?bool $isReplacementOrder When true, this is a replacement order. - * @param ?string $promiseResponseDueDate Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders. - * @param ?bool $isEstimatedShipDateSet When true, the estimated ship date is specified for the order. Returned only for Sourcing on Demand orders. + * @param ?string $promiseResponseDueDate Indicates the date by which the seller must respond to the buyer with an estimated ship date. Only returned for Sourcing on Demand orders. + * @param ?bool $isEstimatedShipDateSet When true, the estimated ship date is set for the order. Only returned for Sourcing on Demand orders. * @param ?bool $isSoldByAb 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. * @param ?bool $isIba 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. * @param ?Address $defaultShipFromLocationAddress The shipping address for the order. @@ -114,7 +114,7 @@ final class Order extends Dto * * **Note**: This attribute is only available in the Turkey marketplace. * @param ?BuyerTaxInformation $buyerTaxInformation Contains the business invoice tax information. Available only in the TR marketplace. - * @param ?FulfillmentInstruction $fulfillmentInstruction Contains the instructions about the fulfillment like where should it be fulfilled from. + * @param ?FulfillmentInstruction $fulfillmentInstruction Contains the instructions about the fulfillment, such as the location from where you want the order filled. * @param ?bool $isIspu When true, this order is marked to be picked up from a store rather than delivered. * @param ?bool $isAccessPointOrder 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. * @param ?MarketplaceTaxInfo $marketplaceTaxInfo Tax information about the marketplace. diff --git a/src/Seller/OrdersV0/Dto/OrderAddress.php b/src/Seller/OrdersV0/Dto/OrderAddress.php index 2b5da862d..2fcf9dd05 100644 --- a/src/Seller/OrdersV0/Dto/OrderAddress.php +++ b/src/Seller/OrdersV0/Dto/OrderAddress.php @@ -23,7 +23,7 @@ final class OrderAddress extends Dto /** * @param string $amazonOrderId An Amazon-defined order identifier, in 3-7-7 format. - * @param ?string $buyerCompanyName The company name of the contact buyer. For Invoice By Amazon (IBA) orders, the buyer company should be Amazon entities. + * @param ?string $buyerCompanyName The company name of the contact buyer. For IBA orders, the buyer company must be Amazon entities. * @param ?Address $shippingAddress The shipping address for the order. * @param ?DeliveryPreferences $deliveryPreferences Contains all of the delivery instructions provided by the customer for the shipping address. */ diff --git a/src/Seller/OrdersV0/Dto/OrderBuyerInfo.php b/src/Seller/OrdersV0/Dto/OrderBuyerInfo.php index 6f85a7abe..afc6ccd19 100644 --- a/src/Seller/OrdersV0/Dto/OrderBuyerInfo.php +++ b/src/Seller/OrdersV0/Dto/OrderBuyerInfo.php @@ -31,7 +31,7 @@ final class OrderBuyerInfo extends Dto * * **Note**: This attribute is only available in the Brazil marketplace. * @param ?BuyerTaxInfo $buyerTaxInfo Tax information about the buyer. - * @param ?string $purchaseOrderNumber The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout. + * @param ?string $purchaseOrderNumber The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout. */ public function __construct( public readonly string $amazonOrderId, diff --git a/src/Seller/OrdersV0/Dto/OrderItem.php b/src/Seller/OrdersV0/Dto/OrderItem.php index 2798d53ba..ab6cab05e 100644 --- a/src/Seller/OrdersV0/Dto/OrderItem.php +++ b/src/Seller/OrdersV0/Dto/OrderItem.php @@ -54,17 +54,18 @@ final class OrderItem extends Dto 'substitutionPreferences' => 'SubstitutionPreferences', 'measurement' => 'Measurement', 'shippingConstraints' => 'ShippingConstraints', + 'amazonPrograms' => 'AmazonPrograms', ]; protected static array $complexArrayTypes = ['associatedItems' => AssociatedItem::class]; /** - * @param string $asin The Amazon Standard Identification Number (ASIN) of the item. + * @param string $asin The item's Amazon Standard Identification Number (ASIN). * @param string $orderItemId An Amazon-defined order item identifier. * @param int $quantityOrdered The number of items in the order. - * @param ?string $sellerSku The seller stock keeping unit (SKU) of the item. + * @param ?string $sellerSku The item's seller stock keeping unit (SKU). * @param AssociatedItem[]|null $associatedItems A list of associated items that a customer has purchased with a product. For example, a tire installation service purchased with tires. - * @param ?string $title The name of the item. + * @param ?string $title The item's name. * @param ?int $quantityShipped The number of items shipped. * @param ?ProductInfoDetail $productInfo Product information on the number of items. * @param ?PointsGrantedDetail $pointsGranted The number of Amazon Points offered with the purchase of an item, and their monetary value. @@ -81,29 +82,29 @@ final class OrderItem extends Dto * @param ?Money $codFeeDiscount The monetary value of the order. * @param ?string $isGift Indicates whether the item is a gift. * - * **Possible values**: `true`, `false`. - * @param ?string $conditionNote The condition of the item as described by the seller. + * **Possible values**: `true` and `false`. + * @param ?string $conditionNote The condition of the item, as described by the seller. * @param ?string $conditionId The condition of the item. * - * **Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, `Club`. + * **Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, and `Club`. * @param ?string $conditionSubtypeId The subcondition of the item. * - * **Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, `Other`. - * @param ?string $scheduledDeliveryStartDate The start date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format. - * @param ?string $scheduledDeliveryEndDate The end date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format. - * @param ?string $priceDesignation 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, refer to [Amazon Business](https://business.amazon.com). + * **Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, and `Other`. + * @param ?string $scheduledDeliveryStartDate The start date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. + * @param ?string $scheduledDeliveryEndDate The end date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. + * @param ?string $priceDesignation 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). * - * **Possible values**: `BusinessPrice` - A special price that is available only for Amazon Business orders. + * **Possible values**: `BusinessPrice` * @param ?TaxCollection $taxCollection Information about withheld taxes. * @param ?bool $serialNumberRequired When true, the product type for this item has a serial number. * - * Returned only for Amazon Easy Ship orders. - * @param ?bool $isTransparency When true, the ASIN is enrolled in Transparency and the Transparency serial number that needs to be submitted can be determined by the following: + * Only returned for Amazon Easy Ship orders. + * @param ?bool $isTransparency When true, the ASIN is enrolled in Transparency. The Transparency serial number that you must submit is determined by: * * **1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN). - * **2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number will be applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode. + * **2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode. * **QR code SN:** Submit the URL that the QR code generates. - * @param ?string $iossNumber 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. + * @param ?string $iossNumber The IOSS number of the marketplace. 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. * @param ?string $storeChainStoreId The store chain store identifier. Linked to a specific store in a store chain. * @param ?string $deemedResellerCategory 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. * @param ?ItemBuyerInfo $buyerInfo A single item's buyer information. @@ -112,6 +113,10 @@ final class OrderItem extends Dto * @param ?SubstitutionPreferences $substitutionPreferences Substitution preferences for an order item. * @param ?Measurement $measurement Measurement information for an order item. * @param ?ShippingConstraints $shippingConstraints Delivery constraints applicable to this order. + * @param ?AmazonPrograms $amazonPrograms Contains the list of programs that are associated with an item. + * + * Possible programs are: + * - **Subscribe and Save**: Offers recurring, scheduled deliveries to Amazon customers and Amazon Business customers for their frequently ordered products. */ public function __construct( public readonly string $asin, @@ -153,5 +158,6 @@ public function __construct( public readonly ?SubstitutionPreferences $substitutionPreferences = null, public readonly ?Measurement $measurement = null, public readonly ?ShippingConstraints $shippingConstraints = null, + public readonly ?AmazonPrograms $amazonPrograms = null, ) {} } diff --git a/src/Seller/OrdersV0/Dto/OrderItemBuyerInfo.php b/src/Seller/OrdersV0/Dto/OrderItemBuyerInfo.php index aa584b9ef..ae0e582ae 100644 --- a/src/Seller/OrdersV0/Dto/OrderItemBuyerInfo.php +++ b/src/Seller/OrdersV0/Dto/OrderItemBuyerInfo.php @@ -30,7 +30,7 @@ final class OrderItemBuyerInfo extends Dto * @param ?Money $giftWrapTax The monetary value of the order. * @param ?string $giftMessageText A gift message provided by the buyer. * - * **Note**: This attribute is only available for MFN (Fulfilled by the seller) orders. + * **Note**: This attribute is only available for MFN (fulfilled by seller) orders. * @param ?string $giftWrapLevel The gift wrap level specified by the buyer. */ public function __construct( diff --git a/src/Seller/OrdersV0/Dto/OrderItems.php b/src/Seller/OrdersV0/Dto/OrderItems.php index 53520adb8..11d0c1217 100644 --- a/src/Seller/OrdersV0/Dto/OrderItems.php +++ b/src/Seller/OrdersV0/Dto/OrderItems.php @@ -15,7 +15,7 @@ final class OrderItems extends Dto { /** - * @param ?string $orderItemId The unique identifier of the order item. + * @param ?string $orderItemId The order item's unique identifier. * @param ?int $quantity The quantity for which to update the shipment status. */ public function __construct( diff --git a/src/Seller/OrdersV0/Dto/OrderRegulatedInfo.php b/src/Seller/OrdersV0/Dto/OrderRegulatedInfo.php index e60d5262a..ca93c46d0 100644 --- a/src/Seller/OrdersV0/Dto/OrderRegulatedInfo.php +++ b/src/Seller/OrdersV0/Dto/OrderRegulatedInfo.php @@ -25,7 +25,7 @@ final class OrderRegulatedInfo extends Dto * @param string $amazonOrderId An Amazon-defined order identifier, in 3-7-7 format. * @param RegulatedInformation $regulatedInformation The regulated information collected during purchase and used to verify the order. * @param bool $requiresDosageLabel When true, the order requires attaching a dosage information label when shipped. - * @param RegulatedOrderVerificationStatus $regulatedOrderVerificationStatus The verification status of the order along with associated approval or rejection metadata. + * @param RegulatedOrderVerificationStatus $regulatedOrderVerificationStatus The verification status of the order, along with associated approval or rejection metadata. */ public function __construct( public readonly string $amazonOrderId, diff --git a/src/Seller/OrdersV0/Dto/OrdersList.php b/src/Seller/OrdersV0/Dto/OrdersList.php index beface9c0..ef1ef140b 100644 --- a/src/Seller/OrdersV0/Dto/OrdersList.php +++ b/src/Seller/OrdersV0/Dto/OrdersList.php @@ -26,8 +26,8 @@ final class OrdersList extends Dto /** * @param Order[] $orders A list of orders. * @param ?string $nextToken When present and not empty, pass this string token in the next request to return the next response page. - * @param ?string $lastUpdatedBefore 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. - * @param ?string $createdBefore 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. + * @param ?string $lastUpdatedBefore 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. All dates must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. + * @param ?string $createdBefore 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. */ public function __construct( public readonly array $orders, diff --git a/src/Seller/OrdersV0/Dto/PackageDetail.php b/src/Seller/OrdersV0/Dto/PackageDetail.php index 4e7a6f2f6..38dc727e4 100644 --- a/src/Seller/OrdersV0/Dto/PackageDetail.php +++ b/src/Seller/OrdersV0/Dto/PackageDetail.php @@ -18,13 +18,13 @@ final class PackageDetail extends Dto /** * @param string $packageReferenceId A seller-supplied identifier that uniquely identifies a package within the scope of an order. Only positive numeric values are supported. - * @param string $carrierCode Identifies the carrier that will deliver the package. This field is required for all marketplaces. For the acceptable `CarrierCode` value, refer to the list of CarrierCode. + * @param string $carrierCode Identifies the carrier that will deliver the package. This field is required for all marketplaces. For more information, refer to the [`CarrierCode` announcement](https://developer-docs.amazon.com/sp-api/changelog/carriercode-value-required-in-shipment-confirmations-for-br-mx-ca-sg-au-in-jp-marketplaces). * @param string $trackingNumber The tracking number used to obtain tracking and delivery information. * @param \DateTimeInterface $shipDate The shipping date for the package. Must be in ISO 8601 date/time format. * @param ConfirmShipmentOrderItem[] $orderItems A list of order items. - * @param ?string $carrierName Carrier Name that will deliver the package. Required when carrierCode is "Others" + * @param ?string $carrierName Carrier Name that will deliver the package. Required when `carrierCode` is "Others" * @param ?string $shippingMethod Ship method to be used for shipping the order. - * @param ?string $shipFromSupplySourceId The unique identifier of the supply source. + * @param ?string $shipFromSupplySourceId The unique identifier for the supply source. */ public function __construct( public readonly string $packageReferenceId, diff --git a/src/Seller/OrdersV0/Dto/PaymentExecutionDetailItem.php b/src/Seller/OrdersV0/Dto/PaymentExecutionDetailItem.php index c676d4df5..f46044190 100644 --- a/src/Seller/OrdersV0/Dto/PaymentExecutionDetailItem.php +++ b/src/Seller/OrdersV0/Dto/PaymentExecutionDetailItem.php @@ -21,10 +21,10 @@ final class PaymentExecutionDetailItem extends Dto * @param string $paymentMethod A sub-payment method for a COD order. * * **Possible values**: - * * `COD`: Cash On Delivery. - * * `GC`: Gift Card. - * * `PointsAccount`: Amazon Points. - * * `Invoice`: Invoice. + * * `COD`: Cash on delivery + * * `GC`: Gift card + * * `PointsAccount`: Amazon Points + * * `Invoice`: Invoice */ public function __construct( public readonly Money $payment, diff --git a/src/Seller/OrdersV0/Dto/PreferredDeliveryTime.php b/src/Seller/OrdersV0/Dto/PreferredDeliveryTime.php index e66115590..fe7abc888 100644 --- a/src/Seller/OrdersV0/Dto/PreferredDeliveryTime.php +++ b/src/Seller/OrdersV0/Dto/PreferredDeliveryTime.php @@ -23,7 +23,7 @@ final class PreferredDeliveryTime extends Dto /** * @param BusinessHours[]|null $businessHours Business hours when the business is open for deliveries. - * @param ExceptionDates[]|null $exceptionDates Dates when the business is closed in the next 30 days. + * @param ExceptionDates[]|null $exceptionDates Dates when the business is closed during the next 30 days. */ public function __construct( public readonly ?array $businessHours = null, diff --git a/src/Seller/OrdersV0/Dto/PrescriptionDetail.php b/src/Seller/OrdersV0/Dto/PrescriptionDetail.php new file mode 100644 index 000000000..824c7b98c --- /dev/null +++ b/src/Seller/OrdersV0/Dto/PrescriptionDetail.php @@ -0,0 +1,35 @@ + 'RejectionReason', 'reviewDate' => 'ReviewDate', 'externalReviewerId' => 'ExternalReviewerId', + 'validVerificationDetails' => 'ValidVerificationDetails', ]; - protected static array $complexArrayTypes = ['validRejectionReasons' => RejectionReason::class]; + protected static array $complexArrayTypes = [ + 'validRejectionReasons' => RejectionReason::class, + 'validVerificationDetails' => ValidVerificationDetail::class, + ]; /** * @param string $status The verification status of the order. * @param bool $requiresMerchantAction When true, the regulated information provided in the order requires a review by the merchant. * @param RejectionReason[] $validRejectionReasons A list of valid rejection reasons that may be used to reject the order's regulated information. - * @param ?RejectionReason $rejectionReason The reason for rejecting the order's regulated information. Not present if the order isn't rejected. - * @param ?string $reviewDate The date the order was reviewed. In ISO 8601 date time format. + * @param ?RejectionReason $rejectionReason The reason for rejecting the order's regulated information. This is only present if the order is rejected. + * @param ?string $reviewDate The date the order was reviewed. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. * @param ?string $externalReviewerId The identifier for the order's regulated information reviewer. + * @param ValidVerificationDetail[]|null $validVerificationDetails A list of valid verification details that may be provided and the criteria required for when the verification detail can be provided. */ public function __construct( public readonly string $status, @@ -40,5 +45,6 @@ public function __construct( public readonly ?RejectionReason $rejectionReason = null, public readonly ?string $reviewDate = null, public readonly ?string $externalReviewerId = null, + public readonly ?array $validVerificationDetails = null, ) {} } diff --git a/src/Seller/OrdersV0/Dto/ShippingConstraints.php b/src/Seller/OrdersV0/Dto/ShippingConstraints.php index a2aea6e8b..c7d1d07a3 100644 --- a/src/Seller/OrdersV0/Dto/ShippingConstraints.php +++ b/src/Seller/OrdersV0/Dto/ShippingConstraints.php @@ -14,12 +14,23 @@ final class ShippingConstraints extends Dto { - protected static array $attributeMap = ['palletDelivery' => 'PalletDelivery']; + protected static array $attributeMap = [ + 'palletDelivery' => 'PalletDelivery', + 'signatureConfirmation' => 'SignatureConfirmation', + 'recipientIdentityVerification' => 'RecipientIdentityVerification', + 'recipientAgeVerification' => 'RecipientAgeVerification', + ]; /** * @param ?string $palletDelivery Details the importance of the constraint present on the item + * @param ?string $signatureConfirmation Details the importance of the constraint present on the item + * @param ?string $recipientIdentityVerification Details the importance of the constraint present on the item + * @param ?string $recipientAgeVerification Details the importance of the constraint present on the item */ public function __construct( public readonly ?string $palletDelivery = null, + public readonly ?string $signatureConfirmation = null, + public readonly ?string $recipientIdentityVerification = null, + public readonly ?string $recipientAgeVerification = null, ) {} } diff --git a/src/Seller/OrdersV0/Dto/SubstitutionOption.php b/src/Seller/OrdersV0/Dto/SubstitutionOption.php index bc6ccd306..57a6ad60c 100644 --- a/src/Seller/OrdersV0/Dto/SubstitutionOption.php +++ b/src/Seller/OrdersV0/Dto/SubstitutionOption.php @@ -23,10 +23,10 @@ final class SubstitutionOption extends Dto ]; /** - * @param ?string $asin The Amazon Standard Identification Number (ASIN) of the item. + * @param ?string $asin The item's Amazon Standard Identification Number (ASIN). * @param ?int $quantityOrdered The number of items to be picked for this substitution option. - * @param ?string $sellerSku The seller stock keeping unit (SKU) of the item. - * @param ?string $title The title of the item. + * @param ?string $sellerSku The item's seller stock keeping unit (SKU). + * @param ?string $title The item's title. * @param ?Measurement $measurement Measurement information for an order item. */ public function __construct( diff --git a/src/Seller/OrdersV0/Dto/UpdateShipmentStatusRequest.php b/src/Seller/OrdersV0/Dto/UpdateShipmentStatusRequest.php index e70180ae7..8decec48f 100644 --- a/src/Seller/OrdersV0/Dto/UpdateShipmentStatusRequest.php +++ b/src/Seller/OrdersV0/Dto/UpdateShipmentStatusRequest.php @@ -17,7 +17,6 @@ final class UpdateShipmentStatusRequest extends Dto /** * @param string $marketplaceId The unobfuscated marketplace identifier. * @param string $shipmentStatus The shipment status to apply. - * @param ?OrderItems $orderItems */ public function __construct( public readonly string $marketplaceId, diff --git a/src/Seller/OrdersV0/Dto/UpdateVerificationStatusRequestBody.php b/src/Seller/OrdersV0/Dto/UpdateVerificationStatusRequestBody.php index 41466ef35..5726fb496 100644 --- a/src/Seller/OrdersV0/Dto/UpdateVerificationStatusRequestBody.php +++ b/src/Seller/OrdersV0/Dto/UpdateVerificationStatusRequestBody.php @@ -15,13 +15,15 @@ final class UpdateVerificationStatusRequestBody extends Dto { /** - * @param string $status The verification status of the order. - * @param string $externalReviewerId The identifier for the order's regulated information reviewer. - * @param ?string $rejectionReasonId The unique identifier for the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected. + * @param string $externalReviewerId The identifier of the order's regulated information reviewer. + * @param ?string $status The verification status of the order. + * @param ?string $rejectionReasonId The unique identifier of the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected. + * @param ?VerificationDetails $verificationDetails Additional information related to the verification of a regulated order. */ public function __construct( - public readonly string $status, public readonly string $externalReviewerId, + public readonly ?string $status = null, public readonly ?string $rejectionReasonId = null, + public readonly ?VerificationDetails $verificationDetails = null, ) {} } diff --git a/src/Seller/OrdersV0/Dto/ValidVerificationDetail.php b/src/Seller/OrdersV0/Dto/ValidVerificationDetail.php new file mode 100644 index 000000000..1b72a476b --- /dev/null +++ b/src/Seller/OrdersV0/Dto/ValidVerificationDetail.php @@ -0,0 +1,30 @@ + 'VerificationDetailType', + 'validVerificationStatuses' => 'ValidVerificationStatuses', + ]; + + /** + * @param string $verificationDetailType A supported type of verification detail. The type indicates which verification detail could be shared while updating the regulated order. Valid value: `prescriptionDetail`. + * @param string[] $validVerificationStatuses A list of valid verification statuses where the associated verification detail type may be provided. For example, if the value of this field is ["Approved"], calls to provide the associated verification detail will fail for orders with a `VerificationStatus` of `Pending`, `Rejected`, `Expired`, or `Cancelled`. + */ + public function __construct( + public readonly string $verificationDetailType, + public readonly array $validVerificationStatuses, + ) {} +} diff --git a/src/Seller/OrdersV0/Dto/VerificationDetails.php b/src/Seller/OrdersV0/Dto/VerificationDetails.php new file mode 100644 index 000000000..b7655bef6 --- /dev/null +++ b/src/Seller/OrdersV0/Dto/VerificationDetails.php @@ -0,0 +1,23 @@ +ISO 8601 format. + * Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values. + * @param ?string $createdAfter 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. * - * **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. You could specify `CreatedBefore` but not provide `LastUpdatedAfter` or `LastUpdatedBefore` when `CreatedAfter` is specified. - * @param ?string $createdBefore 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. + * **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. + * @param ?string $createdBefore 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. * - * **Note**: `CreatedBefore` is optional when `CreatedAfter` is specified. But if specified, `CreatedBefore` should be equal to or after the `CreatedAfter` date and at least 2 minutes before the current time. - * @param ?string $lastUpdatedAfter 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. + * **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. + * @param ?string $lastUpdatedAfter 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. * - * **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is specified. But if specified, `LastUpdatedBefore` should be equal to or after the `LastUpdatedAfter` date and at least 2 minutes before current time. - * @param ?string $lastUpdatedBefore 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. + * **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. + * @param ?string $lastUpdatedBefore 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. * - * **Note**: LastUpdatedBefore is optional when LastUpdatedAfter is set. But if specified, LastUpdatedBefore should be equal to or after the LastUpdatedAfter date and at least 2 minutes before current time. + * **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. * @param ?array $orderStatuses A list of `OrderStatus` values used to filter the results. * * **Possible values:** @@ -53,12 +53,12 @@ class GetOrders extends Request * - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.) * @param ?array $fulfillmentChannels 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). - * @param ?array $paymentMethods A list of payment method values. Used to select orders paid using the specified payment methods. + * **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller). + * @param ?array $paymentMethods A list of payment method values. Use this field to select orders that were paid with the specified payment methods. * - * **Possible values**: `COD` (Cash on delivery); `CVS` (Convenience store payment); `Other` (Any payment method other than `COD` or `CVS`). + * **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS). * @param ?string $buyerEmail The email address of a buyer. Used to select orders that contain the specified email address. - * @param ?string $sellerOrderId 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. + * @param ?string $sellerOrderId 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. * @param ?int $maxResultsPerPage A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100. * @param ?array $easyShipShipmentStatuses 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. * @@ -88,14 +88,14 @@ class GetOrders extends Request * - `Errored` (The last submitted electronic invoice was rejected for this order.) * - `Accepted` (The last submitted electronic invoice was submitted and accepted.) * @param ?string $nextToken A string token returned in the response of your previous request. - * @param ?array $amazonOrderIds A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. - * @param ?string $actualFulfillmentSupplySourceId Denotes the recommended sourceId where the order should be fulfilled from. + * @param ?array $amazonOrderIds A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format. + * @param ?string $actualFulfillmentSupplySourceId The `sourceId` of the location from where you want the order fulfilled. * @param ?bool $isIspu When true, this order is marked to be picked up from a store rather than delivered. * @param ?string $storeChainStoreId The store chain store identifier. Linked to a specific store in a store chain. - * @param ?string $earliestDeliveryDateBefore A date used for selecting orders with a earliest delivery date before (or at) a specified time. The date must be in ISO 8601 format. - * @param ?string $earliestDeliveryDateAfter A date used for selecting orders with a earliest delivery date after (or at) a specified time. The date must be in ISO 8601 format. - * @param ?string $latestDeliveryDateBefore A date used for selecting orders with a latest delivery date before (or at) a specified time. The date must be in ISO 8601 format. - * @param ?string $latestDeliveryDateAfter A date used for selecting orders with a latest delivery date after (or at) a specified time. The date must be in ISO 8601 format. + * @param ?string $earliestDeliveryDateBefore 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. + * @param ?string $earliestDeliveryDateAfter 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. + * @param ?string $latestDeliveryDateBefore 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. + * @param ?string $latestDeliveryDateAfter 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. */ public function __construct( protected array $marketplaceIds, diff --git a/src/Seller/ProductFeesV0/Dto/FeeDetail.php b/src/Seller/ProductFeesV0/Dto/FeeDetail.php index 1af76e4ff..b8fd57fe1 100644 --- a/src/Seller/ProductFeesV0/Dto/FeeDetail.php +++ b/src/Seller/ProductFeesV0/Dto/FeeDetail.php @@ -27,8 +27,6 @@ final class FeeDetail extends Dto /** * @param string $feeType The type of fee charged to a seller. - * @param ?MoneyType $feePromotion - * @param ?MoneyType $taxAmount * @param IncludedFeeDetail[]|null $includedFeeDetailList A list of other fees that contribute to a given fee. */ public function __construct( diff --git a/src/Seller/ProductFeesV0/Dto/FeesEstimate.php b/src/Seller/ProductFeesV0/Dto/FeesEstimate.php index 8eae0bfe8..522c0a476 100644 --- a/src/Seller/ProductFeesV0/Dto/FeesEstimate.php +++ b/src/Seller/ProductFeesV0/Dto/FeesEstimate.php @@ -24,7 +24,6 @@ final class FeesEstimate extends Dto /** * @param \DateTimeInterface $timeOfFeesEstimation The time at which the fees were estimated. This defaults to the time the request is made. - * @param ?MoneyType $totalFeesEstimate * @param FeeDetail[]|null $feeDetailList A list of other fees that contribute to a given fee. */ public function __construct( diff --git a/src/Seller/ProductFeesV0/Dto/IncludedFeeDetail.php b/src/Seller/ProductFeesV0/Dto/IncludedFeeDetail.php index 9bc3ec07f..28348e94e 100644 --- a/src/Seller/ProductFeesV0/Dto/IncludedFeeDetail.php +++ b/src/Seller/ProductFeesV0/Dto/IncludedFeeDetail.php @@ -24,8 +24,6 @@ final class IncludedFeeDetail extends Dto /** * @param string $feeType The type of fee charged to a seller. - * @param ?MoneyType $feePromotion - * @param ?MoneyType $taxAmount */ public function __construct( public readonly string $feeType, diff --git a/src/Seller/ProductFeesV0/Dto/Points.php b/src/Seller/ProductFeesV0/Dto/Points.php index 36fa66bcf..1a8b1fa47 100644 --- a/src/Seller/ProductFeesV0/Dto/Points.php +++ b/src/Seller/ProductFeesV0/Dto/Points.php @@ -19,10 +19,6 @@ final class Points extends Dto 'pointsMonetaryValue' => 'PointsMonetaryValue', ]; - /** - * @param ?int $pointsNumber - * @param ?MoneyType $pointsMonetaryValue - */ public function __construct( public readonly ?int $pointsNumber = null, public readonly ?MoneyType $pointsMonetaryValue = null, diff --git a/src/Seller/ProductFeesV0/Dto/PriceToEstimateFees.php b/src/Seller/ProductFeesV0/Dto/PriceToEstimateFees.php index b2c8370ef..bcb9bf8dd 100644 --- a/src/Seller/ProductFeesV0/Dto/PriceToEstimateFees.php +++ b/src/Seller/ProductFeesV0/Dto/PriceToEstimateFees.php @@ -20,10 +20,6 @@ final class PriceToEstimateFees extends Dto 'points' => 'Points', ]; - /** - * @param ?MoneyType $shipping - * @param ?Points $points - */ public function __construct( public readonly MoneyType $listingPrice, public readonly ?MoneyType $shipping = null, diff --git a/src/Seller/ProductPricingV0/Dto/BuyBoxPriceType.php b/src/Seller/ProductPricingV0/Dto/BuyBoxPriceType.php index f7c84b223..9392105f9 100644 --- a/src/Seller/ProductPricingV0/Dto/BuyBoxPriceType.php +++ b/src/Seller/ProductPricingV0/Dto/BuyBoxPriceType.php @@ -23,10 +23,7 @@ final class BuyBoxPriceType extends Dto /** * @param string $condition Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. - * @param ?string $offerType * @param ?int $quantityTier Indicates at what quantity this price becomes active. - * @param ?string $quantityDiscountType - * @param ?Points $points * @param ?string $sellerId The seller identifier for the offer. */ public function __construct( diff --git a/src/Seller/ProductPricingV0/Dto/CompetitivePriceType.php b/src/Seller/ProductPricingV0/Dto/CompetitivePriceType.php index c226adc82..62d35284f 100644 --- a/src/Seller/ProductPricingV0/Dto/CompetitivePriceType.php +++ b/src/Seller/ProductPricingV0/Dto/CompetitivePriceType.php @@ -25,9 +25,7 @@ final class CompetitivePriceType extends Dto * * 2 - Used Buy Box Price. * @param ?string $condition Indicates the condition of the item whose pricing information is returned. Possible values are: New, Used, Collectible, Refurbished, or Club. * @param ?string $subcondition Indicates the subcondition of the item whose pricing information is returned. Possible values are: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. - * @param ?string $offerType * @param ?int $quantityTier Indicates at what quantity this price becomes active. - * @param ?string $quantityDiscountType * @param ?string $sellerId The seller identifier for the offer. * @param ?bool $belongsToRequester Indicates whether or not the pricing information is for an offer listing that belongs to the requester. The requester is the seller associated with the SellerId that was submitted with the request. Possible values are: true and false. */ diff --git a/src/Seller/ProductPricingV0/Dto/CompetitivePricingType.php b/src/Seller/ProductPricingV0/Dto/CompetitivePricingType.php index d6e9d99e7..dd56bb5fd 100644 --- a/src/Seller/ProductPricingV0/Dto/CompetitivePricingType.php +++ b/src/Seller/ProductPricingV0/Dto/CompetitivePricingType.php @@ -28,7 +28,6 @@ final class CompetitivePricingType extends Dto /** * @param CompetitivePriceType[] $competitivePrices A list of competitive pricing information. * @param OfferListingCountType[] $numberOfOfferListings The number of active offer listings for the item that was submitted. The listing count is returned by condition, one for each listing condition value that is returned. - * @param ?MoneyType $tradeInValue */ public function __construct( public readonly array $competitivePrices, diff --git a/src/Seller/ProductPricingV0/Dto/HttpResponseHeaders.php b/src/Seller/ProductPricingV0/Dto/HttpResponseHeaders.php index aeaaa2149..c21fc91e5 100644 --- a/src/Seller/ProductPricingV0/Dto/HttpResponseHeaders.php +++ b/src/Seller/ProductPricingV0/Dto/HttpResponseHeaders.php @@ -22,7 +22,6 @@ final class HttpResponseHeaders extends Dto /** * @param ?string $date The timestamp that the API request was received. For more information, consult [RFC 2616 Section 14](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). * @param ?string $xAmznRequestId Unique request reference ID. - * @param ?string $additionalProperties */ public function __construct( public readonly ?string $date = null, diff --git a/src/Seller/ProductPricingV0/Dto/IdentifierType.php b/src/Seller/ProductPricingV0/Dto/IdentifierType.php index 4a069ebf8..ca7384029 100644 --- a/src/Seller/ProductPricingV0/Dto/IdentifierType.php +++ b/src/Seller/ProductPricingV0/Dto/IdentifierType.php @@ -16,9 +16,6 @@ final class IdentifierType extends Dto { protected static array $attributeMap = ['marketplaceAsin' => 'MarketplaceASIN', 'skuIdentifier' => 'SKUIdentifier']; - /** - * @param ?SellerSkuIdentifier $skuIdentifier - */ public function __construct( public readonly AsinIdentifier $marketplaceAsin, public readonly ?SellerSkuIdentifier $skuIdentifier = null, diff --git a/src/Seller/ProductPricingV0/Dto/ListingOffersResponse.php b/src/Seller/ProductPricingV0/Dto/ListingOffersResponse.php index 39bb8c263..22968528b 100644 --- a/src/Seller/ProductPricingV0/Dto/ListingOffersResponse.php +++ b/src/Seller/ProductPricingV0/Dto/ListingOffersResponse.php @@ -19,7 +19,6 @@ final class ListingOffersResponse extends Dto * @param GetOffersResponse $body The response schema for the `getListingOffers` and `getItemOffers` operations. * @param ?HttpResponseHeaders $headers A mapping of additional HTTP headers to send/receive for the individual batch request. * @param ?GetOffersHttpStatusLine $status The HTTP status line associated with the response. For more information, consult [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html). - * @param ?ListingOffersRequestParams $request */ public function __construct( public readonly GetOffersResponse $body, diff --git a/src/Seller/ProductPricingV0/Dto/LowestPriceType.php b/src/Seller/ProductPricingV0/Dto/LowestPriceType.php index 358b65420..927d12a41 100644 --- a/src/Seller/ProductPricingV0/Dto/LowestPriceType.php +++ b/src/Seller/ProductPricingV0/Dto/LowestPriceType.php @@ -24,12 +24,7 @@ final class LowestPriceType extends Dto /** * @param string $condition Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. * @param string $fulfillmentChannel Indicates whether the item is fulfilled by Amazon or by the seller. - * @param ?string $offerType * @param ?int $quantityTier Indicates at what quantity this price becomes active. - * @param ?string $quantityDiscountType - * @param ?MoneyType $landedPrice - * @param ?MoneyType $shipping - * @param ?Points $points */ public function __construct( public readonly string $condition, diff --git a/src/Seller/ProductPricingV0/Dto/OfferDetail.php b/src/Seller/ProductPricingV0/Dto/OfferDetail.php index 36a61867e..b40ae870c 100644 --- a/src/Seller/ProductPricingV0/Dto/OfferDetail.php +++ b/src/Seller/ProductPricingV0/Dto/OfferDetail.php @@ -38,12 +38,10 @@ final class OfferDetail extends Dto * @param DetailedShippingTimeType $shippingTime The time range in which an item will likely be shipped once an order has been placed. * @param bool $isFulfilledByAmazon When true, the offer is fulfilled by Amazon. * @param ?bool $myOffer When true, this is the seller's offer. - * @param ?string $offerType * @param ?string $sellerId The seller identifier for the offer. * @param ?string $conditionNotes Information about the condition of the item. * @param ?SellerFeedbackType $sellerFeedbackRating Information about the seller's feedback, including the percentage of positive feedback, and the total number of ratings received. * @param QuantityDiscountPriceType[]|null $quantityDiscountPrices - * @param ?Points $points * @param ?ShipsFromType $shipsFrom The state and country from where the item is shipped. * @param ?PrimeInformationType $primeInformation Amazon Prime information. * @param ?bool $isBuyBoxWinner When true, the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime. diff --git a/src/Seller/ProductPricingV0/Dto/OfferType.php b/src/Seller/ProductPricingV0/Dto/OfferType.php index 1d5ddb658..88d09a671 100644 --- a/src/Seller/ProductPricingV0/Dto/OfferType.php +++ b/src/Seller/ProductPricingV0/Dto/OfferType.php @@ -33,8 +33,6 @@ final class OfferType extends Dto * @param string $itemCondition The item condition for the offer listing. Possible values: New, Used, Collectible, Refurbished, or Club. * @param string $itemSubCondition The item subcondition for the offer listing. Possible values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. * @param string $sellerSku The seller stock keeping unit (SKU) of the item. - * @param ?string $offerType - * @param ?MoneyType $businessPrice * @param QuantityDiscountPriceType[]|null $quantityDiscountPrices */ public function __construct( diff --git a/src/Seller/ProductPricingV0/Dto/Points.php b/src/Seller/ProductPricingV0/Dto/Points.php index c7edc6bb1..d12bde346 100644 --- a/src/Seller/ProductPricingV0/Dto/Points.php +++ b/src/Seller/ProductPricingV0/Dto/Points.php @@ -21,7 +21,6 @@ final class Points extends Dto /** * @param ?int $pointsNumber The number of points. - * @param ?MoneyType $pointsMonetaryValue */ public function __construct( public readonly ?int $pointsNumber = null, diff --git a/src/Seller/ProductPricingV0/Dto/PriceType.php b/src/Seller/ProductPricingV0/Dto/PriceType.php index bff8d4b80..4dda202e5 100644 --- a/src/Seller/ProductPricingV0/Dto/PriceType.php +++ b/src/Seller/ProductPricingV0/Dto/PriceType.php @@ -21,11 +21,6 @@ final class PriceType extends Dto 'points' => 'Points', ]; - /** - * @param ?MoneyType $landedPrice - * @param ?MoneyType $shipping - * @param ?Points $points - */ public function __construct( public readonly MoneyType $listingPrice, public readonly ?MoneyType $landedPrice = null, diff --git a/src/Seller/ProductPricingV0/Dto/Summary.php b/src/Seller/ProductPricingV0/Dto/Summary.php index e70ca5104..27c5bab24 100644 --- a/src/Seller/ProductPricingV0/Dto/Summary.php +++ b/src/Seller/ProductPricingV0/Dto/Summary.php @@ -40,9 +40,6 @@ final class Summary extends Dto * @param OfferCountType[]|null $numberOfOffers * @param LowestPriceType[]|null $lowestPrices * @param BuyBoxPriceType[]|null $buyBoxPrices - * @param ?MoneyType $listPrice - * @param ?MoneyType $competitivePriceThreshold - * @param ?MoneyType $suggestedLowerPricePlusShipping * @param SalesRankType[]|null $salesRankings A list of sales rank information for the item, by category. * @param OfferCountType[]|null $buyBoxEligibleOffers * @param ?\DateTimeInterface $offersAvailableTime When the status is ActiveButTooSoonForProcessing, this is the time when the offers will be available for processing. diff --git a/src/Seller/ProductPricingV0/Responses/GetOffersResponse.php b/src/Seller/ProductPricingV0/Responses/GetOffersResponse.php index 7b137bdd7..a5c44f214 100644 --- a/src/Seller/ProductPricingV0/Responses/GetOffersResponse.php +++ b/src/Seller/ProductPricingV0/Responses/GetOffersResponse.php @@ -17,7 +17,6 @@ final class GetOffersResponse extends Response { /** - * @param ?GetOffersResult $payload * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ public function __construct( diff --git a/src/Seller/ProductPricingV20220501/Dto/FeaturedOfferExpectedPriceResponseBody.php b/src/Seller/ProductPricingV20220501/Dto/FeaturedOfferExpectedPriceResponseBody.php index b00c8c45f..82d99bd2b 100644 --- a/src/Seller/ProductPricingV20220501/Dto/FeaturedOfferExpectedPriceResponseBody.php +++ b/src/Seller/ProductPricingV20220501/Dto/FeaturedOfferExpectedPriceResponseBody.php @@ -19,12 +19,12 @@ final class FeaturedOfferExpectedPriceResponseBody extends Dto ]; /** - * @param OfferIdentifier $offerIdentifier Identifies an offer from a particular seller on an ASIN. + * @param ?OfferIdentifier $offerIdentifier Identifies an offer from a particular seller on an ASIN. * @param FeaturedOfferExpectedPriceResult[]|null $featuredOfferExpectedPriceResults A list of featured offer expected price results for the requested offer. * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ public function __construct( - public readonly OfferIdentifier $offerIdentifier, + public readonly ?OfferIdentifier $offerIdentifier = null, public readonly ?array $featuredOfferExpectedPriceResults = null, public readonly ?ErrorList $errors = null, ) {} diff --git a/src/Seller/ProductTypeDefinitionsV20200901/Responses/ProductTypeDefinition.php b/src/Seller/ProductTypeDefinitionsV20200901/Responses/ProductTypeDefinition.php index c6d63d704..1b72c7d79 100644 --- a/src/Seller/ProductTypeDefinitionsV20200901/Responses/ProductTypeDefinition.php +++ b/src/Seller/ProductTypeDefinitionsV20200901/Responses/ProductTypeDefinition.php @@ -28,7 +28,6 @@ final class ProductTypeDefinition extends Response * @param string $productType The name of the Amazon product type that this product type definition applies to. * @param string $displayName Human-readable and localized description of the Amazon product type. * @param ProductTypeVersion $productTypeVersion The version details for an Amazon product type. - * @param ?SchemaLink $metaSchema */ public function __construct( public readonly SchemaLink $schema, diff --git a/src/Seller/SellerConnector.php b/src/Seller/SellerConnector.php index 5ae557be9..1329a2abf 100644 --- a/src/Seller/SellerConnector.php +++ b/src/Seller/SellerConnector.php @@ -84,11 +84,21 @@ public function feedsV20210630(): FeedsV20210630\Api return new FeedsV20210630\Api($this); } + public function financesV20240619(): FinancesV20240619\Api + { + return new FinancesV20240619\Api($this); + } + public function financesV0(): FinancesV0\Api { return new FinancesV0\Api($this); } + public function invoicesV20240619(): InvoicesV20240619\Api + { + return new InvoicesV20240619\Api($this); + } + public function listingsItemsV20210801(): ListingsItemsV20210801\Api { return new ListingsItemsV20210801\Api($this); diff --git a/src/Seller/SellersV1/Api.php b/src/Seller/SellersV1/Api.php index 77f8e439e..8435ef772 100644 --- a/src/Seller/SellersV1/Api.php +++ b/src/Seller/SellersV1/Api.php @@ -4,13 +4,21 @@ use Saloon\Http\Response; use SellingPartnerApi\BaseResource; +use SellingPartnerApi\Seller\SellersV1\Requests\GetAccount; use SellingPartnerApi\Seller\SellersV1\Requests\GetMarketplaceParticipations; class Api extends BaseResource { public function getMarketplaceParticipations(): Response { - $request = new GetMarketplaceParticipations(); + $request = new GetMarketplaceParticipations; + + return $this->connector->send($request); + } + + public function getAccount(): Response + { + $request = new GetAccount; return $this->connector->send($request); } diff --git a/src/Seller/SellersV1/Dto/Account.php b/src/Seller/SellersV1/Dto/Account.php new file mode 100644 index 000000000..91954289c --- /dev/null +++ b/src/Seller/SellersV1/Dto/Account.php @@ -0,0 +1,31 @@ + MarketplaceLevelAttributes::class]; + + /** + * @param MarketplaceLevelAttributes[] $marketplaceLevelAttributes A list of details of the marketplaces where the seller account is active. + * @param string $businessType The type of business registered for the seller account. + * @param ?Business $business Information about the seller's business. Certain fields may be omitted depending on the seller's `businessType`. + * @param ?PrimaryContact $primaryContact Information about the seller's primary contact. + */ + public function __construct( + public readonly array $marketplaceLevelAttributes, + public readonly string $businessType, + public readonly ?Business $business = null, + public readonly ?PrimaryContact $primaryContact = null, + ) {} +} diff --git a/src/Seller/SellersV1/Dto/Address.php b/src/Seller/SellersV1/Dto/Address.php new file mode 100644 index 000000000..85d642137 --- /dev/null +++ b/src/Seller/SellersV1/Dto/Address.php @@ -0,0 +1,33 @@ +status(); + $responseCls = match ($status) { + 200, 400, 403, 404, 413, 415, 429, 500, 503 => GetAccountResponse::class, + default => throw new Exception("Unhandled response status: {$status}") + }; + + return $responseCls::deserialize($response->json()); + } +} diff --git a/src/Seller/SellersV1/Responses/GetAccountResponse.php b/src/Seller/SellersV1/Responses/GetAccountResponse.php new file mode 100644 index 000000000..2666900d9 --- /dev/null +++ b/src/Seller/SellersV1/Responses/GetAccountResponse.php @@ -0,0 +1,27 @@ +connector->send($request); } diff --git a/src/Seller/ShippingV2/Dto/AccessPoint.php b/src/Seller/ShippingV2/Dto/AccessPoint.php index 3b942fcb4..30bf8b6f6 100644 --- a/src/Seller/ShippingV2/Dto/AccessPoint.php +++ b/src/Seller/ShippingV2/Dto/AccessPoint.php @@ -27,7 +27,6 @@ final class AccessPoint extends Dto * @param ?AccessibilityAttributes $accessibilityAttributes Defines the accessibility details of the access point. * @param ?Address $address The address. * @param ExceptionOperatingHours[]|null $exceptionOperatingHours - * @param ?string $assistanceType * @param ?string $score The score of access point, based on proximity to postal code and sorting preference. This can be used to sort access point results on shipper's end. * @param ?OperatingHours[] $standardOperatingHours Map of day of the week to operating hours of that day */ diff --git a/src/Seller/ShippingV2/Dto/ExcludedBenefit.php b/src/Seller/ShippingV2/Dto/ExcludedBenefit.php index 44121a86a..84a31d9f9 100644 --- a/src/Seller/ShippingV2/Dto/ExcludedBenefit.php +++ b/src/Seller/ShippingV2/Dto/ExcludedBenefit.php @@ -14,8 +14,11 @@ final class ExcludedBenefit extends Dto { + /** + * @param string[] $reasonCodes List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer. + */ public function __construct( public readonly string $benefit, - public readonly string $reasonCode, + public readonly array $reasonCodes, ) {} } diff --git a/src/Seller/ShippingV2/Dto/GetRatesRequest.php b/src/Seller/ShippingV2/Dto/GetRatesRequest.php index 7987d71a9..96ee7fa5a 100644 --- a/src/Seller/ShippingV2/Dto/GetRatesRequest.php +++ b/src/Seller/ShippingV2/Dto/GetRatesRequest.php @@ -32,7 +32,6 @@ final class GetRatesRequest extends Dto * @param TaxDetail[]|null $taxDetails A list of tax detail information. * @param ClientReferenceDetail[]|null $clientReferenceDetails Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail * @param ?string $shipmentType Shipment type. - * @param ?AccessPointDetails $destinationAccessPointDetails */ public function __construct( public readonly Address $shipFrom, diff --git a/src/Seller/ShippingV2/Dto/GetShipmentDocumentsResult.php b/src/Seller/ShippingV2/Dto/GetShipmentDocumentsResult.php index ad85a90ac..4590d7b94 100644 --- a/src/Seller/ShippingV2/Dto/GetShipmentDocumentsResult.php +++ b/src/Seller/ShippingV2/Dto/GetShipmentDocumentsResult.php @@ -17,9 +17,11 @@ final class GetShipmentDocumentsResult extends Dto /** * @param string $shipmentId The unique shipment identifier provided by a shipping service. * @param PackageDocumentDetail $packageDocumentDetail The post-purchase details of a package that will be shipped using a shipping service. + * @param ?Benefits $benefits Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC. */ public function __construct( public readonly string $shipmentId, public readonly PackageDocumentDetail $packageDocumentDetail, + public readonly ?Benefits $benefits = null, ) {} } diff --git a/src/Seller/ShippingV2/Dto/OneClickShipmentRequest.php b/src/Seller/ShippingV2/Dto/OneClickShipmentRequest.php index 8107ebc33..56172706d 100644 --- a/src/Seller/ShippingV2/Dto/OneClickShipmentRequest.php +++ b/src/Seller/ShippingV2/Dto/OneClickShipmentRequest.php @@ -32,7 +32,6 @@ final class OneClickShipmentRequest extends Dto * @param OneClickShipmentValueAddedService[]|null $valueAddedServicesDetails The value-added services to be added to a shipping service purchase. * @param TaxDetail[]|null $taxDetails A list of tax detail information. * @param ?ShipperInstruction $shipperInstruction The shipper instruction. - * @param ?AccessPointDetails $destinationAccessPointDetails */ public function __construct( public readonly Address $shipFrom, diff --git a/src/Seller/ShippingV2/Dto/PurchaseShipmentResult.php b/src/Seller/ShippingV2/Dto/PurchaseShipmentResult.php index c3f54082e..f8acaa41c 100644 --- a/src/Seller/ShippingV2/Dto/PurchaseShipmentResult.php +++ b/src/Seller/ShippingV2/Dto/PurchaseShipmentResult.php @@ -20,10 +20,12 @@ final class PurchaseShipmentResult extends Dto * @param string $shipmentId The unique shipment identifier provided by a shipping service. * @param PackageDocumentDetail[] $packageDocumentDetails A list of post-purchase details about a package that will be shipped using a shipping service. * @param Promise $promise The time windows promised for pickup and delivery events. + * @param ?Benefits $benefits Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC. */ public function __construct( public readonly string $shipmentId, public readonly array $packageDocumentDetails, public readonly Promise $promise, + public readonly ?Benefits $benefits = null, ) {} } diff --git a/src/Seller/ShippingV2/Dto/Rate.php b/src/Seller/ShippingV2/Dto/Rate.php index 1ca423f19..b10772125 100644 --- a/src/Seller/ShippingV2/Dto/Rate.php +++ b/src/Seller/ShippingV2/Dto/Rate.php @@ -34,7 +34,7 @@ final class Rate extends Dto * @param AvailableValueAddedServiceGroup[]|null $availableValueAddedServiceGroups A list of value-added services available for a shipping service offering. * @param RateItem[]|null $rateItemList A list of RateItem * @param ?string $paymentType Payment type of the purchase. - * @param ?Benefits $benefits Representing the included/excluded benefits that we offer for each ShippingOffering/Rate. Benefits being services provided by Amazon when sellers purchase shipping through Amazon. + * @param ?Benefits $benefits Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC. */ public function __construct( public readonly string $rateId, diff --git a/src/Seller/ShippingV2/Dto/TimeOfDay.php b/src/Seller/ShippingV2/Dto/TimeOfDay.php index 0e4226a55..1390e841a 100644 --- a/src/Seller/ShippingV2/Dto/TimeOfDay.php +++ b/src/Seller/ShippingV2/Dto/TimeOfDay.php @@ -14,11 +14,6 @@ final class TimeOfDay extends Dto { - /** - * @param ?int $hourOfDay - * @param ?int $minuteOfHour - * @param ?int $secondOfMinute - */ public function __construct( public readonly ?int $hourOfDay = null, public readonly ?int $minuteOfHour = null, diff --git a/src/Seller/SolicitationsV1/Dto/Embedded2.php b/src/Seller/SolicitationsV1/Dto/Embedded2.php index 2dab24ac2..e5602953e 100644 --- a/src/Seller/SolicitationsV1/Dto/Embedded2.php +++ b/src/Seller/SolicitationsV1/Dto/Embedded2.php @@ -14,9 +14,6 @@ final class Embedded2 extends Dto { - /** - * @param ?GetSchemaResponse $schema - */ public function __construct( public readonly ?GetSchemaResponse $schema = null, ) {} diff --git a/src/Seller/SolicitationsV1/Dto/GetSchemaResponse.php b/src/Seller/SolicitationsV1/Dto/GetSchemaResponse.php index 1a312bb8f..3289db1f3 100644 --- a/src/Seller/SolicitationsV1/Dto/GetSchemaResponse.php +++ b/src/Seller/SolicitationsV1/Dto/GetSchemaResponse.php @@ -17,7 +17,6 @@ final class GetSchemaResponse extends Dto protected static array $attributeMap = ['links' => '_links']; /** - * @param ?Links3 $links * @param ?array[] $payload A JSON schema document describing the expected payload of the action. This object can be validated against http://json-schema.org/draft-04/schema. * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ diff --git a/src/Seller/SolicitationsV1/Dto/GetSolicitationActionResponse.php b/src/Seller/SolicitationsV1/Dto/GetSolicitationActionResponse.php index e4f3885c2..0756c1bc5 100644 --- a/src/Seller/SolicitationsV1/Dto/GetSolicitationActionResponse.php +++ b/src/Seller/SolicitationsV1/Dto/GetSolicitationActionResponse.php @@ -17,8 +17,6 @@ final class GetSolicitationActionResponse extends Dto protected static array $attributeMap = ['links' => '_links', 'embedded' => '_embedded']; /** - * @param ?Links2 $links - * @param ?Embedded2 $embedded * @param ?SolicitationsAction $payload A simple object containing the name of the template. * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ diff --git a/src/Seller/SolicitationsV1/Responses/GetSolicitationActionsForOrderResponse.php b/src/Seller/SolicitationsV1/Responses/GetSolicitationActionsForOrderResponse.php index cd9e97da4..6edfd4528 100644 --- a/src/Seller/SolicitationsV1/Responses/GetSolicitationActionsForOrderResponse.php +++ b/src/Seller/SolicitationsV1/Responses/GetSolicitationActionsForOrderResponse.php @@ -20,8 +20,6 @@ final class GetSolicitationActionsForOrderResponse extends Response protected static array $attributeMap = ['links' => '_links', 'embedded' => '_embedded']; /** - * @param ?Links $links - * @param ?Embedded $embedded * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ public function __construct( diff --git a/src/Seller/SupplySourcesV20200701/Dto/ContactDetails.php b/src/Seller/SupplySourcesV20200701/Dto/ContactDetails.php index 043645d42..3f2bcb488 100644 --- a/src/Seller/SupplySourcesV20200701/Dto/ContactDetails.php +++ b/src/Seller/SupplySourcesV20200701/Dto/ContactDetails.php @@ -14,9 +14,6 @@ final class ContactDetails extends Dto { - /** - * @param ?Primary $primary - */ public function __construct( public readonly ?Primary $primary = null, ) {} diff --git a/src/Seller/SupplySourcesV20200701/Dto/DeliveryChannel.php b/src/Seller/SupplySourcesV20200701/Dto/DeliveryChannel.php index df3530916..74b2bd93f 100644 --- a/src/Seller/SupplySourcesV20200701/Dto/DeliveryChannel.php +++ b/src/Seller/SupplySourcesV20200701/Dto/DeliveryChannel.php @@ -15,7 +15,6 @@ final class DeliveryChannel extends Dto { /** - * @param ?bool $isSupported * @param ?OperationalConfiguration $operationalConfiguration The operational configuration of `supplySources`. */ public function __construct( diff --git a/src/Seller/SupplySourcesV20200701/Dto/OutboundCapability.php b/src/Seller/SupplySourcesV20200701/Dto/OutboundCapability.php index 3da2d5588..35a5c06f1 100644 --- a/src/Seller/SupplySourcesV20200701/Dto/OutboundCapability.php +++ b/src/Seller/SupplySourcesV20200701/Dto/OutboundCapability.php @@ -15,7 +15,6 @@ final class OutboundCapability extends Dto { /** - * @param ?bool $isSupported * @param ?OperationalConfiguration $operationalConfiguration The operational configuration of `supplySources`. * @param ?ReturnLocation $returnLocation The address or reference to another `supplySourceId` to act as a return location. * @param ?DeliveryChannel $deliveryChannel The delivery channel of a supply source. diff --git a/src/Seller/SupplySourcesV20200701/Dto/PickupChannel.php b/src/Seller/SupplySourcesV20200701/Dto/PickupChannel.php index 1ca85e0f8..ba4b4b04b 100644 --- a/src/Seller/SupplySourcesV20200701/Dto/PickupChannel.php +++ b/src/Seller/SupplySourcesV20200701/Dto/PickupChannel.php @@ -16,7 +16,6 @@ final class PickupChannel extends Dto { /** * @param ?Duration $inventoryHoldPeriod The duration of time. - * @param ?bool $isSupported * @param ?OperationalConfiguration $operationalConfiguration The operational configuration of `supplySources`. * @param ?InStorePickupConfiguration $inStorePickupConfiguration The in-store pickup configuration of a supply source. * @param ?CurbsidePickupConfiguration $curbsidePickupConfiguration The curbside pickup configuration of a supply source. diff --git a/src/Seller/SupplySourcesV20200701/Responses/GetSupplySourcesResponse.php b/src/Seller/SupplySourcesV20200701/Responses/GetSupplySourcesResponse.php index 468a3101f..c06493dbb 100644 --- a/src/Seller/SupplySourcesV20200701/Responses/GetSupplySourcesResponse.php +++ b/src/Seller/SupplySourcesV20200701/Responses/GetSupplySourcesResponse.php @@ -16,7 +16,6 @@ final class GetSupplySourcesResponse extends Response { /** - * @param ?SupplySourceList $supplySources * @param ?string $nextPageToken If present, use this pagination token to retrieve the next page of supply sources. */ public function __construct( diff --git a/src/SellingPartnerApi.php b/src/SellingPartnerApi.php index 3a888be30..b16930552 100644 --- a/src/SellingPartnerApi.php +++ b/src/SellingPartnerApi.php @@ -231,7 +231,7 @@ function (PendingRequest $pendingRequest, RequestInterface $psrRequest) use ($ou VarDumper::setHandler(function ($var) use ($outputPath, $label) { $file = fopen($outputPath, 'a'); - $cloner = new VarCloner(); + $cloner = new VarCloner; $dumper = new CliDumper($file); $cloned = $cloner->cloneVar($var) ->withContext(['label' => 'Saloon Request('.$label.') ->']); @@ -272,7 +272,7 @@ function (Response $response, ResponseInterface $psrResponse) use ($outputPath) VarDumper::setHandler(function ($var) use ($outputPath, $label) { $file = fopen($outputPath, 'a'); - $cloner = new VarCloner(); + $cloner = new VarCloner; $dumper = new CliDumper($file); $cloned = $cloner->cloneVar($var) ->withContext(['label' => 'Saloon Response('.$label.') ->']); diff --git a/src/Traits/DownloadsDocument.php b/src/Traits/DownloadsDocument.php index 6ffda0e5f..697daa374 100644 --- a/src/Traits/DownloadsDocument.php +++ b/src/Traits/DownloadsDocument.php @@ -38,7 +38,7 @@ public function download( ); } - $client = new Client(); + $client = new Client; if ($documentType) { $this->documentTypeInfo = static::documentTypeInfo($documentType); @@ -91,7 +91,7 @@ public function download( */ public function downloadStream(): StreamInterface { - $client = new Client(); + $client = new Client; try { $response = $client->request('GET', $this->url, ['stream' => true]); } catch (ClientException $e) { @@ -137,9 +137,9 @@ protected function parseSpreadsheet(string $contents): array fclose($tempFile); $options = match ($this->documentTypeInfo['contentType']) { - ContentType::CSV => new Options(), - ContentType::TAB => new Options(), - ContentType::XLSX => new XLSXOptions(), + ContentType::CSV => new Options, + ContentType::TAB => new Options, + ContentType::XLSX => new XLSXOptions, }; if ($this->documentTypeInfo['contentType'] === ContentType::TAB) { $options->FIELD_DELIMITER = "\t"; diff --git a/src/Traits/UploadsDocument.php b/src/Traits/UploadsDocument.php index c2413a252..6bb809c52 100644 --- a/src/Traits/UploadsDocument.php +++ b/src/Traits/UploadsDocument.php @@ -17,7 +17,7 @@ public function upload( string|StreamInterface|callable|Iterator $data, ?string $charset = null ): void { - $client = new Client(); + $client = new Client; $response = $client->put($this->url, [ RequestOptions::HEADERS => [ 'Content-Type' => static::getContentType($feedType, $charset), diff --git a/src/Vendor/OrdersV1/Api.php b/src/Vendor/OrdersV1/Api.php index 2c6b45e3b..2accef3a7 100644 --- a/src/Vendor/OrdersV1/Api.php +++ b/src/Vendor/OrdersV1/Api.php @@ -14,15 +14,15 @@ class Api extends BaseResource { /** * @param ?int $limit The limit to the number of records returned. Default value is 100 records. - * @param ?\DateTimeInterface $createdAfter Purchase orders that became available after this time will be included in the result. Must be in ISO 8601 date/time format. - * @param ?\DateTimeInterface $createdBefore Purchase orders that became available before this time will be included in the result. Must be in ISO 8601 date/time format. + * @param ?\DateTimeInterface $createdAfter Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format. + * @param ?\DateTimeInterface $createdBefore Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format. * @param ?string $sortOrder Sort in ascending or descending order by purchase order creation date. * @param ?string $nextToken Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call - * @param ?string $includeDetails When `true`, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is `true`. - * @param ?\DateTimeInterface $changedAfter Purchase orders that changed after this timestamp will be included in the result. Must be in ISO 8601 date/time format. - * @param ?\DateTimeInterface $changedBefore Purchase orders that changed before this timestamp will be included in the result. Must be in ISO 8601 date/time format. - * @param ?string $poItemState Current state of the purchase order item. If this value is `Cancelled`, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. - * @param ?string $isPoChanged When `true`, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is `false`. + * @param ?string $includeDetails When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. + * @param ?\DateTimeInterface $changedAfter Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param ?\DateTimeInterface $changedBefore Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param ?string $poItemState Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. + * @param ?string $isPoChanged When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. * @param ?string $purchaseOrderState Filters purchase orders based on the purchase order state. * @param ?string $orderingVendorCode Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned. */ @@ -56,7 +56,7 @@ public function getPurchaseOrder(string $purchaseOrderNumber): Response } /** - * @param SubmitAcknowledgementRequest $submitAcknowledgementRequest The request schema for the `submitAcknowledgment` operation. + * @param SubmitAcknowledgementRequest $submitAcknowledgementRequest The request schema for the submitAcknowledgment operation. */ public function submitAcknowledgement(SubmitAcknowledgementRequest $submitAcknowledgementRequest): Response { @@ -69,10 +69,10 @@ public function submitAcknowledgement(SubmitAcknowledgementRequest $submitAcknow * @param ?int $limit The limit to the number of records returned. Default value is 100 records. * @param ?string $sortOrder Sort in ascending or descending order by purchase order creation date. * @param ?string $nextToken Used for pagination when there are more purchase orders than the specified result size limit. - * @param ?\DateTimeInterface $createdAfter Purchase orders that became available after this timestamp will be included in the result. Must be in ISO 8601 date/time format. - * @param ?\DateTimeInterface $createdBefore Purchase orders that became available before this timestamp will be included in the result. Must be in ISO 8601 date/time format. - * @param ?\DateTimeInterface $updatedAfter Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO 8601 date/time format. - * @param ?\DateTimeInterface $updatedBefore Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO 8601 date/time format. + * @param ?\DateTimeInterface $createdAfter Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param ?\DateTimeInterface $createdBefore Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param ?\DateTimeInterface $updatedAfter Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param ?\DateTimeInterface $updatedBefore Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param ?string $purchaseOrderNumber Provides purchase order status for the specified purchase order number. * @param ?string $purchaseOrderStatus Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses. * @param ?string $itemConfirmationStatus Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included. diff --git a/src/Vendor/OrdersV1/Dto/AcknowledgementStatusDetails.php b/src/Vendor/OrdersV1/Dto/AcknowledgementStatusDetails.php index cad70bc2e..68e1f7a67 100644 --- a/src/Vendor/OrdersV1/Dto/AcknowledgementStatusDetails.php +++ b/src/Vendor/OrdersV1/Dto/AcknowledgementStatusDetails.php @@ -15,7 +15,7 @@ final class AcknowledgementStatusDetails extends Dto { /** - * @param ?\DateTimeInterface $acknowledgementDate The date when the line item was confirmed by the vendor. Must be in ISO 8601 date/time format. + * @param ?\DateTimeInterface $acknowledgementDate The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format. * @param ?ItemQuantity $acceptedQuantity Details of quantity ordered. * @param ?ItemQuantity $rejectedQuantity Details of quantity ordered. */ diff --git a/src/Vendor/OrdersV1/Dto/Address.php b/src/Vendor/OrdersV1/Dto/Address.php index 4eab5b6d8..2e3350ac7 100644 --- a/src/Vendor/OrdersV1/Dto/Address.php +++ b/src/Vendor/OrdersV1/Dto/Address.php @@ -24,7 +24,7 @@ final class Address extends Dto * @param ?string $county The county where person, business or institution is located. * @param ?string $district The district where person, business or institution is located. * @param ?string $stateOrRegion The state or region where person, business or institution is located. - * @param ?string $postalCode The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. + * @param ?string $postalCode The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation. * @param ?string $phone The phone number of the person, business or institution located at that address. */ public function __construct( diff --git a/src/Vendor/OrdersV1/Dto/ImportDetails.php b/src/Vendor/OrdersV1/Dto/ImportDetails.php index bd53e02d0..46c5e43cf 100644 --- a/src/Vendor/OrdersV1/Dto/ImportDetails.php +++ b/src/Vendor/OrdersV1/Dto/ImportDetails.php @@ -17,8 +17,8 @@ final class ImportDetails extends Dto /** * @param ?string $methodOfPayment If the recipient requests, contains the shipment method of payment. This is for import PO's only. * @param ?string $internationalCommercialTerms Incoterms (International Commercial Terms) are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices. This is for import purchase orders only. - * @param ?string $portOfDelivery The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the `internationalCommercialTerms` is `FOB`. - * @param ?string $importContainers Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: `$NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE`. The list of values for the container type is: `40'`(40-foot container), `40'HC` (40-foot high-capacity container), `45'`, `45'HC`, `30'`, `30'HC`, `20'`, `20'HC`. + * @param ?string $portOfDelivery The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the internationalCommercialTerms is FOB. + * @param ?string $importContainers Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: $NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE. The list of values for the container type is: 40'(40-foot container), 40'HC (40-foot high-capacity container), 45', 45'HC, 30', 30'HC, 20', 20'HC. * @param ?string $shippingInstructions Special instructions regarding the shipment. This field is for import purchase orders. */ public function __construct( diff --git a/src/Vendor/OrdersV1/Dto/Money.php b/src/Vendor/OrdersV1/Dto/Money.php index f957879a5..060c081d5 100644 --- a/src/Vendor/OrdersV1/Dto/Money.php +++ b/src/Vendor/OrdersV1/Dto/Money.php @@ -17,9 +17,11 @@ final class Money extends Dto /** * @param ?string $currencyCode Three digit currency code in ISO 4217 format. String of length 3. * @param ?string $amount A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\d*))(\.\d+)?([eE][+-]?\d+)?$`. + * @param ?string $unitOfMeasure The unit of measure for prices of items sold by weight. If this field is absent, the item is sold by eaches. */ public function __construct( public readonly ?string $currencyCode = null, public readonly ?string $amount = null, + public readonly ?string $unitOfMeasure = null, ) {} } diff --git a/src/Vendor/OrdersV1/Dto/OrderAcknowledgement.php b/src/Vendor/OrdersV1/Dto/OrderAcknowledgement.php index 53d1f5b84..b1ffc3b61 100644 --- a/src/Vendor/OrdersV1/Dto/OrderAcknowledgement.php +++ b/src/Vendor/OrdersV1/Dto/OrderAcknowledgement.php @@ -18,8 +18,7 @@ final class OrderAcknowledgement extends Dto /** * @param string $purchaseOrderNumber The purchase order number. Formatting Notes: 8-character alpha-numeric code. - * @param PartyIdentification $sellingParty Name, address and tax details of a party. - * @param \DateTimeInterface $acknowledgementDate The date and time when the purchase order is acknowledged, in ISO 8601 date/time format. + * @param \DateTimeInterface $acknowledgementDate The date and time when the purchase order is acknowledged, in ISO-8601 date/time format. * @param OrderAcknowledgementItem[] $items A list of the items being acknowledged with associated details. */ public function __construct( diff --git a/src/Vendor/OrdersV1/Dto/OrderAcknowledgementItem.php b/src/Vendor/OrdersV1/Dto/OrderAcknowledgementItem.php index 318be8b13..69096c5f3 100644 --- a/src/Vendor/OrdersV1/Dto/OrderAcknowledgementItem.php +++ b/src/Vendor/OrdersV1/Dto/OrderAcknowledgementItem.php @@ -22,8 +22,8 @@ final class OrderAcknowledgementItem extends Dto * @param ?string $itemSequenceNumber Line item sequence number for the item. * @param ?string $amazonProductIdentifier Amazon Standard Identification Number (ASIN) of an item. * @param ?string $vendorProductIdentifier The vendor selected product identification of the item. Should be the same as was sent in the purchase order. - * @param ?Money $netCost An amount of money, including units in the form of currency. - * @param ?Money $listPrice An amount of money, including units in the form of currency. + * @param ?Money $netCost An amount of money. Includes the currency code and an optional unit of measure for items priced by weight. + * @param ?Money $listPrice An amount of money. Includes the currency code and an optional unit of measure for items priced by weight. * @param ?string $discountMultiplier The discount multiplier that should be applied to the price if a vendor sells books with a list price. This is a multiplier factor to arrive at a final discounted price. A multiplier of .90 would be the factor if a 10% discount is given. */ public function __construct( diff --git a/src/Vendor/OrdersV1/Dto/OrderDetails.php b/src/Vendor/OrdersV1/Dto/OrderDetails.php index 570bb54b6..443c30cae 100644 --- a/src/Vendor/OrdersV1/Dto/OrderDetails.php +++ b/src/Vendor/OrdersV1/Dto/OrderDetails.php @@ -17,20 +17,16 @@ final class OrderDetails extends Dto protected static array $complexArrayTypes = ['items' => OrderItem::class]; /** - * @param \DateTimeInterface $purchaseOrderDate The date the purchase order was placed. Must be in ISO 8601 date/time format. - * @param \DateTimeInterface $purchaseOrderStateChangedDate The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'. Must be in ISO 8601 date/time format. + * @param \DateTimeInterface $purchaseOrderDate The date the purchase order was placed. Must be in ISO-8601 date/time format. + * @param \DateTimeInterface $purchaseOrderStateChangedDate The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'. Must be in ISO-8601 date/time format. * @param OrderItem[] $items A list of items in this purchase order. - * @param ?\DateTimeInterface $purchaseOrderChangedDate The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than 'purchaseOrderDate'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO 8601 date/time format. + * @param ?\DateTimeInterface $purchaseOrderChangedDate The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than 'purchaseOrderDate'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO-8601 date/time format. * @param ?string $purchaseOrderType Type of purchase order. * @param ?ImportDetails $importDetails Import details for an import order. * @param ?string $dealCode If requested by the recipient, this field will contain a promotional/deal number. The discount code line is optional. It is used to obtain a price discount on items on the order. * @param ?string $paymentMethod Payment method used. - * @param ?PartyIdentification $buyingParty Name, address and tax details of a party. - * @param ?PartyIdentification $sellingParty Name, address and tax details of a party. - * @param ?PartyIdentification $shipToParty Name, address and tax details of a party. - * @param ?PartyIdentification $billToParty Name, address and tax details of a party. - * @param ?string $shipWindow Defines a date time interval according to ISO 8601. Interval is separated by double hyphen (--). - * @param ?string $deliveryWindow Defines a date time interval according to ISO 8601. Interval is separated by double hyphen (--). + * @param ?string $shipWindow Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--). + * @param ?string $deliveryWindow Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--). */ public function __construct( public readonly \DateTimeInterface $purchaseOrderDate, diff --git a/src/Vendor/OrdersV1/Dto/OrderItem.php b/src/Vendor/OrdersV1/Dto/OrderItem.php index 0aee7c3cb..f1e497540 100644 --- a/src/Vendor/OrdersV1/Dto/OrderItem.php +++ b/src/Vendor/OrdersV1/Dto/OrderItem.php @@ -20,8 +20,8 @@ final class OrderItem extends Dto * @param bool $isBackOrderAllowed When true, we will accept backorder confirmations for this item. * @param ?string $amazonProductIdentifier Amazon Standard Identification Number (ASIN) of an item. * @param ?string $vendorProductIdentifier The vendor selected product identification of the item. - * @param ?Money $netCost An amount of money, including units in the form of currency. - * @param ?Money $listPrice An amount of money, including units in the form of currency. + * @param ?Money $netCost An amount of money. Includes the currency code and an optional unit of measure for items priced by weight. + * @param ?Money $listPrice An amount of money. Includes the currency code and an optional unit of measure for items priced by weight. */ public function __construct( public readonly string $itemSequenceNumber, diff --git a/src/Vendor/OrdersV1/Dto/OrderItemAcknowledgement.php b/src/Vendor/OrdersV1/Dto/OrderItemAcknowledgement.php index 1b7d79804..066b130bd 100644 --- a/src/Vendor/OrdersV1/Dto/OrderItemAcknowledgement.php +++ b/src/Vendor/OrdersV1/Dto/OrderItemAcknowledgement.php @@ -17,8 +17,8 @@ final class OrderItemAcknowledgement extends Dto /** * @param string $acknowledgementCode This indicates the acknowledgement code. * @param ItemQuantity $acknowledgedQuantity Details of quantity ordered. - * @param ?\DateTimeInterface $scheduledShipDate Estimated ship date per line item. Must be in ISO 8601 date/time format. - * @param ?\DateTimeInterface $scheduledDeliveryDate Estimated delivery date per line item. Must be in ISO 8601 date/time format. + * @param ?\DateTimeInterface $scheduledShipDate Estimated ship date per line item. Must be in ISO-8601 date/time format. + * @param ?\DateTimeInterface $scheduledDeliveryDate Estimated delivery date per line item. Must be in ISO-8601 date/time format. * @param ?string $rejectionReason Indicates the reason for rejection. */ public function __construct( diff --git a/src/Vendor/OrdersV1/Dto/OrderItemStatus.php b/src/Vendor/OrdersV1/Dto/OrderItemStatus.php index afdae9241..b01029d28 100644 --- a/src/Vendor/OrdersV1/Dto/OrderItemStatus.php +++ b/src/Vendor/OrdersV1/Dto/OrderItemStatus.php @@ -18,8 +18,8 @@ final class OrderItemStatus extends Dto * @param string $itemSequenceNumber Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on. * @param ?string $buyerProductIdentifier Buyer's Standard Identification Number (ASIN) of an item. * @param ?string $vendorProductIdentifier The vendor selected product identification of the item. - * @param ?Money $netCost An amount of money, including units in the form of currency. - * @param ?Money $listPrice An amount of money, including units in the form of currency. + * @param ?Money $netCost An amount of money. Includes the currency code and an optional unit of measure for items priced by weight. + * @param ?Money $listPrice An amount of money. Includes the currency code and an optional unit of measure for items priced by weight. * @param ?OrderedQuantity $orderedQuantity Ordered quantity information. * @param ?AcknowledgementStatus $acknowledgementStatus Acknowledgement status information. * @param ?ReceivingStatus $receivingStatus Item receive status at the buyer's warehouse. diff --git a/src/Vendor/OrdersV1/Dto/OrderList.php b/src/Vendor/OrdersV1/Dto/OrderList.php index 45bec84ec..e8d11cf4f 100644 --- a/src/Vendor/OrdersV1/Dto/OrderList.php +++ b/src/Vendor/OrdersV1/Dto/OrderList.php @@ -17,8 +17,7 @@ final class OrderList extends Dto protected static array $complexArrayTypes = ['orders' => Order::class]; /** - * @param ?Pagination $pagination The pagination elements required to retrieve the remaining data. - * @param Order[]|null $orders Represents an individual order within the `OrderList`. + * @param Order[]|null $orders */ public function __construct( public readonly ?Pagination $pagination = null, diff --git a/src/Vendor/OrdersV1/Dto/OrderListStatus.php b/src/Vendor/OrdersV1/Dto/OrderListStatus.php index b57742806..a865b28bd 100644 --- a/src/Vendor/OrdersV1/Dto/OrderListStatus.php +++ b/src/Vendor/OrdersV1/Dto/OrderListStatus.php @@ -17,8 +17,7 @@ final class OrderListStatus extends Dto protected static array $complexArrayTypes = ['ordersStatus' => OrderStatus::class]; /** - * @param ?Pagination $pagination The pagination elements required to retrieve the remaining data. - * @param OrderStatus[]|null $ordersStatus Represents an order status within the `OrderListStatus`. + * @param OrderStatus[]|null $ordersStatus */ public function __construct( public readonly ?Pagination $pagination = null, diff --git a/src/Vendor/OrdersV1/Dto/OrderStatus.php b/src/Vendor/OrdersV1/Dto/OrderStatus.php index edebe719d..4569fb2c7 100644 --- a/src/Vendor/OrdersV1/Dto/OrderStatus.php +++ b/src/Vendor/OrdersV1/Dto/OrderStatus.php @@ -19,11 +19,9 @@ final class OrderStatus extends Dto /** * @param string $purchaseOrderNumber The buyer's purchase order number for this order. Formatting Notes: 8-character alpha-numeric code. * @param string $purchaseOrderStatus The status of the buyer's purchase order for this order. - * @param \DateTimeInterface $purchaseOrderDate The date the purchase order was placed. Must be in ISO 8601 date/time format. - * @param PartyIdentification $sellingParty Name, address and tax details of a party. - * @param PartyIdentification $shipToParty Name, address and tax details of a party. + * @param \DateTimeInterface $purchaseOrderDate The date the purchase order was placed. Must be in ISO-8601 date/time format. * @param OrderItemStatus[] $itemStatus Detailed description of items order status. - * @param ?\DateTimeInterface $lastUpdatedDate The date when the purchase order was last updated. Must be in ISO 8601 date/time format. + * @param ?\DateTimeInterface $lastUpdatedDate The date when the purchase order was last updated. Must be in ISO-8601 date/time format. */ public function __construct( public readonly string $purchaseOrderNumber, diff --git a/src/Vendor/OrdersV1/Dto/OrderedQuantityDetails.php b/src/Vendor/OrdersV1/Dto/OrderedQuantityDetails.php index d6e745496..81123ff9a 100644 --- a/src/Vendor/OrdersV1/Dto/OrderedQuantityDetails.php +++ b/src/Vendor/OrdersV1/Dto/OrderedQuantityDetails.php @@ -15,7 +15,7 @@ final class OrderedQuantityDetails extends Dto { /** - * @param ?\DateTimeInterface $updatedDate The date when the line item quantity was updated by the buyer. Must be in ISO 8601 date/time format. + * @param ?\DateTimeInterface $updatedDate The date when the line item quantity was updated by buyer. Must be in ISO-8601 date/time format. * @param ?ItemQuantity $orderedQuantity Details of quantity ordered. * @param ?ItemQuantity $cancelledQuantity Details of quantity ordered. */ diff --git a/src/Vendor/OrdersV1/Dto/Pagination.php b/src/Vendor/OrdersV1/Dto/Pagination.php index c8812c525..3bb88cace 100644 --- a/src/Vendor/OrdersV1/Dto/Pagination.php +++ b/src/Vendor/OrdersV1/Dto/Pagination.php @@ -15,7 +15,7 @@ final class Pagination extends Dto { /** - * @param ?string $nextToken A generated string used to pass information to your next request. If `NextToken` is returned, pass the value of `NextToken` to the next request. If `NextToken` is not returned, there are no more purchase order items to return. + * @param ?string $nextToken A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more purchase order items to return. */ public function __construct( public readonly ?string $nextToken = null, diff --git a/src/Vendor/OrdersV1/Dto/ReceivingStatus.php b/src/Vendor/OrdersV1/Dto/ReceivingStatus.php index a1c109a92..a77b6cfd7 100644 --- a/src/Vendor/OrdersV1/Dto/ReceivingStatus.php +++ b/src/Vendor/OrdersV1/Dto/ReceivingStatus.php @@ -17,7 +17,7 @@ final class ReceivingStatus extends Dto /** * @param ?string $receiveStatus Receive status of the line item. * @param ?ItemQuantity $receivedQuantity Details of quantity ordered. - * @param ?\DateTimeInterface $lastReceiveDate The date when the most recent item was received at the buyer's warehouse. Must be in ISO 8601 date/time format. + * @param ?\DateTimeInterface $lastReceiveDate The date when the most recent item was received at the buyer's warehouse. Must be in ISO-8601 date/time format. */ public function __construct( public readonly ?string $receiveStatus = null, diff --git a/src/Vendor/OrdersV1/Dto/SubmitAcknowledgementRequest.php b/src/Vendor/OrdersV1/Dto/SubmitAcknowledgementRequest.php index 6888882b9..0e368a694 100644 --- a/src/Vendor/OrdersV1/Dto/SubmitAcknowledgementRequest.php +++ b/src/Vendor/OrdersV1/Dto/SubmitAcknowledgementRequest.php @@ -17,7 +17,7 @@ final class SubmitAcknowledgementRequest extends Dto protected static array $complexArrayTypes = ['acknowledgements' => OrderAcknowledgement::class]; /** - * @param OrderAcknowledgement[]|null $acknowledgements An array of order acknowledgements to be submitted. + * @param OrderAcknowledgement[]|null $acknowledgements */ public function __construct( public readonly ?array $acknowledgements = null, diff --git a/src/Vendor/OrdersV1/Dto/TaxRegistrationDetails.php b/src/Vendor/OrdersV1/Dto/TaxRegistrationDetails.php index d6e451122..b4151d667 100644 --- a/src/Vendor/OrdersV1/Dto/TaxRegistrationDetails.php +++ b/src/Vendor/OrdersV1/Dto/TaxRegistrationDetails.php @@ -16,7 +16,7 @@ final class TaxRegistrationDetails extends Dto { /** * @param string $taxRegistrationType Tax registration type for the entity. - * @param string $taxRegistrationNumber Tax registration number for the entity. For example, `VAT ID`. + * @param string $taxRegistrationNumber Tax registration number for the entity. For example, VAT ID. */ public function __construct( public readonly string $taxRegistrationType, diff --git a/src/Vendor/OrdersV1/Requests/GetPurchaseOrders.php b/src/Vendor/OrdersV1/Requests/GetPurchaseOrders.php index 78b52a151..434efb75c 100644 --- a/src/Vendor/OrdersV1/Requests/GetPurchaseOrders.php +++ b/src/Vendor/OrdersV1/Requests/GetPurchaseOrders.php @@ -25,15 +25,15 @@ class GetPurchaseOrders extends Request /** * @param ?int $limit The limit to the number of records returned. Default value is 100 records. - * @param ?\DateTimeInterface $createdAfter Purchase orders that became available after this time will be included in the result. Must be in ISO 8601 date/time format. - * @param ?\DateTimeInterface $createdBefore Purchase orders that became available before this time will be included in the result. Must be in ISO 8601 date/time format. + * @param ?\DateTimeInterface $createdAfter Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format. + * @param ?\DateTimeInterface $createdBefore Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format. * @param ?string $sortOrder Sort in ascending or descending order by purchase order creation date. * @param ?string $nextToken Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call - * @param ?string $includeDetails When `true`, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is `true`. - * @param ?\DateTimeInterface $changedAfter Purchase orders that changed after this timestamp will be included in the result. Must be in ISO 8601 date/time format. - * @param ?\DateTimeInterface $changedBefore Purchase orders that changed before this timestamp will be included in the result. Must be in ISO 8601 date/time format. - * @param ?string $poItemState Current state of the purchase order item. If this value is `Cancelled`, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. - * @param ?string $isPoChanged When `true`, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is `false`. + * @param ?string $includeDetails When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. + * @param ?\DateTimeInterface $changedAfter Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param ?\DateTimeInterface $changedBefore Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param ?string $poItemState Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. + * @param ?string $isPoChanged When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. * @param ?string $purchaseOrderState Filters purchase orders based on the purchase order state. * @param ?string $orderingVendorCode Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned. */ diff --git a/src/Vendor/OrdersV1/Requests/GetPurchaseOrdersStatus.php b/src/Vendor/OrdersV1/Requests/GetPurchaseOrdersStatus.php index c9d9b741b..501f4c5d9 100644 --- a/src/Vendor/OrdersV1/Requests/GetPurchaseOrdersStatus.php +++ b/src/Vendor/OrdersV1/Requests/GetPurchaseOrdersStatus.php @@ -27,10 +27,10 @@ class GetPurchaseOrdersStatus extends Request * @param ?int $limit The limit to the number of records returned. Default value is 100 records. * @param ?string $sortOrder Sort in ascending or descending order by purchase order creation date. * @param ?string $nextToken Used for pagination when there are more purchase orders than the specified result size limit. - * @param ?\DateTimeInterface $createdAfter Purchase orders that became available after this timestamp will be included in the result. Must be in ISO 8601 date/time format. - * @param ?\DateTimeInterface $createdBefore Purchase orders that became available before this timestamp will be included in the result. Must be in ISO 8601 date/time format. - * @param ?\DateTimeInterface $updatedAfter Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO 8601 date/time format. - * @param ?\DateTimeInterface $updatedBefore Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO 8601 date/time format. + * @param ?\DateTimeInterface $createdAfter Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param ?\DateTimeInterface $createdBefore Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param ?\DateTimeInterface $updatedAfter Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. + * @param ?\DateTimeInterface $updatedBefore Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param ?string $purchaseOrderNumber Provides purchase order status for the specified purchase order number. * @param ?string $purchaseOrderStatus Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses. * @param ?string $itemConfirmationStatus Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included. diff --git a/src/Vendor/OrdersV1/Requests/SubmitAcknowledgement.php b/src/Vendor/OrdersV1/Requests/SubmitAcknowledgement.php index 3f69dc415..5e19b649d 100644 --- a/src/Vendor/OrdersV1/Requests/SubmitAcknowledgement.php +++ b/src/Vendor/OrdersV1/Requests/SubmitAcknowledgement.php @@ -29,7 +29,7 @@ class SubmitAcknowledgement extends Request implements HasBody protected Method $method = Method::POST; /** - * @param SubmitAcknowledgementRequest $submitAcknowledgementRequest The request schema for the `submitAcknowledgment` operation. + * @param SubmitAcknowledgementRequest $submitAcknowledgementRequest The request schema for the submitAcknowledgment operation. */ public function __construct( public SubmitAcknowledgementRequest $submitAcknowledgementRequest, diff --git a/src/Vendor/OrdersV1/Responses/GetPurchaseOrderResponse.php b/src/Vendor/OrdersV1/Responses/GetPurchaseOrderResponse.php index 5898138cd..196f37614 100644 --- a/src/Vendor/OrdersV1/Responses/GetPurchaseOrderResponse.php +++ b/src/Vendor/OrdersV1/Responses/GetPurchaseOrderResponse.php @@ -17,7 +17,6 @@ final class GetPurchaseOrderResponse extends Response { /** - * @param ?Order $payload Represents an order placed by Amazon, including the purchase order number, current state, and order details. * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ public function __construct( diff --git a/src/Vendor/OrdersV1/Responses/GetPurchaseOrdersResponse.php b/src/Vendor/OrdersV1/Responses/GetPurchaseOrdersResponse.php index bbd37be37..3352f788e 100644 --- a/src/Vendor/OrdersV1/Responses/GetPurchaseOrdersResponse.php +++ b/src/Vendor/OrdersV1/Responses/GetPurchaseOrdersResponse.php @@ -17,7 +17,6 @@ final class GetPurchaseOrdersResponse extends Response { /** - * @param ?OrderList $payload A list of orders returned as response. * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ public function __construct( diff --git a/src/Vendor/OrdersV1/Responses/GetPurchaseOrdersStatusResponse.php b/src/Vendor/OrdersV1/Responses/GetPurchaseOrdersStatusResponse.php index 3be041ca0..735dc20b7 100644 --- a/src/Vendor/OrdersV1/Responses/GetPurchaseOrdersStatusResponse.php +++ b/src/Vendor/OrdersV1/Responses/GetPurchaseOrdersStatusResponse.php @@ -17,7 +17,6 @@ final class GetPurchaseOrdersStatusResponse extends Response { /** - * @param ?OrderListStatus $payload A list of order statuses. * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ public function __construct( diff --git a/src/Vendor/OrdersV1/Responses/SubmitAcknowledgementResponse.php b/src/Vendor/OrdersV1/Responses/SubmitAcknowledgementResponse.php index 3b3e60dc8..f568cec67 100644 --- a/src/Vendor/OrdersV1/Responses/SubmitAcknowledgementResponse.php +++ b/src/Vendor/OrdersV1/Responses/SubmitAcknowledgementResponse.php @@ -17,7 +17,6 @@ final class SubmitAcknowledgementResponse extends Response { /** - * @param ?TransactionId $payload Response containing the transaction ID. * @param ?ErrorList $errors A list of error responses returned when a request is unsuccessful. */ public function __construct( diff --git a/tests/InMemoryTokenCacheTest.php b/tests/InMemoryTokenCacheTest.php index d7e24a241..a90f8c49c 100644 --- a/tests/InMemoryTokenCacheTest.php +++ b/tests/InMemoryTokenCacheTest.php @@ -16,7 +16,7 @@ class InMemoryTokenCacheTest extends TestCase public function setup(): void { - $this->cache = new InMemoryTokenCache(); + $this->cache = new InMemoryTokenCache; } public function testStoresToken(): void diff --git a/tests/Seller/FBAInboundV0/Requests/UpdateInboundShipmentTest.php b/tests/Seller/FBAInboundV0/Requests/UpdateInboundShipmentTest.php index 37a9bc108..b8fe780e5 100644 --- a/tests/Seller/FBAInboundV0/Requests/UpdateInboundShipmentTest.php +++ b/tests/Seller/FBAInboundV0/Requests/UpdateInboundShipmentTest.php @@ -86,7 +86,7 @@ public function testHasJsonBody(): void shipmentId: 'shipment-id', quantityReceived: 1, quantityInCase: 1, - releaseDate: new DateTime(), + releaseDate: new DateTime, prepDetailsList: [ new PrepDetails( prepInstruction: 'prep-instruction', diff --git a/tests/Seller/FBAInboundV20240320/Responses/ListDeliveryWindowOptionsTest.php b/tests/Seller/FBAInboundV20240320/Responses/ListDeliveryWindowOptionsTest.php index cffec1864..10e324051 100644 --- a/tests/Seller/FBAInboundV20240320/Responses/ListDeliveryWindowOptionsTest.php +++ b/tests/Seller/FBAInboundV20240320/Responses/ListDeliveryWindowOptionsTest.php @@ -11,7 +11,7 @@ class ListDeliveryWindowOptionsTest extends TestCase { public function testDeserializeDateTimeWithoutSeconds(): void { - $now = new DateTime(); + $now = new DateTime; $result = ListDeliveryWindowOptionsResponse::deserialize([ 'pagination' => [ 'nextToken' => 'aafd8957-77f9-434c-b432-3277b795156d', diff --git a/tests/Seller/ProductFeesV0/Responses/GetMyFeesEstimateResponseTest.php b/tests/Seller/ProductFeesV0/Responses/GetMyFeesEstimateResponseTest.php index 7c6893177..e1efdf3a1 100644 --- a/tests/Seller/ProductFeesV0/Responses/GetMyFeesEstimateResponseTest.php +++ b/tests/Seller/ProductFeesV0/Responses/GetMyFeesEstimateResponseTest.php @@ -12,7 +12,7 @@ class GetMyFeesEstimateResponseTest extends TestCase { public function testDeserializeDateTimeWithMs() { - $now = new DateTime(); + $now = new DateTime; $ms = $now->format('v'); $result = GetMyFeesEstimateResponse::deserialize([ 'payload' => [ @@ -31,7 +31,7 @@ public function testDeserializeDateTimeWithMs() public function testDeserializeDateTimeWithTimezone(): void { - $now = new DateTime(); + $now = new DateTime; $now->setTimeZone(new DateTimeZone('+02:00')); $result = GetMyFeesEstimateResponse::deserialize([ @@ -47,7 +47,7 @@ public function testDeserializeDateTimeWithTimezone(): void $this->assertInstanceOf(DateTimeInterface::class, $result->payload->feesEstimateResult->feesEstimate->timeOfFeesEstimation); $this->assertEquals(new DateTimeZone('+02:00'), $result->payload->feesEstimateResult->feesEstimate->timeOfFeesEstimation->getTimeZone()); - $nowUtc = new DateTime(); + $nowUtc = new DateTime; $utcResult = GetMyFeesEstimateResponse::deserialize([ 'payload' => [ 'FeesEstimateResult' => [ diff --git a/tests/Seller/ReportsV20210630/Responses/ReportTest.php b/tests/Seller/ReportsV20210630/Responses/ReportTest.php index 6b8f719b6..796b895d8 100644 --- a/tests/Seller/ReportsV20210630/Responses/ReportTest.php +++ b/tests/Seller/ReportsV20210630/Responses/ReportTest.php @@ -27,7 +27,7 @@ public function testDeserializeUnknownDateTime() public function testDeserializeDateTime() { - $now = new DateTime(); + $now = new DateTime; $result = Report::deserialize([ 'reportId' => 12345, 'reportType' => 'TEST_REPORT', diff --git a/tests/TokenCacheTest.php b/tests/TokenCacheTest.php index ebdd4dc09..ca27413d4 100644 --- a/tests/TokenCacheTest.php +++ b/tests/TokenCacheTest.php @@ -25,7 +25,7 @@ public function setUp(): void { MockClient::destroyGlobal(); Config::preventStrayRequests(); - $this->cache = new InMemoryTokenCache(); + $this->cache = new InMemoryTokenCache; $this->cache->clear(); }