{ "openapi": "3.1.0", "info": { "title": "Seller Assistant Public API", "description": "Seller Assistant is powerful amazon product research tool. The Public API allows developers to interact with the platform programmatically.", "termsOfService": "https://www.sellerassistant.app/terms-of-use", "version": "1.0.0" }, "paths": { "/api/v1/converters/identifier-to-asins": { "get": { "tags": [ "UPC-EAN-ASIN converters" ], "summary": "Get product ASINs based on identifiers (UPC or EAN)", "description": "Get array of product ASINs based on identifiers (UPC or EAN). It returns empty array if product is not found. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "convertUpcOrEanToASINs", "parameters": [ { "name": "identifier", "in": "query", "description": "UPC or EAC to fetch ASINs for.", "required": true, "example": "029877030712" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Convert to ASIN response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertToASINResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertToASINInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/products/{asin}/identifiers": { "get": { "tags": [ "UPC-EAN-ASIN converters" ], "summary": "Get product identifiers (UPC, EAN, etc.) based on ASIN", "description": "Get array of product identifiers (UPC, EAN, etc.) based on ASIN. It returns empty array if product is not found. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getProductIdentifiers", "parameters": [ { "name": "asin", "in": "path", "description": "Amazon product ASIN.", "required": true, "example": "B00U26V4VQ" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Product identifiers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductIdentifiersResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductIdentifiersInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/fba/inboundPlans": { "get": { "tags": [ "FBA Inbound Shipments" ], "summary": "List inbound plans", "description": "List of paginated inbound plans. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listInboundPlans", "parameters": [ { "name": "pageSize", "in": "query", "description": "1 to 30. Defaults to 10. The number of inbound plans to return in the response matching the given query.", "required": false, "example": "10" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "status", "in": "query", "description": "`ACTIVE` or `VOIDED` or `SHIPPED`. The status of an inbound plan.", "required": false, "example": "ACTIVE" }, { "name": "sortBy", "in": "query", "description": "`LAST_UPDATED_TIME` or `CREATION_TIME`. Sort by field", "required": false, "example": "LAST_UPDATED_TIME" }, { "name": "sortOrder", "in": "query", "description": "`ASC` or `DESC`. The sort order.", "required": false, "example": "DESC" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInboundPlansResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInboundPlansInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/fba/inboundPlans/{inboundPlanId}": { "get": { "tags": [ "FBA Inbound Shipments" ], "summary": "Get inbound plan", "description": "Get inbound plan info. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getInboundPlan", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInboundPlanResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInboundPlanInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/fba/inboundPlans/{inboundPlanId}/boxes": { "get": { "tags": [ "FBA Inbound Shipments" ], "summary": "List inbound plan boxes", "description": "List boxes for an inbound plan. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listInboundPlanBoxes", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "pageSize", "in": "query", "description": "Integer 1 to 1000. Defaults to 10. The number of boxes to return in the response matching the given query.", "required": false, "example": "20" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInboundPlanBoxesResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInboundPlanBoxesInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/fba/inboundPlans/{inboundPlanId}/shipments": { "get": { "tags": [ "FBA Inbound Shipments" ], "summary": "List plan shipments", "description": "List plan shipments. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listPlanShipments", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPlanShipmentsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPlanShipmentsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}": { "get": { "tags": [ "FBA Inbound Shipments" ], "summary": "Get shipment", "description": "Get shipment summary. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getShipment", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "shipmentId", "in": "path", "description": "Shipment ID, either the old format (`FBA...`) or the new format (`sh...`). Requests using the old format may take longer to process.", "required": true, "example": "sh7059be6b-54b3-4320-8553-f913d3472cc3" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentSummary" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/items": { "get": { "tags": [ "FBA Inbound Shipments" ], "summary": "List shipment items", "description": "List shipment items. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listShipmentItems", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "shipmentId", "in": "path", "description": "Shipment ID, either the old format (`FBA...`) or the new format (`sh...`). Requests using the old format may take longer to process.", "required": true, "example": "sh7059be6b-54b3-4320-8553-f913d3472cc3" }, { "name": "pageSize", "in": "query", "description": "Integer 1 to 1000. Defaults to 10. The number of placement options to return in the response matching the given query.", "required": false, "example": "20" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "detailed", "in": "query", "description": "When set to true, includes additional details such as `quantityShipped`, `quantityReceived`, and `quantityInCase` for each shipment item. Note: Enabling this option may significantly slow down the response time.", "required": false, "example": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShipmentItemsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShipmentItemsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/fees": { "get": { "tags": [ "FBA Inbound Shipments" ], "summary": "Get shipment fees", "description": "Get shipment transportation and placement fees. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getShipmentFees", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "shipmentId", "in": "path", "description": "Shipment ID, either the old format (`FBA...`) or the new format (`sh...`). Requests using the old format may take longer to process.", "required": true, "example": "sh7059be6b-54b3-4320-8553-f913d3472cc3" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentFeesResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentFeesInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxes": { "get": { "tags": [ "FBA Inbound Shipments" ], "summary": "List shipment boxes", "description": "List boxes for a specific shipment. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listShipmentBoxes", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "shipmentId", "in": "path", "description": "Shipment ID, either the old format (`FBA...`) or the new format (`sh...`). Requests using the old format may take longer to process.", "required": true, "example": "sh7059be6b-54b3-4320-8553-f913d3472cc3" }, { "name": "pageSize", "in": "query", "description": "Integer 1 to 1000. Defaults to 10. The number of boxes to return in the response matching the given query.", "required": false, "example": "20" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShipmentBoxesResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShipmentBoxesInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/keepa/product": { "get": { "tags": [ "Keepa" ], "summary": "Get Keepa product", "description": "Get detailed info of product from Keepa. The product object contains all of Keepa price history data and basic product information. The limit is 60 requests per minute. \n\nKeepa Time Minutes. Time format used for all Keepa timestamps. To convert to an uncompressed Unix epoch time: \n\nFor milliseconds: `(keepaTime + 21564000) * 60000` \n\nFor seconds: `(keepaTime + 21564000) * 60`", "operationId": "getKeepaProduct", "parameters": [ { "name": "asin", "in": "query", "description": "The ASIN of the product you want to request. You cannot use both parameters, asin and code, in the same request.", "required": false, "example": "B00U26V4VQ" }, { "name": "code", "in": "query", "description": "The UPC or EAN of the product you want to request. You cannot use both parameters, asin and code, in the same request.", "required": false, "example": "029877030712" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" }, { "name": "stats", "in": "query", "description": "Include a `stats` field with current prices and statistics. If specified, the product object will include a `stats` field with quick access to current prices, min/max prices, and weighted mean values. If the `offers` parameter is used, it will also provide Buy Box information. \n\nYou can provide the `stats` parameter in two forms: \n\nLast x days (positive integer value): Calculates the stats for the last x days. \n\nInterval: Specify a date range for the stats calculation using two timestamps (Unix epoch time in milliseconds) or two date strings (ISO8601 format, UTC). \n\nNote: If there is insufficient historical data for a price type, the actual interval of the weighted mean calculation may be shorter than specified. All data provided via the `stats` field are calculated using the product object’s csv history field; no new data is provided through this parameter. \n\nExamples: \n\n`&stats=180` (last 180 days) \n\n`&stats=2015-10-20,2015-12-24` (from Oct 20 to Dec 24, 2015) \n\n`&stats=2011-01-01,2025-01-01` (entire history) \n\n`&stats=1445299200000,1450915200000` (Unix epoch time in milliseconds, from Oct 20 to Dec 24, 2015)", "required": false, "example": "30" }, { "name": "update", "in": "query", "description": "Force a refresh if the product’s last update is older than specified hours. Positive integer value. If the product’s last update is older than `update` hours, force a refresh. The default value used by the API is 1 hour. This parameter also works in conjunction with the `offers` parameter. \n\nUsing this parameter, you can achieve the following: \n\nSpeed up requests: If up-to-date data is not required, use a higher value than 1 hour. \n\nAlways retrieve live data: Use the value 0. \n\nNo update at all: Use the value -1.", "required": false, "example": "48" }, { "name": "history", "in": "query", "description": "Exclude historical data fields to reduce response size and processing time. Boolean value (`0` = false, `1` = true). If specified and set to `0`, the product object will not include the `csv`, `salesRanks`, and `salesRankReferenceHistory` fields. If you do not need them, use this to have them removed from the response. This will improve processing time and considerably decrease the size of the response.", "required": false, "example": "1" }, { "name": "days", "in": "query", "description": "Limit historical data to the recent `X` days. Any positive integer value. If specified with a positive value `X`, the product object will limit all historical data to the recent `X` days. This includes the `csv`, `buyBoxSellerIdHistory`, `salesRankReferenceHistory`, `salesRanks`, `offers`, and `offers.offerCSV` fields. If you do not need old historical data, use this to reduce the response size and improve processing time. The parameter does not use calendar days; so `1 day` equals the last 24 hours.", "required": false, "example": "90" }, { "name": "offers", "in": "query", "description": "Retrieve up-to-date marketplace offers. Positive integer value between `20` and `100`. Determines the number of `up-to-date` marketplace offers to retrieve. \n\nIf the `offers` parameter is used, the product object will contain additional data: \n\nMarketplace offer objects \n\nInformation on the New and Used Buy Box, including a history of Buy Box winners \n\nPrice history data for FBA (Fulfillment by Amazon), FBM (Fulfillment by Merchant), Warehouse Deals, Prime exclusive, and all Used and Collectible sub-conditions, including shipping and handling costs \n\nRating and review count history \n\nAll offers-related data is updated independently, irregularly, and not as often as all other product data. Keep this in mind when evaluating the additional historical data. \n\nNotes: \n\nThe returned product may have more offers than specified because Keepa keep a history of offers. The number specified in this parameter determines how many offers Keepa attempt to retrieve/update from Amazon. Each offer object has a `lastSeen` field that can be used to filter up-to-date offers. \n\nAll offers-related data is freshly updated and up-to-date. \n\nThe request will require more time to complete, ranging from 2 to 20 seconds with an average of 5 seconds. \n\nThe request will return successfully and will contain, if available, all `historical` offers (unless `only-live-offers` is used) and product data. You can retry the request after a few minutes. \n\nLimitations: \n\nNot available for digital products, movie rentals, Amazon Fresh, and Amazon Pantry.", "required": false, "example": "20" }, { "name": "only-live-offers", "in": "query", "description": "Include only live marketplace offers; reduces response size. Boolean value (`0` = false, `1` = true). If specified and set to `1`, the product object will only include live marketplace offers (when used in combination with the `offers` parameter). If you do not need historical offers, use this to reduce the response size and improve processing time.", "required": false, "example": "0" }, { "name": "rental", "in": "query", "description": "Collect rental prices when available. Boolean value (`0` = false, `1` = true). Can only be used in conjunction with the `offers` parameter. If specified and set to `1`, the rental price will be collected when available. \n\nNote: \n\nRental prices are only available for Amazon US and only for books (not for eBooks).", "required": false, "example": "1" }, { "name": "rating", "in": "query", "description": "Include existing rating and review count history. Boolean value (`0` = false, `1` = true). If specified and set to `1`, the product object will include Keepa existing `RATING` and `COUNT_REVIEWS` history in the `csv` field, regardless of whether the `offers` parameter is used. \n\nUsing this parameter does not trigger an update to those two fields; it only gives access to Keepa existing data if available. If you need up-to-date data, you have to use the `offers` parameter. Use this if you need access to the rating data, which may be outdated, but do not need any other data fields provided through the `offers` parameter to speed up the request. If there is no rating data returned, you can still make another request using the `offers` parameter.", "required": false, "example": "1" }, { "name": "buybox", "in": "query", "description": "Include Buy Box related data. Boolean value (`0` = false, `1` = true). If specified and set to `1`, the product and statistics object will include all available Buy Box related data: \n\nCurrent price, price history, and statistical values \n\n`buyBoxSellerIdHistory` \n\nAll Buy Box fields in the statistics object \n\nThe `buybox` parameter does not trigger a fresh data collection. If the `offers` parameter is used, the `buybox` parameter is ignored, as the `offers` parameter also provides access to all Buy Box related data. To access the statistics object, the `stats` parameter is required.", "required": false, "example": "1" }, { "name": "stock", "in": "query", "description": "Include stock information in offers. Boolean value (`0` = false, `1` = true). If specified together with the `offers` parameter and set to `1`, the marketplace offer objects will include the `stockCSV` field, and the product object will include the `lastStockUpdate` field. \n\nNote: \n\nThe `stock` parameter is not guaranteed to avoid triggering a fresh stock data collection. The request will require more time to retrieve stock data, ranging from 1 to 2 seconds per offer.", "required": false, "example": "1" } ], "responses": { "200": { "description": "Keepa product response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepaProduct" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetKeepaProductInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/keepa/search": { "get": { "tags": [ "Keepa" ], "summary": "Search Keepa products", "description": "Search for Amazon products using keywords, returning up to 100 results per search term. The results are in the same order as a search on Amazon, excluding sponsored content. By default, the product search response contains the product objects of the found products. The limit is 60 requests per minute. \n\nKeepa Time Minutes. Time format used for all Keepa timestamps. To convert to an uncompressed Unix epoch time: \n\nFor milliseconds: `(keepaTime + 21564000) * 60000` \n\nFor seconds: `(keepaTime + 21564000) * 60`", "operationId": "searchKeepaProducts", "parameters": [ { "name": "term", "in": "query", "description": "The term you want to search for. Should be URL encoded (https://en.wikipedia.org/wiki/Percent-encoding).", "required": true, "example": "Catan" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" }, { "name": "asinsOnly", "in": "query", "description": "If provided and set to `1`, only the ASINs of the found products will be provided instead of the full product objects.", "required": false, "example": "0" }, { "name": "page", "in": "query", "description": "Integer value between `0` and `9`. Each search result page provides up to `10` results. To retrieve more results, iterate the page parameter while keeping all other parameters identical. Start with page=0 and stop when the response contains fewer than 10 results or when you reach page=9, which is the limit.", "required": false, "example": "0" }, { "name": "stats", "in": "query", "description": "Include a `stats` field with current prices and statistics. If specified, the product object will include a `stats` field with quick access to current prices, min/max prices, and weighted mean values. \n\nYou can provide the `stats` parameter in two forms: \n\nLast x days (positive integer value): Calculates the stats for the last x days. \n\nInterval: Specify a date range for the stats calculation using two timestamps (Unix epoch time in milliseconds) or two date strings (ISO8601 format, UTC). \n\nNote: If there is insufficient historical data for a price type, the actual interval of the weighted mean calculation may be shorter than specified. All data provided via the `stats` field are calculated using the product object’s csv history field; no new data is provided through this parameter. \n\nExamples: \n\n`&stats=180` (last 180 days) \n\n`&stats=2015-10-20,2015-12-24` (from Oct 20 to Dec 24, 2015) \n\n`&stats=2011-01-01,2025-01-01` (entire history) \n\n`&stats=1445299200000,1450915200000` (Unix epoch time in milliseconds, from Oct 20 to Dec 24, 2015)", "required": false, "example": "30" }, { "name": "update", "in": "query", "description": "Force a refresh if the product’s last update is older than specified hours. Positive integer value. If the product’s last update is older than `update` hours, force a refresh. The default value used by the API is 1 hour. \n\nUsing this parameter, you can achieve the following: \n\nSpeed up requests: If up-to-date data is not required, use a higher value than 1 hour. \n\nAlways retrieve live data: Use the value 0. \n\nNo update at all: Use the value -1.", "required": false, "example": "48" }, { "name": "history", "in": "query", "description": "Exclude historical data fields to reduce response size and processing time. Boolean value (`0` = false, `1` = true). If specified and set to `0`, the product object will not include the `csv` field. Use this to reduce response size and improve processing time if you do not need the historical data.", "required": false, "example": "0" }, { "name": "rating", "in": "query", "description": "Include existing rating and review count history. Boolean value (`0` = false, `1` = true). If specified and set to `1`, the product object will include Keepa existing `RATING` and `COUNT_REVIEWS` history in the `csv` field, regardless of whether the `offers` parameter is used. \n\nUsing this parameter does not trigger an update to those two fields; it only gives access to Keepa existing data if available.", "required": false, "example": "0" } ], "responses": { "200": { "description": "Search Keepa products response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchKeepaProductsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchKeepaProductsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/keepa/query": { "post": { "tags": [ "Keepa" ], "summary": "Keepa Product Finder", "description": "Search for products that match your specified criteria and receive a Search Insights summary that aggregates KPIs (prices, seller mix, brand counts, etc.) across the entire result set. The limit is 60 requests per minute. \n\nKeepa Time Minutes. Time format used for all Keepa timestamps. To convert to an uncompressed Unix epoch time: \n\nFor milliseconds: `(keepaTime + 21564000) * 60000` \n\nFor seconds: `(keepaTime + 21564000) * 60`", "operationId": "queryKeepaProducts", "parameters": [ { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" }, { "name": "stats", "in": "query", "description": "Include a `searchInsights` field to result object", "required": false, "example": "1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "sort": { "description": "An array of up to three sorting criteria. Each entry is a two-dimensional array in the format [[fieldName, sortDirection]], where sortDirection can be 'asc' or 'desc'. Defaults to ascending by current sales rank.", "example": [ [ "current_SALES", "asc" ] ] }, "page": { "description": "The page number for result pagination. Starts at 0. Use to iterate through results beyond the 'perPage' limit.", "type": "integer", "example": 0 }, "perPage": { "description": "The number of results to return per page. The default and minimum is 50. Can be up to 10,000 for page 0.", "type": "integer", "example": 50 }, "rootCategory": { "description": "An array of up to 50 category node IDs to include products from.", "type": "array", "items": { "type": "integer" }, "example": null }, "categories_include": { "description": "An array of up to 50 sub-category node IDs to specifically include products from.", "type": "array", "items": { "type": "integer" }, "example": null }, "categories_exclude": { "description": "An array of up to 50 sub-category node IDs to exclude products from.", "type": "array", "items": { "type": "integer" }, "example": null }, "salesRankReference": { "description": "The category node ID to be used as the sales rank reference for the product.", "type": "integer", "example": null }, "manufacturer": { "description": "An array of manufacturer names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "title": { "description": "A string of up to 50 keywords used to filter products whose titles contain all specified keywords (case-insensitive).", "type": "string", "example": null }, "singleVariation": { "description": "If set to 'true', only a single variation of a product will be returned.", "type": "boolean", "example": null }, "productType": { "description": "A numerical filter for the product's data availability (e.g., STANDARD, DOWNLOADABLE, EBOOK, VARIATION_PARENT).", "type": "integer", "example": null }, "hasParentASIN": { "description": "A boolean indicating whether the product has a parent ASIN.", "type": "boolean", "example": null }, "availabilityAmazon": { "description": "An array of integers representing the availability status of Amazon's offer for the product (-1: no offer, 0: in stock, etc.).", "type": "array", "items": { "type": "integer" }, "example": null }, "returnRate": { "description": "An array of integers to filter by customer return rate (1: low, 2: high).", "type": "array", "items": { "type": "integer" }, "example": null }, "hasReviews": { "description": "A boolean indicating whether the product has customer reviews.", "type": "boolean", "example": null }, "lastPriceChange_lte": { "description": "Filters for products with a last price change registered less than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "lastPriceChange_gte": { "description": "Filters for products with a last price change registered greater than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "lastOffersUpdate_lte": { "description": "Filters for products whose offers were last updated less than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "lastOffersUpdate_gte": { "description": "Filters for products whose offers were last updated greater than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "trackingSince_lte": { "description": "Filters for products tracked since a time less than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "trackingSince_gte": { "description": "Filters for products tracked since a time greater than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "brand": { "description": "An array of brand names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "productGroup": { "description": "An array of product group names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "partNumber": { "description": "An array of part numbers to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "model": { "description": "An array of model names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "color": { "description": "An array of color names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "size": { "description": "An array of size names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "edition": { "description": "An array of edition names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "format": { "description": "An array of format names (e.g., 'cd-rom') to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "packageHeight_lte": { "description": "Filters for products with a package height less than or equal to the specified value in millimeters.", "type": "integer", "example": null }, "packageHeight_gte": { "description": "Filters for products with a package height greater than or equal to the specified value in millimeters.", "type": "integer", "example": null }, "packageLength_lte": { "description": "Filters for products with a package length less than or equal to the specified value in millimeters.", "type": "integer", "example": null }, "packageLength_gte": { "description": "Filters for products with a package length greater than or equal to the specified value in millimeters.", "type": "integer", "example": null }, "packageWidth_lte": { "description": "Filters for products with a package width less than or equal to the specified value in millimeters.", "type": "integer", "example": null }, "packageWidth_gte": { "description": "Filters for products with a package width greater than or equal to the specified value in millimeters.", "type": "integer", "example": null }, "packageWeight_lte": { "description": "Filters for products with a package weight less than or equal to the specified value in grams.", "type": "integer", "example": null }, "packageWeight_gte": { "description": "Filters for products with a package weight greater than or equal to the specified value in grams.", "type": "integer", "example": null }, "itemHeight_lte": { "description": "Filters for products with an item height less than or equal to the specified value in millimeters.", "type": "integer", "example": null }, "itemHeight_gte": { "description": "Filters for products with an item height greater than or equal to the specified value in millimeters.", "type": "integer", "example": null }, "itemWeight_lte": { "description": "Filters for products with an item weight less than or equal to the specified value in grams.", "type": "integer", "example": null }, "itemWeight_gte": { "description": "Filters for products with an item weight greater than or equal to the specified value in grams.", "type": "integer", "example": null }, "variationCount_lte": { "description": "Filters for products with a number of variations less than or equal to the specified value.", "type": "integer", "example": null }, "variationCount_gte": { "description": "Filters for products with a number of variations greater than or equal to the specified value.", "type": "integer", "example": null }, "imageCount_lte": { "description": "Filters for products with a number of images less than or equal to the specified value.", "type": "integer", "example": null }, "imageCount_gte": { "description": "Filters for products with a number of images greater than or equal to the specified value.", "type": "integer", "example": null }, "buyBoxStatsAmazon30_lte": { "description": "Filters for products where Amazon held the Buy Box for a percentage less than or equal to the specified value over the last 30 days.", "type": "integer", "example": null }, "buyBoxStatsAmazon30_gte": { "description": "Filters for products where Amazon held the Buy Box for a percentage greater than or equal to the specified value over the last 30 days.", "type": "integer", "example": null }, "buyBoxStatsAmazon90_lte": { "description": "Filters for products where Amazon held the Buy Box for a percentage less than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "buyBoxStatsAmazon90_gte": { "description": "Filters for products where Amazon held the Buy Box for a percentage greater than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "buyBoxStatsAmazon180_lte": { "description": "Filters for products where Amazon held the Buy Box for a percentage less than or equal to the specified value over the last 180 days.", "type": "integer", "example": null }, "buyBoxStatsAmazon180_gte": { "description": "Filters for products where Amazon held the Buy Box for a percentage greater than or equal to the specified value over the last 180 days.", "type": "integer", "example": null }, "buyBoxStatsAmazon365_lte": { "description": "Filters for products where Amazon held the Buy Box for a percentage less than or equal to the specified value over the last 365 days.", "type": "integer", "example": null }, "buyBoxStatsAmazon365_gte": { "description": "Filters for products where Amazon held the Buy Box for a percentage greater than or equal to the specified value over the last 365 days.", "type": "integer", "example": null }, "buyBoxStatsTopSeller30_lte": { "description": "Filters for products where the top seller held the Buy Box for a percentage less than or equal to the specified value over the last 30 days.", "type": "integer", "example": null }, "buyBoxStatsTopSeller30_gte": { "description": "Filters for products where the top seller held the Buy Box for a percentage greater than or equal to the specified value over the last 30 days.", "type": "integer", "example": null }, "buyBoxStatsTopSeller90_lte": { "description": "Filters for products where the top seller held the Buy Box for a percentage less than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "buyBoxStatsTopSeller90_gte": { "description": "Filters for products where the top seller held the Buy Box for a percentage greater than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "buyBoxStatsTopSeller180_lte": { "description": "Filters for products where the top seller held the Buy Box for a percentage less than or equal to the specified value over the last 180 days.", "type": "integer", "example": null }, "buyBoxStatsTopSeller180_gte": { "description": "Filters for products where the top seller held the Buy Box for a percentage greater than or equal to the specified value over the last 180 days.", "type": "integer", "example": null }, "buyBoxStatsTopSeller365_lte": { "description": "Filters for products where the top seller held the Buy Box for a percentage less than or equal to the specified value over the last 365 days.", "type": "integer", "example": null }, "buyBoxStatsTopSeller365_gte": { "description": "Filters for products where the top seller held the Buy Box for a percentage greater than or equal to the specified value over the last 365 days.", "type": "integer", "example": null }, "buyBoxStatsSellerCount30_lte": { "description": "Filters for products with a number of sellers holding the Buy Box less than or equal to the specified value over the last 30 days.", "type": "integer", "example": null }, "buyBoxStatsSellerCount30_gte": { "description": "Filters for products with a number of sellers holding the Buy Box greater than or equal to the specified value over the last 30 days.", "type": "integer", "example": null }, "buyBoxStatsSellerCount90_lte": { "description": "Filters for products with a number of sellers holding the Buy Box less than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "buyBoxStatsSellerCount90_gte": { "description": "Filters for products with a number of sellers holding the Buy Box greater than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "buyBoxStatsSellerCount180_lte": { "description": "Filters for products with a number of sellers holding the Buy Box less than or equal to the specified value over the last 180 days.", "type": "integer", "example": null }, "buyBoxStatsSellerCount180_gte": { "description": "Filters for products with a number of sellers holding the Buy Box greater than or equal to the specified value over the last 180 days.", "type": "integer", "example": null }, "buyBoxStatsSellerCount365_lte": { "description": "Filters for products with a number of sellers holding the Buy Box less than or equal to the specified value over the last 365 days.", "type": "integer", "example": null }, "buyBoxStatsSellerCount365_gte": { "description": "Filters for products with a number of sellers holding the Buy Box greater than or equal to the specified value over the last 365 days.", "type": "integer", "example": null }, "outOfStockPercentage90_lte": { "description": "Filters for products with an Amazon out-of-stock percentage less than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "outOfStockPercentage90_gte": { "description": "Filters for products with an Amazon out-of-stock percentage greater than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "variationReviewCount_lte": { "description": "Filters for products with a variation-specific review count less than or equal to the specified value.", "type": "integer", "example": null }, "variationReviewCount_gte": { "description": "Filters for products with a variation-specific review count greater than or equal to the specified value.", "type": "integer", "example": null }, "variationRatingCount_lte": { "description": "Filters for products with a variation-specific rating count less than or equal to the specified value.", "type": "integer", "example": null }, "variationRatingCount_gte": { "description": "Filters for products with a variation-specific rating count greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_monthlySold_lte": { "description": "Filters for a percentage change in monthly sales less than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "deltaPercent90_monthlySold_gte": { "description": "Filters for a percentage change in monthly sales greater than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "outOfStockCountAmazon30_lte": { "description": "Filters for products out of stock on Amazon for a number of times less than or equal to the specified value over the last 30 days.", "type": "integer", "example": null }, "outOfStockCountAmazon30_gte": { "description": "Filters for products out of stock on Amazon for a number of times greater than or equal to the specified value over the last 30 days.", "type": "integer", "example": null }, "outOfStockCountAmazon90_lte": { "description": "Filters for products out of stock on Amazon for a number of times less than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "outOfStockCountAmazon90_gte": { "description": "Filters for products out of stock on Amazon for a number of times greater than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "isHazMat": { "description": "A boolean indicating if the product is classified as hazardous material.", "type": "boolean", "example": null }, "isHeatSensitive": { "description": "A boolean indicating if the product is classified as heat sensitive.", "type": "boolean", "example": null }, "isAdultProduct": { "description": "A boolean indicating if the product is for adults only.", "type": "boolean", "example": null }, "isEligibleForTradeIn": { "description": "A boolean indicating if the product is eligible for Amazon's trade-in program.", "type": "boolean", "example": null }, "isEligibleForSuperSaverShipping": { "description": "A boolean indicating if the product is eligible for super saver shipping.", "type": "boolean", "example": null }, "isSNS": { "description": "A boolean indicating if the product's Buy Box offer is eligible for Subscribe & Save.", "type": "boolean", "example": null }, "buyBoxIsPreorder": { "description": "A boolean indicating if the Buy Box offer is a preorder.", "type": "boolean", "example": null }, "buyBoxIsBackorder": { "description": "A boolean indicating if the Buy Box offer is backordered.", "type": "boolean", "example": null }, "buyBoxIsPrimeExclusive": { "description": "A boolean indicating if the Buy Box offer is a Prime exclusive deal.", "type": "boolean", "example": null }, "author": { "description": "An array of author names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "binding": { "description": "An array of binding types to filter by (e.g., 'paperback').", "type": "array", "items": { "type": "string" }, "example": null }, "genre": { "description": "An array of genre names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "languages": { "description": "An array of languages the product is available in.", "type": "array", "items": { "type": "string" }, "example": null }, "publisher": { "description": "An array of publisher names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "platform": { "description": "An array of platforms the product is available on.", "type": "array", "items": { "type": "string" }, "example": null }, "activeIngredients": { "description": "An array of active ingredients to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "specialIngredients": { "description": "An array of special ingredients to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "itemTypeKeyword": { "description": "An array of item type keywords to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "targetAudienceKeyword": { "description": "An array of target audience keywords to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "itemForm": { "description": "An array of item forms to filter by (e.g., 'liquid').", "type": "array", "items": { "type": "string" }, "example": null }, "scent": { "description": "An array of scents to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "unitType": { "description": "An array of unit types to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "pattern": { "description": "An array of pattern designs to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "style": { "description": "An array of styles to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "material": { "description": "An array of material compositions to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "frequentlyBoughtTogether": { "description": "An array of ASINs to find products frequently bought together with them.", "type": "array", "items": { "type": "string" }, "example": null }, "couponOneTimeAbsolute_lte": { "description": "Filters for products with a maximum absolute one-time coupon value less than or equal to the specified integer value.", "type": "integer", "example": null }, "couponOneTimeAbsolute_gte": { "description": "Filters for products with a minimum absolute one-time coupon value greater than or equal to the specified integer value.", "type": "integer", "example": null }, "couponOneTimePercent_lte": { "description": "Filters for products with a maximum percentage one-time coupon value less than or equal to the specified integer value.", "type": "integer", "example": null }, "couponOneTimePercent_gte": { "description": "Filters for products with a minimum percentage one-time coupon value greater than or equal to the specified integer value.", "type": "integer", "example": null }, "couponSNSPercent_lte": { "description": "Filters for products with a maximum percentage Subscribe & Save coupon value less than or equal to the specified integer value.", "type": "integer", "example": null }, "couponSNSPercent_gte": { "description": "Filters for products with a minimum percentage Subscribe & Save coupon value greater than or equal to the specified integer value.", "type": "integer", "example": null }, "flipability30_lte": { "description": "Filters for products with a flipability score less than or equal to the specified value over the last 30 days.", "type": "integer", "example": null }, "flipability30_gte": { "description": "Filters for products with a flipability score greater than or equal to the specified value over the last 30 days.", "type": "integer", "example": null }, "flipability90_lte": { "description": "Filters for products with a flipability score less than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "flipability90_gte": { "description": "Filters for products with a flipability score greater than or equal to the specified value over the last 90 days.", "type": "integer", "example": null }, "flipability365_lte": { "description": "Filters for products with a flipability score less than or equal to the specified value over the last 365 days.", "type": "integer", "example": null }, "flipability365_gte": { "description": "Filters for products with a flipability score greater than or equal to the specified value over the last 365 days.", "type": "integer", "example": null }, "businessDiscount_lte": { "description": "Filters for products with a maximum business discount less than or equal to the specified value.", "type": "integer", "example": null }, "businessDiscount_gte": { "description": "Filters for products with a minimum business discount greater than or equal to the specified value.", "type": "integer", "example": null }, "batteriesRequired": { "description": "A boolean indicating if the item requires batteries to function.", "type": "boolean", "example": null }, "batteriesIncluded": { "description": "A boolean indicating if batteries are included with the item.", "type": "boolean", "example": null }, "isMerchOnDemand": { "description": "A boolean indicating if the product is a Merch on Demand item.", "type": "boolean", "example": null }, "hasMainVideo": { "description": "A boolean indicating if the product has a main promotional video in its image carousel.", "type": "boolean", "example": null }, "hasAPlus": { "description": "A boolean indicating if the item has A+ content.", "type": "boolean", "example": null }, "hasAPlusFromManufacturer": { "description": "A boolean indicating if the A+ content is provided by the manufacturer or vendor.", "type": "boolean", "example": null }, "videoCount_lte": { "description": "Filters for products with a maximum number of associated videos less than or equal to the specified value.", "type": "integer", "example": null }, "videoCount_gte": { "description": "Filters for products with a minimum number of associated videos greater than or equal to the specified value.", "type": "integer", "example": null }, "brandStoreName": { "description": "An array of brand store names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "brandStoreUrlName": { "description": "An array of URL-friendly brand store names to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "buyBoxIsAmazon": { "description": "A boolean indicating if the Buy Box is held by Amazon.", "type": "boolean", "example": null }, "buyBoxIsFBA": { "description": "A boolean indicating if the Buy Box is fulfilled by Amazon (FBA).", "type": "boolean", "example": null }, "buyBoxIsUnqualified": { "description": "A boolean indicating if the Buy Box is unqualified.", "type": "boolean", "example": null }, "buyBoxSellerId": { "description": "An array of seller IDs holding the Buy Box to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "buyBoxUsedCondition": { "description": "An array of integers representing the used condition of the Buy Box offer to filter by (2: Like New, 3: Very Good, 4: Good, 5: Acceptable).", "type": "array", "items": { "type": "integer" }, "example": null }, "buyBoxUsedIsFBA": { "description": "A boolean indicating if the Used Buy Box is fulfilled by Amazon (FBA).", "type": "boolean", "example": null }, "buyBoxUsedSellerId": { "description": "An array of seller IDs holding the Used Buy Box to filter by.", "type": "array", "items": { "type": "string" }, "example": null }, "sellerIds": { "description": "An array of seller IDs that offer the product.", "type": "array", "items": { "type": "string" }, "example": null }, "sellerIdsLowestFBA": { "description": "An array of seller IDs offering the lowest FBA price for the product.", "type": "array", "items": { "type": "string" }, "example": null }, "sellerIdsLowestFBM": { "description": "An array of seller IDs offering the lowest FBM price for the product.", "type": "array", "items": { "type": "string" }, "example": null }, "numberOfItems_lte": { "description": "Filters for products with a number of items less than or equal to the specified value.", "type": "integer", "example": null }, "numberOfItems_gte": { "description": "Filters for products with a number of items greater than or equal to the specified value.", "type": "integer", "example": null }, "numberOfPages_lte": { "description": "Filters for products with a number of pages less than or equal to the specified value.", "type": "integer", "example": null }, "numberOfPages_gte": { "description": "Filters for products with a number of pages greater than or equal to the specified value.", "type": "integer", "example": null }, "publicationDate_lte": { "description": "Filters for products with a publication date less than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "publicationDate_gte": { "description": "Filters for products with a publication date greater than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "releaseDate_lte": { "description": "Filters for products with a release date less than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "releaseDate_gte": { "description": "Filters for products with a release date greater than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "isPrimeExclusive": { "description": "A boolean indicating if the product has a Prime exclusive offer.", "type": "boolean", "example": null }, "lightningEnd_lte": { "description": "Filters for products with a current or upcoming lightning deal ending less than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "lightningEnd_gte": { "description": "Filters for products with a current or upcoming lightning deal ending greater than or equal to the specified Keepa Time minutes.", "type": "integer", "example": null }, "monthlySold_lte": { "description": "Filters for products with a 'monthly sold' value less than or equal to the specified value.", "type": "integer", "example": null }, "monthlySold_gte": { "description": "Filters for products with a 'monthly sold' value greater than or equal to the specified value.", "type": "integer", "example": null }, "current_AMAZON_lte": { "description": "Filters for products with a current Amazon price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_AMAZON_gte": { "description": "Filters for products with a current Amazon price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_NEW_lte": { "description": "Filters for products with a current new price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_NEW_gte": { "description": "Filters for products with a current new price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_USED_lte": { "description": "Filters for products with a current used price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_USED_gte": { "description": "Filters for products with a current used price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_SALES_lte": { "description": "Filters for products with a current sales rank less than or equal to the specified value.", "type": "integer", "example": null }, "current_SALES_gte": { "description": "Filters for products with a current sales rank greater than or equal to the specified value.", "type": "integer", "example": null }, "current_LISTPRICE_lte": { "description": "Filters for products with a current list price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_LISTPRICE_gte": { "description": "Filters for products with a current list price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_COLLECTIBLE_lte": { "description": "Filters for products with a current collectible price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_COLLECTIBLE_gte": { "description": "Filters for products with a current collectible price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_REFURBISHED_lte": { "description": "Filters for products with a current refurbished price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_REFURBISHED_gte": { "description": "Filters for products with a current refurbished price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_NEW_FBM_SHIPPING_lte": { "description": "Filters for products with a current new FBM shipping price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_NEW_FBM_SHIPPING_gte": { "description": "Filters for products with a current new FBM shipping price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_LIGHTNING_DEAL_lte": { "description": "Filters for products with a current lightning deal price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_LIGHTNING_DEAL_gte": { "description": "Filters for products with a current lightning deal price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_WAREHOUSE_lte": { "description": "Filters for products with a current warehouse price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_WAREHOUSE_gte": { "description": "Filters for products with a current warehouse price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_NEW_FBA_lte": { "description": "Filters for products with a current new FBA price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_NEW_FBA_gte": { "description": "Filters for products with a current new FBA price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_COUNT_NEW_lte": { "description": "Filters for products with a current count of new offers less than or equal to the specified value.", "type": "integer", "example": null }, "current_COUNT_NEW_gte": { "description": "Filters for products with a current count of new offers greater than or equal to the specified value.", "type": "integer", "example": null }, "current_COUNT_USED_lte": { "description": "Filters for products with a current count of used offers less than or equal to the specified value.", "type": "integer", "example": null }, "current_COUNT_USED_gte": { "description": "Filters for products with a current count of used offers greater than or equal to the specified value.", "type": "integer", "example": null }, "current_COUNT_REFURBISHED_lte": { "description": "Filters for products with a current count of refurbished offers less than or equal to the specified value.", "type": "integer", "example": null }, "current_COUNT_REFURBISHED_gte": { "description": "Filters for products with a current count of refurbished offers greater than or equal to the specified value.", "type": "integer", "example": null }, "current_COUNT_COLLECTIBLE_lte": { "description": "Filters for products with a current count of collectible offers less than or equal to the specified value.", "type": "integer", "example": null }, "current_COUNT_COLLECTIBLE_gte": { "description": "Filters for products with a current count of collectible offers greater than or equal to the specified value.", "type": "integer", "example": null }, "current_RATING_lte": { "description": "Filters for products with a current rating less than or equal to the specified value.", "type": "integer", "example": null }, "current_RATING_gte": { "description": "Filters for products with a current rating greater than or equal to the specified value.", "type": "integer", "example": null }, "current_COUNT_REVIEWS_lte": { "description": "Filters for products with a current review count less than or equal to the specified value.", "type": "integer", "example": null }, "current_COUNT_REVIEWS_gte": { "description": "Filters for products with a current review count greater than or equal to the specified value.", "type": "integer", "example": null }, "current_BUY_BOX_SHIPPING_lte": { "description": "Filters for products with a current Buy Box shipping price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_BUY_BOX_SHIPPING_gte": { "description": "Filters for products with a current Buy Box shipping price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_USED_NEW_SHIPPING_lte": { "description": "Filters for products with a current used 'like new' shipping price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_USED_NEW_SHIPPING_gte": { "description": "Filters for products with a current used 'like new' shipping price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_USED_VERY_GOOD_SHIPPING_lte": { "description": "Filters for products with a current used 'very good' shipping price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_USED_VERY_GOOD_SHIPPING_gte": { "description": "Filters for products with a current used 'very good' shipping price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_USED_GOOD_SHIPPING_lte": { "description": "Filters for products with a current used 'good' shipping price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_USED_GOOD_SHIPPING_gte": { "description": "Filters for products with a current used 'good' shipping price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_USED_ACCEPTABLE_SHIPPING_lte": { "description": "Filters for products with a current used 'acceptable' shipping price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_USED_ACCEPTABLE_SHIPPING_gte": { "description": "Filters for products with a current used 'acceptable' shipping price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_REFURBISHED_SHIPPING_lte": { "description": "Filters for products with a current refurbished shipping price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_REFURBISHED_SHIPPING_gte": { "description": "Filters for products with a current refurbished shipping price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_TRADE_IN_lte": { "description": "Filters for products with a current trade-in value less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "current_TRADE_IN_gte": { "description": "Filters for products with a current trade-in value greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_AMAZON_lte": { "description": "Filters for products with a 90-day absolute price difference (current minus average) for the Amazon offer less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_AMAZON_gte": { "description": "Filters for products with a 90-day absolute price difference (current minus average) for the Amazon offer greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_NEW_lte": { "description": "Filters for products with a 90-day absolute price difference (current minus average) for the new price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_NEW_gte": { "description": "Filters for products with a 90-day absolute price difference (current minus average) for the new price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_USED_lte": { "description": "Filters for products with a 90-day absolute price difference (current minus average) for the used price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_USED_gte": { "description": "Filters for products with a 90-day absolute price difference (current minus average) for the used price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_SALES_lte": { "description": "Filters for products with a 90-day absolute sales rank difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta90_SALES_gte": { "description": "Filters for products with a 90-day absolute sales rank difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta90_LISTPRICE_lte": { "description": "Filters for products with a 90-day absolute list price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_LISTPRICE_gte": { "description": "Filters for products with a 90-day absolute list price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_COLLECTIBLE_lte": { "description": "Filters for products with a 90-day absolute collectible price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_COLLECTIBLE_gte": { "description": "Filters for products with a 90-day absolute collectible price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_REFURBISHED_lte": { "description": "Filters for products with a 90-day absolute refurbished price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_REFURBISHED_gte": { "description": "Filters for products with a 90-day absolute refurbished price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_NEW_FBM_SHIPPING_lte": { "description": "Filters for products with a 90-day absolute new FBM shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_NEW_FBM_SHIPPING_gte": { "description": "Filters for products with a 90-day absolute new FBM shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_LIGHTNING_DEAL_lte": { "description": "Filters for products with a 90-day absolute lightning deal price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_LIGHTNING_DEAL_gte": { "description": "Filters for products with a 90-day absolute lightning deal price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_WAREHOUSE_lte": { "description": "Filters for products with a 90-day absolute warehouse price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_WAREHOUSE_gte": { "description": "Filters for products with a 90-day absolute warehouse price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_NEW_FBA_lte": { "description": "Filters for products with a 90-day absolute new FBA price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_NEW_FBA_gte": { "description": "Filters for products with a 90-day absolute new FBA price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_COUNT_NEW_lte": { "description": "Filters for products with a 90-day absolute count of new offers difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta90_COUNT_NEW_gte": { "description": "Filters for products with a 90-day absolute count of new offers difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta90_COUNT_USED_lte": { "description": "Filters for products with a 90-day absolute count of used offers difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta90_COUNT_USED_gte": { "description": "Filters for products with a 90-day absolute count of used offers difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta90_COUNT_REFURBISHED_lte": { "description": "Filters for products with a 90-day absolute count of refurbished offers difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta90_COUNT_REFURBISHED_gte": { "description": "Filters for products with a 90-day absolute count of refurbished offers difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta90_COUNT_COLLECTIBLE_lte": { "description": "Filters for products with a 90-day absolute count of collectible offers difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta90_COUNT_COLLECTIBLE_gte": { "description": "Filters for products with a 90-day absolute count of collectible offers difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta90_RATING_lte": { "description": "Filters for products with a 90-day absolute rating difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta90_RATING_gte": { "description": "Filters for products with a 90-day absolute rating difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta90_COUNT_REVIEWS_lte": { "description": "Filters for products with a 90-day absolute review count difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta90_COUNT_REVIEWS_gte": { "description": "Filters for products with a 90-day absolute review count difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta90_BUY_BOX_SHIPPING_lte": { "description": "Filters for products with a 90-day absolute Buy Box shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_BUY_BOX_SHIPPING_gte": { "description": "Filters for products with a 90-day absolute Buy Box shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_USED_NEW_SHIPPING_lte": { "description": "Filters for products with a 90-day absolute used 'like new' shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_USED_NEW_SHIPPING_gte": { "description": "Filters for products with a 90-day absolute used 'like new' shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_USED_VERY_GOOD_SHIPPING_lte": { "description": "Filters for products with a 90-day absolute used 'very good' shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_USED_VERY_GOOD_SHIPPING_gte": { "description": "Filters for products with a 90-day absolute used 'very good' shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_USED_GOOD_SHIPPING_lte": { "description": "Filters for products with a 90-day absolute used 'good' shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_USED_GOOD_SHIPPING_gte": { "description": "Filters for products with a 90-day absolute used 'good' shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_USED_ACCEPTABLE_SHIPPING_lte": { "description": "Filters for products with a 90-day absolute used 'acceptable' shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_USED_ACCEPTABLE_SHIPPING_gte": { "description": "Filters for products with a 90-day absolute used 'acceptable' shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_REFURBISHED_SHIPPING_lte": { "description": "Filters for products with a 90-day absolute refurbished shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_REFURBISHED_SHIPPING_gte": { "description": "Filters for products with a 90-day absolute refurbished shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_TRADE_IN_lte": { "description": "Filters for products with a 90-day absolute trade-in value difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta90_TRADE_IN_gte": { "description": "Filters for products with a 90-day absolute trade-in value difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_AMAZON_lte": { "description": "Filters for products with a 30-day absolute price difference (current minus average) for the Amazon offer less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_AMAZON_gte": { "description": "Filters for products with a 30-day absolute price difference (current minus average) for the Amazon offer greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_NEW_lte": { "description": "Filters for products with a 30-day absolute price difference (current minus average) for the new price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_NEW_gte": { "description": "Filters for products with a 30-day absolute price difference (current minus average) for the new price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_USED_lte": { "description": "Filters for products with a 30-day absolute price difference (current minus average) for the used price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_USED_gte": { "description": "Filters for products with a 30-day absolute price difference (current minus average) for the used price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_SALES_lte": { "description": "Filters for products with a 30-day absolute sales rank difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta30_SALES_gte": { "description": "Filters for products with a 30-day absolute sales rank difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta30_LISTPRICE_lte": { "description": "Filters for products with a 30-day absolute list price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_LISTPRICE_gte": { "description": "Filters for products with a 30-day absolute list price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_COLLECTIBLE_lte": { "description": "Filters for products with a 30-day absolute collectible price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_COLLECTIBLE_gte": { "description": "Filters for products with a 30-day absolute collectible price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_REFURBISHED_lte": { "description": "Filters for products with a 30-day absolute refurbished price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_REFURBISHED_gte": { "description": "Filters for products with a 30-day absolute refurbished price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_NEW_FBM_SHIPPING_lte": { "description": "Filters for products with a 30-day absolute new FBM shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_NEW_FBM_SHIPPING_gte": { "description": "Filters for products with a 30-day absolute new FBM shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_LIGHTNING_DEAL_lte": { "description": "Filters for products with a 30-day absolute lightning deal price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_LIGHTNING_DEAL_gte": { "description": "Filters for products with a 30-day absolute lightning deal price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_WAREHOUSE_lte": { "description": "Filters for products with a 30-day absolute warehouse price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_WAREHOUSE_gte": { "description": "Filters for products with a 30-day absolute warehouse price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_NEW_FBA_lte": { "description": "Filters for products with a 30-day absolute new FBA price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_NEW_FBA_gte": { "description": "Filters for products with a 30-day absolute new FBA price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_COUNT_NEW_lte": { "description": "Filters for products with a 30-day absolute count of new offers difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta30_COUNT_NEW_gte": { "description": "Filters for products with a 30-day absolute count of new offers difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta30_COUNT_USED_lte": { "description": "Filters for products with a 30-day absolute count of used offers difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta30_COUNT_USED_gte": { "description": "Filters for products with a 30-day absolute count of used offers difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta30_COUNT_REFURBISHED_lte": { "description": "Filters for products with a 30-day absolute count of refurbished offers difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta30_COUNT_REFURBISHED_gte": { "description": "Filters for products with a 30-day absolute count of refurbished offers difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta30_COUNT_COLLECTIBLE_lte": { "description": "Filters for products with a 30-day absolute count of collectible offers difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta30_COUNT_COLLECTIBLE_gte": { "description": "Filters for products with a 30-day absolute count of collectible offers difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta30_RATING_lte": { "description": "Filters for products with a 30-day absolute rating difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta30_RATING_gte": { "description": "Filters for products with a 30-day absolute rating difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta30_COUNT_REVIEWS_lte": { "description": "Filters for products with a 30-day absolute review count difference (current minus average) less than or equal to the specified value.", "type": "integer", "example": null }, "delta30_COUNT_REVIEWS_gte": { "description": "Filters for products with a 30-day absolute review count difference (current minus average) greater than or equal to the specified value.", "type": "integer", "example": null }, "delta30_BUY_BOX_SHIPPING_lte": { "description": "Filters for products with a 30-day absolute Buy Box shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_BUY_BOX_SHIPPING_gte": { "description": "Filters for products with a 30-day absolute Buy Box shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_USED_NEW_SHIPPING_lte": { "description": "Filters for products with a 30-day absolute used 'like new' shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_USED_NEW_SHIPPING_gte": { "description": "Filters for products with a 30-day absolute used 'like new' shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_USED_VERY_GOOD_SHIPPING_lte": { "description": "Filters for products with a 30-day absolute used 'very good' shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_USED_VERY_GOOD_SHIPPING_gte": { "description": "Filters for products with a 30-day absolute used 'very good' shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_USED_GOOD_SHIPPING_lte": { "description": "Filters for products with a 30-day absolute used 'good' shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_USED_GOOD_SHIPPING_gte": { "description": "Filters for products with a 30-day absolute used 'good' shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_USED_ACCEPTABLE_SHIPPING_lte": { "description": "Filters for products with a 30-day absolute used 'acceptable' shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_USED_ACCEPTABLE_SHIPPING_gte": { "description": "Filters for products with a 30-day absolute used 'acceptable' shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_REFURBISHED_SHIPPING_lte": { "description": "Filters for products with a 30-day absolute refurbished shipping price difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_REFURBISHED_SHIPPING_gte": { "description": "Filters for products with a 30-day absolute refurbished shipping price difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_TRADE_IN_lte": { "description": "Filters for products with a 30-day absolute trade-in value difference (current minus average) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "delta30_TRADE_IN_gte": { "description": "Filters for products with a 30-day absolute trade-in value difference (current minus average) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaPercent90_AMAZON_lte": { "description": "Filters for products with a 90-day percentage price change for the Amazon offer less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_AMAZON_gte": { "description": "Filters for products with a 90-day percentage price change for the Amazon offer greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_NEW_lte": { "description": "Filters for products with a 90-day percentage price change for the new price less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_NEW_gte": { "description": "Filters for products with a 90-day percentage price change for the new price greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_USED_lte": { "description": "Filters for products with a 90-day percentage price change for the used price less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_USED_gte": { "description": "Filters for products with a 90-day percentage price change for the used price greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_SALES_lte": { "description": "Filters for products with a 90-day percentage sales rank change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_SALES_gte": { "description": "Filters for products with a 90-day percentage sales rank change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_LISTPRICE_lte": { "description": "Filters for products with a 90-day percentage list price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_LISTPRICE_gte": { "description": "Filters for products with a 90-day percentage list price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COLLECTIBLE_lte": { "description": "Filters for products with a 90-day percentage collectible price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COLLECTIBLE_gte": { "description": "Filters for products with a 90-day percentage collectible price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_REFURBISHED_lte": { "description": "Filters for products with a 90-day percentage refurbished price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_REFURBISHED_gte": { "description": "Filters for products with a 90-day percentage refurbished price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_NEW_FBM_SHIPPING_lte": { "description": "Filters for products with a 90-day percentage new FBM shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_NEW_FBM_SHIPPING_gte": { "description": "Filters for products with a 90-day percentage new FBM shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_LIGHTNING_DEAL_lte": { "description": "Filters for products with a 90-day percentage lightning deal price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_LIGHTNING_DEAL_gte": { "description": "Filters for products with a 90-day percentage lightning deal price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_WAREHOUSE_lte": { "description": "Filters for products with a 90-day percentage warehouse price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_WAREHOUSE_gte": { "description": "Filters for products with a 90-day percentage warehouse price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_NEW_FBA_lte": { "description": "Filters for products with a 90-day percentage new FBA price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_NEW_FBA_gte": { "description": "Filters for products with a 90-day percentage new FBA price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COUNT_NEW_lte": { "description": "Filters for products with a 90-day percentage count of new offers change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COUNT_New_gte": { "description": "Filters for products with a 90-day percentage count of new offers change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COUNT_USED_lte": { "description": "Filters for products with a 90-day percentage count of used offers change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COUNT_USED_gte": { "description": "Filters for products with a 90-day percentage count of used offers change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COUNT_REFURBISHED_lte": { "description": "Filters for products with a 90-day percentage count of refurbished offers change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COUNT_REFURBISHED_gte": { "description": "Filters for products with a 90-day percentage count of refurbished offers change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COUNT_COLLECTIBLE_lte": { "description": "Filters for products with a 90-day percentage count of collectible offers change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COUNT_COLLECTIBLE_gte": { "description": "Filters for products with a 90-day percentage count of collectible offers change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_RATING_lte": { "description": "Filters for products with a 90-day percentage rating change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_RATING_gte": { "description": "Filters for products with a 90-day percentage rating change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COUNT_REVIEWS_lte": { "description": "Filters for products with a 90-day percentage review count change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_COUNT_REVIEWS_gte": { "description": "Filters for products with a 90-day percentage review count change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_BUY_BOX_SHIPPING_lte": { "description": "Filters for products with a 90-day percentage Buy Box shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_BUY_BOX_SHIPPING_gte": { "description": "Filters for products with a 90-day percentage Buy Box shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_USED_NEW_SHIPPING_lte": { "description": "Filters for products with a 90-day percentage used 'like new' shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_USED_NEW_SHIPPING_gte": { "description": "Filters for products with a 90-day percentage used 'like new' shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_USED_VERY_GOOD_SHIPPING_lte": { "description": "Filters for products with a 90-day percentage used 'very good' shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_USED_VERY_GOOD_SHIPPING_gte": { "description": "Filters for products with a 90-day percentage used 'very good' shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_USED_GOOD_SHIPPING_lte": { "description": "Filters for products with a 90-day percentage used 'good' shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_USED_GOOD_SHIPPING_gte": { "description": "Filters for products with a 90-day percentage used 'good' shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_USED_ACCEPTABLE_SHIPPING_lte": { "description": "Filters for products with a 90-day percentage used 'acceptable' shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_USED_ACCEPTABLE_SHIPPING_gte": { "description": "Filters for products with a 90-day percentage used 'acceptable' shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_REFURBISHED_SHIPPING_lte": { "description": "Filters for products with a 90-day percentage refurbished shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_REFURBISHED_SHIPPING_gte": { "description": "Filters for products with a 90-day percentage refurbished shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_TRADE_IN_lte": { "description": "Filters for products with a 90-day percentage trade-in value change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent90_TRADE_IN_gte": { "description": "Filters for products with a 90-day percentage trade-in value change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_AMAZON_lte": { "description": "Filters for products with a 30-day percentage price change for the Amazon offer less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_AMAZON_gte": { "description": "Filters for products with a 30-day percentage price change for the Amazon offer greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_NEW_lte": { "description": "Filters for products with a 30-day percentage price change for the new price less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_NEW_gte": { "description": "Filters for products with a 30-day percentage price change for the new price greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_USED_lte": { "description": "Filters for products with a 30-day percentage price change for the used price less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_USED_gte": { "description": "Filters for products with a 30-day percentage price change for the used price greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_SALES_lte": { "description": "Filters for products with a 30-day percentage sales rank change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_SALES_gte": { "description": "Filters for products with a 30-day percentage sales rank change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_LISTPRICE_lte": { "description": "Filters for products with a 30-day percentage list price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_LISTPRICE_gte": { "description": "Filters for products with a 30-day percentage list price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COLLECTIBLE_lte": { "description": "Filters for products with a 30-day percentage collectible price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COLLECTIBLE_gte": { "description": "Filters for products with a 30-day percentage collectible price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_REFURBISHED_lte": { "description": "Filters for products with a 30-day percentage refurbished price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_REFURBISHED_gte": { "description": "Filters for products with a 30-day percentage refurbished price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_NEW_FBM_SHIPPING_lte": { "description": "Filters for products with a 30-day percentage new FBM shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_NEW_FBM_SHIPPING_gte": { "description": "Filters for products with a 30-day percentage new FBM shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_LIGHTNING_DEAL_lte": { "description": "Filters for products with a 30-day percentage lightning deal price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_LIGHTNING_DEAL_gte": { "description": "Filters for products with a 30-day percentage lightning deal price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_WAREHOUSE_lte": { "description": "Filters for products with a 30-day percentage warehouse price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_WAREHOUSE_gte": { "description": "Filters for products with a 30-day percentage warehouse price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_NEW_FBA_lte": { "description": "Filters for products with a 30-day percentage new FBA price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_NEW_FBA_gte": { "description": "Filters for products with a 30-day percentage new FBA price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COUNT_NEW_lte": { "description": "Filters for products with a 30-day percentage count of new offers change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COUNT_NEW_gte": { "description": "Filters for products with a 30-day percentage count of new offers change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COUNT_USED_lte": { "description": "Filters for products with a 30-day percentage count of used offers change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COUNT_USED_gte": { "description": "Filters for products with a 30-day percentage count of used offers change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COUNT_REFURBISHED_lte": { "description": "Filters for products with a 30-day percentage count of refurbished offers change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COUNT_REFURBISHED_gte": { "description": "Filters for products with a 30-day percentage count of refurbished offers change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COUNT_COLLECTIBLE_lte": { "description": "Filters for products with a 30-day percentage count of collectible offers change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COUNT_COLLECTIBLE_gte": { "description": "Filters for products with a 30-day percentage count of collectible offers change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_RATING_lte": { "description": "Filters for products with a 30-day percentage rating change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_RATING_gte": { "description": "Filters for products with a 30-day percentage rating change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COUNT_REVIEWS_lte": { "description": "Filters for products with a 30-day percentage review count change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_COUNT_REVIEWS_gte": { "description": "Filters for products with a 30-day percentage review count change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_BUY_BOX_SHIPPING_lte": { "description": "Filters for products with a 30-day percentage Buy Box shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_BUY_BOX_SHIPPING_gte": { "description": "Filters for products with a 30-day percentage Buy Box shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_USED_NED_SHIPPING_lte": { "description": "Filters for products with a 30-day percentage used 'like new' shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_USED_NEW_SHIPPING_gte": { "description": "Filters for products with a 30-day percentage used 'like new' shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_USED_VERY_GOOD_SHIPPING_lte": { "description": "Filters for products with a 30-day percentage used 'very good' shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_USED_VERY_GOOD_SHIPPING_gte": { "description": "Filters for products with a 30-day percentage used 'very good' shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_USED_GOOD_SHIPPING_lte": { "description": "Filters for products with a 30-day percentage used 'good' shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_USED_GOOD_SHIPPING_gte": { "description": "Filters for products with a 30-day percentage used 'good' shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_USED_ACCEPTABLE_SHIPPING_lte": { "description": "Filters for products with a 30-day percentage used 'acceptable' shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_USED_ACCEPTABLE_SHIPPING_gte": { "description": "Filters for products with a 30-day percentage used 'acceptable' shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_REFURBISHED_SHIPPING_lte": { "description": "Filters for products with a 30-day percentage refurbished shipping price change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_REFURBISHED_SHIPPING_gte": { "description": "Filters for products with a 30-day percentage refurbished shipping price change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_TRADE_IN_lte": { "description": "Filters for products with a 30-day percentage trade-in value change less than or equal to the specified value.", "type": "integer", "example": null }, "deltaPercent30_TRADE_IN_gte": { "description": "Filters for products with a 30-day percentage trade-in value change greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_AMAZON_lte": { "description": "Filters for products with an absolute price difference (current minus previous) for the Amazon offer less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_AMAZON_gte": { "description": "Filters for products with an absolute price difference (current minus previous) for the Amazon offer greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_NEW_lte": { "description": "Filters for products with an absolute price difference (current minus previous) for the new price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_NEW_gte": { "description": "Filters for products with an absolute price difference (current minus previous) for the new price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_USED_lte": { "description": "Filters for products with an absolute price difference (current minus previous) for the used price less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_USED_gte": { "description": "Filters for products with an absolute price difference (current minus previous) for the used price greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_SALES_lte": { "description": "Filters for products with an absolute sales rank difference (current minus previous) less than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_SALES_gte": { "description": "Filters for products with an absolute sales rank difference (current minus previous) greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_LISTPRICE_lte": { "description": "Filters for products with an absolute list price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_LISTPRICE_gte": { "description": "Filters for products with an absolute list price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_COLLECTIBLE_lte": { "description": "Filters for products with an absolute collectible price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_COLLECTIBLE_gte": { "description": "Filters for products with an absolute collectible price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_REFURBISHED_lte": { "description": "Filters for products with an absolute refurbished price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_REFURBISHED_gte": { "description": "Filters for products with an absolute refurbished price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_NEW_FBM_SHIPPING_lte": { "description": "Filters for products with an absolute new FBM shipping price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_NEW_FBM_SHIPPING_gte": { "description": "Filters for products with an absolute new FBM shipping price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_LIGHTNING_DEAL_lte": { "description": "Filters for products with an absolute lightning deal price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_LIGHTNING_DEAL_gte": { "description": "Filters for products with an absolute lightning deal price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_WAREHOUSE_lte": { "description": "Filters for products with an absolute warehouse price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_WAREHOUSE_gte": { "description": "Filters for products with an absolute warehouse price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_NEW_FBA_lte": { "description": "Filters for products with an absolute new FBA price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_NEW_FBA_gte": { "description": "Filters for products with an absolute new FBA price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_COUNT_NEW_lte": { "description": "Filters for products with an absolute count of new offers difference (current minus previous) less than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_COUNT_NEW_gte": { "description": "Filters for products with an absolute count of new offers difference (current minus previous) greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_COUNT_USED_lte": { "description": "Filters for products with an absolute count of used offers difference (current minus previous) less than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_COUNT_USED_gte": { "description": "Filters for products with an absolute count of used offers difference (current minus previous) greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_COUNT_REFURBISHED_lte": { "description": "Filters for products with an absolute count of refurbished offers difference (current minus previous) less than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_COUNT_REFURBISHED_gte": { "description": "Filters for products with an absolute count of refurbished offers difference (current minus previous) greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_COUNT_COLLECTIBLE_lte": { "description": "Filters for products with an absolute count of collectible offers difference (current minus previous) less than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_COUNT_COLLECTIBLE_gte": { "description": "Filters for products with an absolute count of collectible offers difference (current minus previous) greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_RATING_lte": { "description": "Filters for products with an absolute rating difference (current minus previous) less than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_RATING_gte": { "description": "Filters for products with an absolute rating difference (current minus previous) greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_COUNT_REVIEWS_lte": { "description": "Filters for products with an absolute review count difference (current minus previous) less than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_COUNT_REVIEWS_gte": { "description": "Filters for products with an absolute review count difference (current minus previous) greater than or equal to the specified value.", "type": "integer", "example": null }, "deltaLast_BUY_BOX_SHIPPING_lte": { "description": "Filters for products with an absolute Buy Box shipping price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_BUY_BOX_SHIPPING_gte": { "description": "Filters for products with an absolute Buy Box shipping price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_USED_NEW_SHIPPING_lte": { "description": "Filters for products with an absolute used 'like new' shipping price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_USED_NEW_SHIPPING_gte": { "description": "Filters for products with an absolute used 'like new' shipping price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_USED_VERY_GOOD_SHIPPING_lte": { "description": "Filters for products with an absolute used 'very good' shipping price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_USED_VERY_GOOD_SHIPPING_gte": { "description": "Filters for products with an absolute used 'very good' shipping price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_USED_GOOD_SHIPPING_lte": { "description": "Filters for products with an absolute used 'good' shipping price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_USED_GOOD_SHIPPING_gte": { "description": "Filters for products with an absolute used 'good' shipping price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_USED_ACCEPTABLE_SHIPPING_lte": { "description": "Filters for products with an absolute used 'acceptable' shipping price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_USED_ACCEPTABLE_SHIPPING_gte": { "description": "Filters for products with an absolute used 'acceptable' shipping price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_REFURBISHED_SHIPPING_lte": { "description": "Filters for products with an absolute refurbished shipping price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_REFURBISHED_SHIPPING_gte": { "description": "Filters for products with an absolute refurbished shipping price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_EBAY_NEW_SHIPPING_lte": { "description": "Filters for products with an absolute eBay new shipping price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_EBAY_NEW_SHIPPING_gte": { "description": "Filters for products with an absolute eBay new shipping price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_EBAY_USED_SHIPPING_lte": { "description": "Filters for products with an absolute eBay used shipping price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_EBAY_USED_SHIPPING_gte": { "description": "Filters for products with an absolute eBay used shipping price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_TRADE_IN_lte": { "description": "Filters for products with an absolute trade-in value difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_TRADE_IN_gte": { "description": "Filters for products with an absolute trade-in value difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_RENT_lte": { "description": "Filters for products with an absolute rental price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_RENT_gte": { "description": "Filters for products with an absolute rental price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_BUY_BOX_USED_SHIPPING_lte": { "description": "Filters for products with an absolute used Buy Box shipping price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_BUY_BOX_USED_SHIPPING_gte": { "description": "Filters for products with an absolute used Buy Box shipping price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_PRIME_EXCL_lte": { "description": "Filters for products with an absolute Prime exclusive price difference (current minus previous) less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "deltaLast_PRIME_EXCL_gte": { "description": "Filters for products with an absolute Prime exclusive price difference (current minus previous) greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_AMAZON_lte": { "description": "Filters for products with an average Amazon price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_AMAZON_gte": { "description": "Filters for products with an average Amazon price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_NEW_lte": { "description": "Filters for products with an average new price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_NEW_gte": { "description": "Filters for products with an average new price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_USED_lte": { "description": "Filters for products with an average used price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_USED_gte": { "description": "Filters for products with an average used price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_SALES_lte": { "description": "Filters for products with an average sales rank over the last 180 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg180_SALES_gte": { "description": "Filters for products with an average sales rank over the last 180 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg180_LISTPRICE_lte": { "description": "Filters for products with an average list price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_LISTPRICE_gte": { "description": "Filters for products with an average list price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_COLLECTIBLE_lte": { "description": "Filters for products with an average collectible price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_COLLECTIBLE_gte": { "description": "Filters for products with an average collectible price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_REFURBISHED_lte": { "description": "Filters for products with an average refurbished price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_REFURBISHED_gte": { "description": "Filters for products with an average refurbished price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_NEW_FBM_SHIPPING_lte": { "description": "Filters for products with an average new FBM shipping price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_NEW_FBM_SHIPPING_gte": { "description": "Filters for products with an average new FBM shipping price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_LIGHTNING_DEAL_lte": { "description": "Filters for products with an average lightning deal price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_LIGHTNING_DEAL_gte": { "description": "Filters for products with an average lightning deal price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_WAREHOUSE_lte": { "description": "Filters for products with an average warehouse price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_WAREHOUSE_gte": { "description": "Filters for products with an average warehouse price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_NEW_FBA_lte": { "description": "Filters for products with an average new FBA price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_NEW_FBA_gte": { "description": "Filters for products with an average new FBA price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_COUNT_NEW_lte": { "description": "Filters for products with an average count of new offers over the last 180 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg180_COUNT_NEW_gte": { "description": "Filters for products with an average count of new offers over the last 180 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg180_COUNT_USED_lte": { "description": "Filters for products with an average count of used offers over the last 180 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg180_COUNT_USED_gte": { "description": "Filters for products with an average count of used offers over the last 180 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg180_COUNT_REFURBISHED_lte": { "description": "Filters for products with an average count of refurbished offers over the last 180 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg180_COUNT_REFURBISHED_gte": { "description": "Filters for products with an average count of refurbished offers over the last 180 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg180_COUNT_COLLECTIBLE_lte": { "description": "Filters for products with an average count of collectible offers over the last 180 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg180_COUNT_COLLECTIBLE_gte": { "description": "Filters for products with an average count of collectible offers over the last 180 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg180_RATING_lte": { "description": "Filters for products with an average rating over the last 180 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg180_RATING_gte": { "description": "Filters for products with an average rating over the last 180 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg180_COUNT_REVIEWS_lte": { "description": "Filters for products with an average review count over the last 180 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg180_COUNT_REVIEWS_gte": { "description": "Filters for products with an average review count over the last 180 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg180_BUY_BOX_SHIPPING_lte": { "description": "Filters for products with an average Buy Box shipping price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_BUY_BOX_SHIPPING_gte": { "description": "Filters for products with an average Buy Box shipping price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_USED_NEW_SHIPPING_lte": { "description": "Filters for products with an average used 'like new' shipping price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_USED_NEW_SHIPPING_gte": { "description": "Filters for products with an average used 'like new' shipping price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_USED_VERY_GOOD_SHIPPING_lte": { "description": "Filters for products with an average used 'very good' shipping price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_USED_VERY_GOOD_SHIPPING_gte": { "description": "Filters for products with an average used 'very good' shipping price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_USED_GOOD_SHIPPING_lte": { "description": "Filters for products with an average used 'good' shipping price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_USED_GOOD_SHIPPING_gte": { "description": "Filters for products with an average used 'good' shipping price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_USED_ACCEPTABLE_SHIPPING_lte": { "description": "Filters for products with an average used 'acceptable' shipping price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_USED_ACCEPTABLE_SHIPPING_gte": { "description": "Filters for products with an average used 'acceptable' shipping price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_REFURBISHED_SHIPPING_lte": { "description": "Filters for products with an average refurbished shipping price over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_REFURBISHED_SHIPPING_gte": { "description": "Filters for products with an average refurbished shipping price over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_TRADE_IN_lte": { "description": "Filters for products with an average trade-in value over the last 180 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg180_TRADE_IN_gte": { "description": "Filters for products with an average trade-in value over the last 180 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_AMAZON_lte": { "description": "Filters for products with an average Amazon price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_AMAZON_gte": { "description": "Filters for products with an average Amazon price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_NEW_lte": { "description": "Filters for products with an average new price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_NEW_gte": { "description": "Filters for products with an average new price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_USED_lte": { "description": "Filters for products with an average used price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_USED_gte": { "description": "Filters for products with an average used price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_SALES_lte": { "description": "Filters for products with an average sales rank over the last 90 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg90_SALES_gte": { "description": "Filters for products with an average sales rank over the last 90 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg90_LISTPRICE_lte": { "description": "Filters for products with an average list price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_LISTPRICE_gte": { "description": "Filters for products with an average list price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_COLLECTIBLE_lte": { "description": "Filters for products with an average collectible price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_COLLECTIBLE_gte": { "description": "Filters for products with an average collectible price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_REFURBISHED_lte": { "description": "Filters for products with an average refurbished price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_REFURBISHED_gte": { "description": "Filters for products with an average refurbished price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_NEW_FBM_SHIPPING_lte": { "description": "Filters for products with an average new FBM shipping price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_NED_FBM_SHIPPING_gte": { "description": "Filters for products with an average new FBM shipping price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_LIGHTNING_DEAL_lte": { "description": "Filters for products with an average lightning deal price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_LIGHTNING_DEAL_gte": { "description": "Filters for products with an average lightning deal price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_WAREHOUSE_lte": { "description": "Filters for products with an average warehouse price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_WAREHOUSE_gte": { "description": "Filters for products with an average warehouse price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_NEW_FBA_lte": { "description": "Filters for products with an average new FBA price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_NEW_FBA_gte": { "description": "Filters for products with an average new FBA price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_COUNT_NEW_lte": { "description": "Filters for products with an average count of new offers over the last 90 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg90_COUNT_NEW_gte": { "description": "Filters for products with an average count of new offers over the last 90 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg90_COUNT_USED_lte": { "description": "Filters for products with an average count of used offers over the last 90 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg90_COUNT_USED_gte": { "description": "Filters for products with an average count of used offers over the last 90 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg90_COUNT_REFURBISHED_lte": { "description": "Filters for products with an average count of refurbished offers over the last 90 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg90_COUNT_REFURBISHED_gte": { "description": "Filters for products with an average count of refurbished offers over the last 90 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg90_COUNT_COLLECTIBLE_lte": { "description": "Filters for products with an average count of collectible offers over the last 90 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg90_COUNT_COLLECTIBLE_gte": { "description": "Filters for products with an average count of collectible offers over the last 90 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg90_RATING_lte": { "description": "Filters for products with an average rating over the last 90 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg90_RATING_gte": { "description": "Filters for products with an average rating over the last 90 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg90_COUNT_REVIEWS_lte": { "description": "Filters for products with an average review count over the last 90 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg90_COUNT_REVIEWS_gte": { "description": "Filters for products with an average review count over the last 90 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg90_BUY_BOX_SHIPPING_lte": { "description": "Filters for products with an average Buy Box shipping price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_BUY_BOX_SHIPPING_gte": { "description": "Filters for products with an average Buy Box shipping price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_USED_NEW_SHIPPING_lte": { "description": "Filters for products with an average used 'like new' shipping price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_USED_NEW_SHIPPING_gte": { "description": "Filters for products with an average used 'like new' shipping price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_USED_VERY_GOOD_SHIPPING_lte": { "description": "Filters for products with an average used 'very good' shipping price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_USED_VERY_GOOD_SHIPPING_gte": { "description": "Filters for products with an average used 'very good' shipping price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_USED_GOOD_SHIPPING_lte": { "description": "Filters for products with an average used 'good' shipping price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_USED_GOOD_SHIPPING_gte": { "description": "Filters for products with an average used 'good' shipping price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_USED_ACCEPTABLE_SHIPPING_lte": { "description": "Filters for products with an average used 'acceptable' shipping price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_USED_ACCEPTABLE_SHIPPING_gte": { "description": "Filters for products with an average used 'acceptable' shipping price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_REFURBISHED_SHIPPING_lte": { "description": "Filters for products with an average refurbished shipping price over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_REFURBISHED_SHIPPING_gte": { "description": "Filters for products with an average refurbished shipping price over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_TRADE_IN_lte": { "description": "Filters for products with an average trade-in value over the last 90 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg90_TRADE_IN_gte": { "description": "Filters for products with an average trade-in value over the last 90 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_AMAZON_lte": { "description": "Filters for products with an average Amazon price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_AMAZON_gte": { "description": "Filters for products with an average Amazon price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_NEW_lte": { "description": "Filters for products with an average new price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_NEW_gte": { "description": "Filters for products with an average new price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_USED_lte": { "description": "Filters for products with an average used price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_USED_gte": { "description": "Filters for products with an average used price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_SALES_lte": { "description": "Filters for products with an average sales rank over the last 30 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg30_SALES_gte": { "description": "Filters for products with an average sales rank over the last 30 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg30_LISTPRICE_lte": { "description": "Filters for products with an average list price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_LISTPRICE_gte": { "description": "Filters for products with an average list price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_COLLECTIBLE_lte": { "description": "Filters for products with an average collectible price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_COLLECTIBLE_gte": { "description": "Filters for products with an average collectible price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_REFURBISHED_lte": { "description": "Filters for products with an average refurbished price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_REFURBISHED_gte": { "description": "Filters for products with an average refurbished price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_NEW_FBM_SHIPPING_lte": { "description": "Filters for products with an average new FBM shipping price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_NEW_FBM_SHIPPING_gte": { "description": "Filters for products with an average new FBM shipping price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_LIGHTNING_DEAL_lte": { "description": "Filters for products with an average lightning deal price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_LIGHTNING_DEAL_gte": { "description": "Filters for products with an average lightning deal price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_WAREHOUSE_lte": { "description": "Filters for products with an average warehouse price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_WAREHOUSE_gte": { "description": "Filters for products with an average warehouse price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_NEW_FBA_lte": { "description": "Filters for products with an average new FBA price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_NEW_FBA_gte": { "description": "Filters for products with an average new FBA price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_COUNT_NEW_lte": { "description": "Filters for products with an average count of new offers over the last 30 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg30_COUNT_NEW_gte": { "description": "Filters for products with an average count of new offers over the last 30 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg30_COUNT_USED_lte": { "description": "Filters for products with an average count of used offers over the last 30 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg30_COUNT_USED_gte": { "description": "Filters for products with an average count of used offers over the last 30 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg30_COUNT_REFURBISHED_lte": { "description": "Filters for products with an average count of refurbished offers over the last 30 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg30_COUNT_REFURBISHED_gte": { "description": "Filters for products with an average count of refurbished offers over the last 30 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg30_COUNT_COLLECTIBLE_lte": { "description": "Filters for products with an average count of collectible offers over the last 30 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg30_COUNT_COLLECTIBLE_gte": { "description": "Filters for products with an average count of collectible offers over the last 30 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg30_RATING_lte": { "description": "Filters for products with an average rating over the last 30 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg30_RATING_gte": { "description": "Filters for products with an average rating over the last 30 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg30_COUNT_REVIEWS_lte": { "description": "Filters for products with an average review count over the last 30 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg30_COUNT_REVIEWS_gte": { "description": "Filters for products with an average review count over the last 30 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg30_BUY_BOX_SHIPPING_lte": { "description": "Filters for products with an average Buy Box shipping price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_BUY_BOX_SHIPPING_gte": { "description": "Filters for products with an average Buy Box shipping price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_USED_NEW_SHIPPING_lte": { "description": "Filters for products with an average used 'like new' shipping price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_USED_NEW_SHIPPING_gte": { "description": "Filters for products with an average used 'like new' shipping price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_USED_VERY_GOOD_SHIPPING_lte": { "description": "Filters for products with an average used 'very good' shipping price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_USED_VERY_GOOD_SHIPPING_gte": { "description": "Filters for products with an average used 'very good' shipping price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_USED_GOOD_SHIPPING_lte": { "description": "Filters for products with an average used 'good' shipping price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_USED_GOOD_SHIPPING_gte": { "description": "Filters for products with an average used 'good' shipping price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_USED_ACCEPTABLE_SHIPPING_lte": { "description": "Filters for products with an average used 'acceptable' shipping price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_USED_ACCEPTABLE_SHIPPING_gte": { "description": "Filters for products with an average used 'acceptable' shipping price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_REFURBISHED_SHIPPING_lte": { "description": "Filters for products with an average refurbished shipping price over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_REFURBISHED_SHIPPING_gte": { "description": "Filters for products with an average refurbished shipping price over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_TRADE_IN_lte": { "description": "Filters for products with an average trade-in value over the last 30 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg30_TRADE_IN_gte": { "description": "Filters for products with an average trade-in value over the last 30 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_AMAZON_lte": { "description": "Filters for products with an average Amazon price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_AMAZON_gte": { "description": "Filters for products with an average Amazon price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_BUY_BOX_SHIPPING_lte": { "description": "Filters for products with an average Buy Box shipping price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_BUY_BOX_SHIPPING_gte": { "description": "Filters for products with an average Buy Box shipping price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_BUY_BOX_USED_SHIPPING_lte": { "description": "Filters for products with an average used Buy Box shipping price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_BUY_BOX_USED_SHIPPING_gte": { "description": "Filters for products with an average used Buy Box shipping price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_COLLECTIBLE_lte": { "description": "Filters for products with an average collectible price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_COLLECTIBLE_gte": { "description": "Filters for products with an average collectible price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_COUNT_COLLECTIBLE_lte": { "description": "Filters for products with an average count of collectible offers over the last 365 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg365_COUNT_COLLECTIBLE_gte": { "description": "Filters for products with an average count of collectible offers over the last 365 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg365_COUNT_NED_lte": { "description": "Filters for products with an average count of new offers over the last 365 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg365_COUNT_NEW_gte": { "description": "Filters for products with an average count of new offers over the last 365 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg365_COUNT_REFURBISHED_lte": { "description": "Filters for products with an average count of refurbished offers over the last 365 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg365_COUNT_REFURBISHED_gte": { "description": "Filters for products with an average count of refurbished offers over the last 365 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg365_COUNT_REVIEWS_lte": { "description": "Filters for products with an average review count over the last 365 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg365_COUNT_REVIEWS_gte": { "description": "Filters for products with an average review count over the last 365 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg365_COUNT_USED_lte": { "description": "Filters for products with an average count of used offers over the last 365 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg365_COUNT_USED_gte": { "description": "Filters for products with an average count of used offers over the last 365 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg365_EBAY_NEW_SHIPPING_lte": { "description": "Filters for products with an average eBay new shipping price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_EBAY_NEW_SHIPPING_gte": { "description": "Filters for products with an average eBay new shipping price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_EBAY_USED_SHIPPING_lte": { "description": "Filters for products with an average eBay used shipping price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_EBAY_USED_SHIPPING_gte": { "description": "Filters for products with an average eBay used shipping price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_LIGHTNING_DEAL_lte": { "description": "Filters for products with an average lightning deal price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_LIGHTNING_DEAL_gte": { "description": "Filters for products with an average lightning deal price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_LISTPRICE_lte": { "description": "Filters for products with an average list price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_LISTPRICE_gte": { "description": "Filters for products with an average list price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_NEW_lte": { "description": "Filters for products with an average new price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_NEW_gte": { "description": "Filters for products with an average new price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_NEW_FBA_lte": { "description": "Filters for products with an average new FBA price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_NEW_FBA_gte": { "description": "Filters for products with an average new FBA price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_NEW_FBM_SHIPPING_lte": { "description": "Filters for products with an average new FBM shipping price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_NEW_FBM_SHIPPING_gte": { "description": "Filters for products with an average new FBM shipping price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_PRIME_EXCL_lte": { "description": "Filters for products with an average Prime exclusive price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_PRIME_EXCL_gte": { "description": "Filters for products with an average Prime exclusive price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_RATING_lte": { "description": "Filters for products with an average rating over the last 365 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg365_RATING_gte": { "description": "Filters for products with an average rating over the last 365 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg365_REFURBISHED_lte": { "description": "Filters for products with an average refurbished price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_REFURBISHED_gte": { "description": "Filters for products with an average refurbished price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_REFURBISHED_SHIPPING_lte": { "description": "Filters for products with an average refurbished shipping price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_REFURBISHED_SHIPPING_gte": { "description": "Filters for products with an average refurbished shipping price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_RENT_lte": { "description": "Filters for products with an average rental price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_RENT_gte": { "description": "Filters for products with an average rental price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_SALES_lte": { "description": "Filters for products with an average sales rank over the last 365 days less than or equal to the specified value.", "type": "integer", "example": null }, "avg365_SALES_gte": { "description": "Filters for products with an average sales rank over the last 365 days greater than or equal to the specified value.", "type": "integer", "example": null }, "avg365_TRADE_IN_lte": { "description": "Filters for products with an average trade-in value over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_TRADE_IN_gte": { "description": "Filters for products with an average trade-in value over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_USED_lte": { "description": "Filters for products with an average used price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_USED_gte": { "description": "Filters for products with an average used price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_USED_ACCEPTABLE_SHIPPING_lte": { "description": "Filters for products with an average used 'acceptable' shipping price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_USED_ACCEPTABLE_SHIPPING_gte": { "description": "Filters for products with an average used 'acceptable' shipping price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_USED_GOOD_SHIPPING_lte": { "description": "Filters for products with an average used 'good' shipping price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_USED_GOOD_SHIPPING_gte": { "description": "Filters for products with an average used 'good' shipping price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_USED_NEW_SHIPPING_lte": { "description": "Filters for products with an average used 'like new' shipping price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_USED_NEW_SHIPPING_gte": { "description": "Filters for products with an average used 'like new' shipping price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_USED_VERY_GOOD_SHIPPING_lte": { "description": "Filters for products with an average used 'very good' shipping price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_USED_VERY_GOOD_SHIPPING_gte": { "description": "Filters for products with an average used 'very good' shipping price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_WAREHOUSE_lte": { "description": "Filters for products with an average warehouse price over the last 365 days less than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "avg365_WAREHOUSE_gte": { "description": "Filters for products with an average warehouse price over the last 365 days greater than or equal to the specified value in the smallest currency unit (e.g., cents).", "type": "integer", "example": null }, "lastPriceChange_AMAZON_lte": { "description": "Filters for products with an Amazon price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_AMAZON_gte": { "description": "Filters for products with an Amazon price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_NEW_lte": { "description": "Filters for products with a new price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_NEW_gte": { "description": "Filters for products with a new price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_USED_lte": { "description": "Filters for products with a used price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_USED_gte": { "description": "Filters for products with a used price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_SALES_lte": { "description": "Filters for products with a sales rank that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_SALES_gte": { "description": "Filters for products with a sales rank that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_LISTPRICE_lte": { "description": "Filters for products with a list price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_LISTPRICE_gte": { "description": "Filters for products with a list price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COLLECTIBLE_lte": { "description": "Filters for products with a collectible price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COLLECTIBLE_gte": { "description": "Filters for products with a collectible price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_REFURBISHED_lte": { "description": "Filters for products with a refurbished price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_REFURBISHED_gte": { "description": "Filters for products with a refurbished price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_NEW_FBM_SHIPPING_lte": { "description": "Filters for products with a new FBM shipping price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_NEW_FBM_SHIPPING_gte": { "description": "Filters for products with a new FBM shipping price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_LIGHTNING_DEAL_lte": { "description": "Filters for products with a lightning deal price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_LIGHTNING_DEAL_gte": { "description": "Filters for products with a lightning deal price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_WAREHOUSE_lte": { "description": "Filters for products with a warehouse price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_WAREHOUSE_gte": { "description": "Filters for products with a warehouse price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_NEW_FBA_lte": { "description": "Filters for products with a new FBA price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_NEW_FBA_gte": { "description": "Filters for products with a new FBA price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COUNT_NEW_lte": { "description": "Filters for products with a count of new offers that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COUNT_NEW_gte": { "description": "Filters for products with a count of new offers that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COUNT_USED_lte": { "description": "Filters for products with a count of used offers that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COUNT_USED_gte": { "description": "Filters for products with a count of used offers that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COUNT_REFURBISHED_lte": { "description": "Filters for products with a count of refurbished offers that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COUNT_REFURBISHED_gte": { "description": "Filters for products with a count of refurbished offers that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COUNT_COLLECTIBLE_lte": { "description": "Filters for products with a count of collectible offers that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COUNT_COLLECTIBLE_gte": { "description": "Filters for products with a count of collectible offers that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_RATING_lte": { "description": "Filters for products with a rating that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_RATING_gte": { "description": "Filters for products with a rating that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COUNT_REVIEWS_lte": { "description": "Filters for products with a review count that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_COUNT_REVIEWS_gte": { "description": "Filters for products with a review count that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_BUY_BOX_SHIPPING_lte": { "description": "Filters for products with a Buy Box shipping price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_BUY_BOX_SHIPPING_gte": { "description": "Filters for products with a Buy Box shipping price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_USED_NEW_SHIPPING_lte": { "description": "Filters for products with a used 'like new' shipping price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_USED_NEW_SHIPPING_gte": { "description": "Filters for products with a used 'like new' shipping price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_USED_VERY_GOOD_SHIPPING_lte": { "description": "Filters for products with a used 'very good' shipping price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_USED_VERY_GOOD_SHIPPING_gte": { "description": "Filters for products with a used 'very good' shipping price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_USED_GOOD_SHIPPING_lte": { "description": "Filters for products with a used 'good' shipping price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_USED_GOOD_SHIPPING_gte": { "description": "Filters for products with a used 'good' shipping price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_USED_ACCEPTABLE_SHIPPING_lte": { "description": "Filters for products with a used 'acceptable' shipping price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_USED_ACCEPTABLE_SHIPPING_gte": { "description": "Filters for products with a used 'acceptable' shipping price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_REFURBISHED_SHIPPING_lte": { "description": "Filters for products with a refurbished shipping price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_REFURBISHED_SHIPPING_gte": { "description": "Filters for products with a refurbished shipping price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_EBAY_NEW_SHIPPING_lte": { "description": "Filters for products with an eBay new shipping price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_EBAY_NEW_SHIPPING_gte": { "description": "Filters for products with an eBay new shipping price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_EBAY_USED_SHIPPING_lte": { "description": "Filters for products with an eBay used shipping price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_EBAY_USED_SHIPPING_gte": { "description": "Filters for products with an eBay used shipping price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_TRADE_IN_lte": { "description": "Filters for products with a trade-in value that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_TRADE_IN_gte": { "description": "Filters for products with a trade-in value that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_RENT_lte": { "description": "Filters for products with a rental price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_RENT_gte": { "description": "Filters for products with a rental price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_BUY_BOX_USED_SHIPPING_lte": { "description": "Filters for products with a used Buy Box shipping price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_BUY_BOX_USED_SHIPPING_gte": { "description": "Filters for products with a used Buy Box shipping price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_PRIME_EXCL_lte": { "description": "Filters for products with a Prime exclusive price that had a price change less than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "lastPriceChange_PRIME_EXCL_gte": { "description": "Filters for products with a Prime exclusive price that had a price change greater than or equal to the specified Keepa Time minutes ago.", "type": "integer", "example": null }, "backInStock_AMAZON": { "description": "A boolean indicating if the Amazon offer was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_NEW": { "description": "A boolean indicating if the new price offer was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_USED": { "description": "A boolean indicating if the used price offer was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_SALES": { "description": "A boolean indicating if the sales rank was 'out of stock' (had no value) in the last 60 days and now has a value again.", "type": "boolean", "example": null }, "backInStock_LISTPRICE": { "description": "A boolean indicating if the list price was 'out of stock' (had no value) in the last 60 days and now has a value again.", "type": "boolean", "example": null }, "backInStock_COLLECTIBLE": { "description": "A boolean indicating if the collectible price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_REFURBISHED": { "description": "A boolean indicating if the refurbished price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_NEW_FBM_SHIPPING": { "description": "A boolean indicating if the new FBM shipping price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_LIGHTNING_DEAL": { "description": "A boolean indicating if the lightning deal price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_WAREHOUSE": { "description": "A boolean indicating if the warehouse price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_NEW_FBA": { "description": "A boolean indicating if the new FBA price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_COUNT_NEW": { "description": "A boolean indicating if the count of new offers was 'out of stock' (had no value) in the last 60 days and now has a value again.", "type": "boolean", "example": null }, "backInStock_COUNT_USED": { "description": "A boolean indicating if the count of used offers was 'out of stock' (had no value) in the last 60 days and now has a value again.", "type": "boolean", "example": null }, "backInStock_COUNT_REFURBISHED": { "description": "A boolean indicating if the count of refurbished offers was 'out of stock' (had no value) in the last 60 days and now has a value again.", "type": "boolean", "example": null }, "backInStock_COUNT_COLLECTIBLE": { "description": "A boolean indicating if the count of collectible offers was 'out of stock' (had no value) in the last 60 days and now has a value again.", "type": "boolean", "example": null }, "backInStock_RATING": { "description": "A boolean indicating if the rating was 'out of stock' (had no value) in the last 60 days and now has a value again.", "type": "boolean", "example": null }, "backInStock_COUNT_REVIEWS": { "description": "A boolean indicating if the review count was 'out of stock' (had no value) in the last 60 days and now has a value again.", "type": "boolean", "example": null }, "backInStock_BUY_BOX_SHIPPING": { "description": "A boolean indicating if the Buy Box shipping price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_USED_NEW_SHIPPING": { "description": "A boolean indicating if the used 'like new' shipping price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_USED_VERY_GOOD_SHIPPING": { "description": "A boolean indicating if the used 'very good' shipping price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_USED_GOOD_SHIPPING": { "description": "A boolean indicating if the used 'good' shipping price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_USED_ACCEPTABLE_SHIPPING": { "description": "A boolean indicating if the used 'acceptable' shipping price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_REFURBISHED_SHIPPING": { "description": "A boolean indicating if the refurbished shipping price was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "backInStock_TRADE_IN": { "description": "A boolean indicating if the trade-in value was out of stock in the last 60 days and is now back in stock.", "type": "boolean", "example": null }, "isLowest_AMAZON": { "description": "A boolean indicating if the current Amazon price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_BUY_BOX_SHIPPING": { "description": "A boolean indicating if the current Buy Box shipping price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_BUY_BOX_USED_SHIPPING": { "description": "A boolean indicating if the current used Buy Box shipping price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_COLLECTIBLE": { "description": "A boolean indicating if the current collectible price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_COUNT_COLLECTIBLE": { "description": "A boolean indicating if the current count of collectible offers is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_COUNT_NEW": { "description": "A boolean indicating if the current count of new offers is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_COUNT_REFURBISHED": { "description": "A boolean indicating if the current count of refurbished offers is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_COUNT_REVIEWS": { "description": "A boolean indicating if the current review count is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_COUNT_USED": { "description": "A boolean indicating if the current count of used offers is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_EBAY_NED_SHIPPING": { "description": "A boolean indicating if the current eBay new shipping price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_EBAY_USED_SHIPPING": { "description": "A boolean indicating if the current eBay used shipping price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_LIGHTNING_DEAL": { "description": "A boolean indicating if the current lightning deal price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_LISTPRICE": { "description": "A boolean indicating if the current list price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_NEW": { "description": "A boolean indicating if the current new price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_NEW_FBA": { "description": "A boolean indicating if the current new FBA price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_NEW_FBM_SHIPPING": { "description": "A boolean indicating if the current new FBM shipping price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_PRIME_EXCL": { "description": "A boolean indicating if the current Prime exclusive price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_RATING": { "description": "A boolean indicating if the current rating is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_REFURBISHED": { "description": "A boolean indicating if the current refurbished price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_REFURBISHED_SHIPPING": { "description": "A boolean indicating if the current refurbished shipping price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_RENT": { "description": "A boolean indicating if the current rental price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_SALES": { "description": "A boolean indicating if the current sales rank is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_TRADE_IN": { "description": "A boolean indicating if the current trade-in value is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_USED": { "description": "A boolean indicating if the current used price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_USED_ACCEPTABLE_SHIPPING": { "description": "A boolean indicating if the current used 'acceptable' shipping price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_USED_GOOD_SHIPPING": { "description": "A boolean indicating if the current used 'good' shipping price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_USED_NEW_SHIPPING": { "description": "A boolean indicating if the current used 'like new' shipping price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_USED_VERY_GOOD_SHIPPING": { "description": "A boolean indicating if the current used 'very good' shipping price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest_WAREHOUSE": { "description": "A boolean indicating if the current warehouse price is the lowest ever recorded.", "type": "boolean", "example": null }, "isLowest90_AMAZON": { "description": "A boolean indicating if the current Amazon price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_BUY_BOX_SHIPPING": { "description": "A boolean indicating if the current Buy Box shipping price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_BUY_BOX_USED_SHIPPING": { "description": "A boolean indicating if the current used Buy Box shipping price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_COLLECTIBLE": { "description": "A boolean indicating if the current collectible price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_COUNT_COLLECTIBLE": { "description": "A boolean indicating if the current count of collectible offers is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_COUNT_NEW": { "description": "A boolean indicating if the current count of new offers is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_COUNT_REFURBISHED": { "description": "A boolean indicating if the current count of refurbished offers is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_COUNT_REVIEWS": { "description": "A boolean indicating if the current review count is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_COUNT_USED": { "description": "A boolean indicating if the current count of used offers is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_EBAY_NEW_SHIPPING": { "description": "A boolean indicating if the current eBay new shipping price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_EBAY_USED_SHIPPING": { "description": "A boolean indicating if the current eBay used shipping price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_LIGHTNING_DEAL": { "description": "A boolean indicating if the current lightning deal price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_LISTPRICE": { "description": "A boolean indicating if the current list price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_NEW": { "description": "A boolean indicating if the current new price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_NEW_FBA": { "description": "A boolean indicating if the current new FBA price is the lowest in the last 90 days.", "type": "integer", "example": null }, "isLowest90_NEW_FBM_SHIPPING": { "description": "A boolean indicating if the current new FBM shipping price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_PRIME_EXCL": { "description": "A boolean indicating if the current Prime exclusive price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_RATING": { "description": "A boolean indicating if the current rating is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_REFURBISHED": { "description": "A boolean indicating if the current refurbished price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_REFURBISHED_SHIPPING": { "description": "A boolean indicating if the current refurbished shipping price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_RENT": { "description": "A boolean indicating if the current rental price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_SALES": { "description": "A boolean indicating if the current sales rank is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_TRADE_IN": { "description": "A boolean indicating if the current trade-in value is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_USED": { "description": "A boolean indicating if the current used price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_USED_ACCEPTABLE_SHIPPING": { "description": "A boolean indicating if the current used 'acceptable' shipping price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_USED_GOOD_SHIPPING": { "description": "A boolean indicating if the current used 'good' shipping price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_USED_NEW_SHIPPING": { "description": "A boolean indicating if the current used 'like new' shipping price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_USED_VERY_GOOD_SHIPPING": { "description": "A boolean indicating if the current used 'very good' shipping price is the lowest in the last 90 days.", "type": "boolean", "example": null }, "isLowest90_WAREHOUSE": { "description": "A boolean indicating if the current warehouse price is the lowest in the last 90 days.", "type": "boolean", "example": null } }, "type": "object" } } } }, "responses": { "200": { "description": "Query Keepa products response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryKeepaProductsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchKeepaProductsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/listings/items": { "get": { "tags": [ "Listings Items" ], "summary": "Search listings items", "description": "Search listings items with various filters and pagination support. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "searchListingsItems", "parameters": [ { "name": "identifiers", "in": "query", "description": "A comma-delimited list of product identifiers (max 20). Required when 'identifiersType' is specified. Cannot be used with 'variationParentSku' or 'packageHierarchySku'.", "required": false, "example": "Test Catan 07-11-2025 B00U26V4VQ,Surreal Entertainm 02-09-2025 B08MQTYSPT" }, { "name": "identifiersType", "in": "query", "description": "A type of product identifiers. Required when 'identifiers' is provided. Allowed values: SKU, ASIN, EAN, FNSKU, GTIN, ISBN, JAN, MINSAN, UPC.", "required": false, "example": "SKU" }, { "name": "includedData", "in": "query", "description": "A comma-delimited list of datasets to include in the response. \n'summaries' - Summary details for the listing item. \n'attributes' - A JSON object that contains structured listing item attribute data, keyed by attribute name. \n'issues' - Issues that are associated with the listing item. \n'offers' - Current offers for the listing item. \n'fulfillmentAvailability' - Fulfillment availability details for the listing item. \n'procurement' - Vendor procurement details for the listing item. \n'relationships' - Relationship details for a listing item (for example, variations). \n'productTypes' - Product types associated with a listing item. \nDefault: 'summaries'.", "required": false, "example": "summaries,attributes,issues" }, { "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.", "required": false, "example": "en_US" }, { "name": "variationParentSku", "in": "query", "description": "Filters results to variation children of the specified SKU. Cannot be used with 'identifiers' or 'packageHierarchySku'.", "required": false }, { "name": "packageHierarchySku", "in": "query", "description": "Filter results to listing items that contain or are contained by the specified SKU. Cannot be used with 'identifiers' or 'variationParentSku'.", "required": false }, { "name": "createdAfter", "in": "query", "description": "Filter items created at or after this date (ISO 8601 format).", "required": false, "example": "2025-09-01T00:00:00Z" }, { "name": "createdBefore", "in": "query", "description": "Filter items created at or before this date (ISO 8601 format).", "required": false, "example": "2025-11-01T23:59:59Z" }, { "name": "lastUpdatedAfter", "in": "query", "description": "Filter items last updated at or after this date (ISO 8601 format).", "required": false, "example": "2025-09-01T00:00:00Z" }, { "name": "lastUpdatedBefore", "in": "query", "description": "Filter items last updated at or before this date (ISO 8601 format).", "required": false, "example": "2025-11-01T23:59:59Z" }, { "name": "withIssueSeverity", "in": "query", "description": "Filter results by one or more issue severity levels. \n'ERROR' - Indicates that an issue has occurred, which prevented the submission from processing. For example, a validation error.\n'WARNING'\t- Indicates an issue has occurred that should be reviewed, but it has not prevented the submission from processing.", "required": false }, { "name": "withStatus", "in": "query", "description": "Filter results to include only listing items with the specified status.\n'BUYABLE' - The listings item that shoppers can purchase. This status does not apply to vendor listings.\n'DISCOVERABLE' - The listings item is visible to shoppers.", "required": false }, { "name": "withoutStatus", "in": "query", "description": "Filter results to exclude listing items with the specified statuses.\n'BUYABLE' - The listings item that shoppers can purchase. This status does not apply to vendor listings.\n'DISCOVERABLE' - The listings item is visible to shoppers.", "required": false }, { "name": "sortBy", "in": "query", "description": "An attribute by which to sort the returned listing items. Default: 'lastUpdatedDate'. Allowed values: sku, createdDate, lastUpdatedDate.", "required": false }, { "name": "sortOrder", "in": "query", "description": "The order in which to sort the result items. Default: 'DESC'. Allowed values: ASC, DESC.", "required": false }, { "name": "pageSize", "in": "query", "description": "The number of results that you want to include on each page (Min: 1, Max: 20). Default: 10.", "required": false, "example": "10" }, { "name": "pageToken", "in": "query", "description": "A token that you can use to fetch a specific page when there are multiple pages of results.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchListingsItemsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchListingsItemsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/listings/items/{sku}": { "get": { "tags": [ "Listings Items" ], "summary": "Get listings item", "description": "Get a listings item by seller SKU. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getListingsItem", "parameters": [ { "name": "sku", "in": "path", "description": "The seller SKU of the item", "required": true, "example": "Test Catan 07-11-2025 B00U26V4VQ" }, { "name": "includedData", "in": "query", "description": "A comma-delimited list of datasets to include in the response. \n'summaries' - Summary details for the listing item. \n'attributes' - A JSON object that contains structured listing item attribute data, keyed by attribute name. \n'issues' - Issues that are associated with the listing item. \n'offers' - Current offers for the listing item. \n'fulfillmentAvailability' - Fulfillment availability details for the listing item. \n'procurement' - Vendor procurement details for the listing item. \n'relationships' - Relationship details for a listing item (for example, variations). \n'productTypes' - Product types associated with a listing item. \nDefault: 'summaries'.", "required": false, "example": "summaries,attributes,issues,offers,fulfillmentAvailability,procurement,relationships,productTypes" }, { "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.", "required": false, "example": "en_US" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingsItem" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingsItem" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "put": { "tags": [ "Listings Items" ], "summary": "Create or update listing from ASIN", "description": "Create or update a listing by copying product data from an existing ASIN and adding offer details. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "putListingsItem", "parameters": [ { "name": "sku", "in": "path", "description": "Your unique SKU for this listing", "required": true, "example": "Test Catan 07-11-2025 B00U26V4VQ" }, { "name": "mode", "in": "query", "description": "Enables validation-only mode without creating/updating listings. Use `VALIDATION_PREVIEW` to check for errors before actual submission. When enabled, the system validates the request payload and returns validation results without making any changes to your listings.", "required": false, "example": "VALIDATION_PREVIEW" }, { "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.", "required": false, "example": "en_US" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutListingsItemRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingsItemSubmissionResponse" } } } }, "400": { "$ref": "#/components/responses/BusinessLogicError" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutListingsItemInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "delete": { "tags": [ "Listings Items" ], "summary": "Delete listings item", "description": "Delete a listings item by seller SKU. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "deleteListingsItem", "parameters": [ { "name": "sku", "in": "path", "description": "The seller SKU of the item", "required": true, "example": "Test Catan 07-11-2025 B00U26V4VQ" }, { "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.", "required": false, "example": "en_US" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingsItemSubmissionResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteListingsItemInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/products/{asin}": { "get": { "tags": [ "Products" ], "summary": "Get product info", "description": "Get product info. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getProduct", "parameters": [ { "name": "asin", "in": "path", "description": "Amazon product ASIN.", "required": true, "example": "B00U26V4VQ" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Product info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/products/{asin}/calculate": { "post": { "tags": [ "Products" ], "summary": "Calculate product profit", "description": "Calculate product profit. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "calculateProductProfit", "parameters": [ { "name": "asin", "in": "path", "description": "Amazon product ASIN.", "required": true, "example": "B00U26V4VQ" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "requestBody": { "description": "Calculate product profit request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculateProductProfitRequest" } } } }, "responses": { "200": { "description": "Calculate product profit response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProfit" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculateProductProfitInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/products/{asin}/stats": { "get": { "tags": [ "Products" ], "summary": "Get product statistics", "description": "Fetch detailed statistics for a specific product identified by its ASIN. The statistics include monthly sales, various price metrics (Amazon price, marketplace new price, Buy Box price), Best Sellers Rank (BSR), number of offers, number of reviews, and BSR drops count. The limit is 60 requests per minute.", "operationId": "getProductStats", "parameters": [ { "name": "asin", "in": "path", "description": "Amazon product ASIN.", "required": true, "example": "B00U26V4VQ" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Product stats", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductStats" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductStatsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/products/{asin}/restriction-status": { "get": { "tags": [ "Restrictions" ], "summary": "Check ASIN restrictions", "description": "Check ASIN restrictions by ASIN and domain. Returns one of the following statuses: `ALLOWED_TO_SELL`, `NOT_ELIGIBLE`, `APPROVAL_REQUIRED`. Be noticed that if ASIN is not found, it will return `ALLOWED_TO_SELL` anyway (for better performance). The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "checkAsinRestrictions", "parameters": [ { "name": "asin", "in": "path", "description": "Amazon product ASIN.", "required": true, "example": "B00U26V4VQ" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "ASIN restrictions status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckAsinRestrictionsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckRestrictionsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/{productId}/history": { "get": { "tags": [ "SA Products History" ], "summary": "Get history for internal product", "description": "Get history for a specific internal product.", "operationId": "getInternalProductHistory", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1 } }, { "name": "actions", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "History retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "internal_product_id": { "type": "string" }, "team_id": { "type": "integer" }, "user_id": { "type": "integer" }, "action": { "type": "string" }, "entity_type": { "type": [ "string", "null" ] }, "entity_id": { "type": [ "string", "null" ] }, "changes": { "type": [ "object", "null" ] }, "source": { "type": "string" }, "source_attributes": { "type": [ "object", "null" ] }, "metadata": { "type": [ "object", "null" ] }, "created_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "pagination": { "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/history": { "get": { "tags": [ "SA Products History" ], "summary": "Get history for all products in team", "description": "Get history for all products in the team.", "operationId": "getTeamHistory", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1 } }, { "name": "actions", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "History retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "internal_product_id": { "type": "string" }, "team_id": { "type": "integer" }, "user_id": { "type": "integer" }, "action": { "type": "string" }, "entity_type": { "type": [ "string", "null" ] }, "entity_id": { "type": [ "string", "null" ] }, "changes": { "type": [ "object", "null" ] }, "source": { "type": "string" }, "source_attributes": { "type": [ "object", "null" ] }, "metadata": { "type": [ "object", "null" ] }, "created_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "pagination": { "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/history/actions": { "get": { "tags": [ "SA Products History" ], "summary": "Get available history action types", "description": "Get available action types.", "operationId": "getAvailableActions", "responses": { "200": { "description": "Available actions retrieved", "content": { "application/json": { "schema": { "properties": { "actions": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/autocomplete": { "get": { "tags": [ "SA Products" ], "summary": "Autocomplete products from multiple sources for internal product creation", "operationId": "autocompleteProducts", "parameters": [ { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" }, { "name": "search", "in": "query", "description": "Search term (ASIN, UPC, title, , etc.)", "required": true, "schema": { "type": "string", "example": "B00U26V4VQ" } }, { "name": "page", "in": "query", "description": "Integer value between `1` and `10`. Each search result page provides up to `10` results.", "required": false, "example": "1" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "description": "List of matching products", "type": "array", "items": { "properties": { "asin": { "type": "string", "example": "B00U26V4VQ" }, "marketplace_id": { "type": "string", "example": "ATVPDKIKX0DER" }, "title": { "type": "string", "example": "Product Title" }, "upc_list": { "type": [ "array", "null" ], "example": [ "029877030712", "029877030713" ] }, "ean_list": { "type": [ "array", "null" ], "example": [ "0029877030712", "0029877030713" ] }, "gtin_list": { "type": [ "array", "null" ], "example": [ "00001234567890", "00001234567891" ] }, "brand": { "type": [ "string", "null" ], "example": "Catan" }, "image_url": { "type": [ "string", "null" ], "example": "https://images-na.ssl-images-amazon.com/images/I/51N-u8AsmdL._SX342_.jpg" }, "internal_product_id": { "type": [ "string", "null" ], "example": "P-5XK1S0NQNO" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/search": { "post": { "tags": [ "SA Products" ], "summary": "Search internal products", "operationId": "searchInternalProducts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "page": { "description": "Page number (default 1)", "type": [ "integer", "null" ], "minimum": 1, "example": 1 }, "perPage": { "description": "Items per page (default 25)", "type": [ "integer", "null" ], "maximum": 100, "minimum": 1, "example": 25 }, "search": { "description": "Search term to filter internal products", "type": "string", "example": "" }, "sortKey": { "description": "Field to sort by", "type": [ "string", "null" ], "example": "created_at" }, "sortValue": { "description": "Sort direction (asc or desc)", "type": [ "string", "null" ], "example": "desc" }, "asin": { "description": "Filter by asin", "properties": { "checkboxes": { "type": "array", "items": { "type": "string", "example": "exactly" } }, "inputs": { "properties": { "exactly": { "type": "string", "example": "B00U26V4VQ" } }, "type": "object" } }, "type": [ "object", "null" ] }, "upc": { "description": "Filter by UPC", "properties": { "checkboxes": { "type": "array", "items": { "type": "string", "example": "not_blank" } } }, "type": [ "object", "null" ] }, "ean": { "description": "Filter by EAN", "properties": { "checkboxes": { "type": "array", "items": { "type": "string", "example": "blank" } } }, "type": [ "object", "null" ] }, "title": { "description": "Filter by title", "properties": { "checkboxes": { "type": "array", "items": { "type": "string", "example": "not_contains" } }, "inputs": { "properties": { "not_contains": { "type": "string", "example": "xxx" } }, "type": "object" } }, "type": [ "object", "null" ] }, "notes": { "description": "Filter by notes", "properties": { "checkboxes": { "type": "array", "items": { "type": "string", "example": "contains" } }, "inputs": { "properties": { "contains": { "type": "string", "example": "extension note" } }, "type": "object" } }, "type": [ "object", "null" ] }, "preference": { "description": "Filter by preference conditions", "type": [ "array", "null" ], "example": [ "like_incl", "dislike_excl" ] }, "cog": { "description": "Filter by Cost of Goods (COG)", "properties": { "greater_equal": { "type": "number", "example": 10.5 }, "less_equal": { "type": "number", "example": 1000 } }, "type": [ "object", "null" ] }, "brand": { "description": "Filter by brand", "properties": { "checkboxes": { "type": "array", "items": { "type": "string", "example": "is" } }, "inputs": { "properties": { "is": { "type": "string", "example": [ "Nike", "Catan" ] } }, "type": "object" } }, "type": [ "object", "null" ] }, "supplier": { "description": "Filter by supplier", "properties": { "checkboxes": { "type": "array", "items": { "type": "string", "example": "is" } }, "inputs": { "properties": { "is": { "type": "integer", "example": [ 33 ] } }, "type": "object" } }, "type": [ "object", "null" ] }, "tags": { "description": "Filter by tags", "properties": { "checkboxes": { "type": "array", "items": { "type": "string", "example": "is" } }, "inputs": { "properties": { "is": { "type": "integer", "example": [ 2, 5 ] } }, "type": "object" } }, "type": [ "object", "null" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "description": "List of internal products", "type": "array", "items": { "$ref": "#/components/schemas/InternalProduct" } }, "pagination": { "description": "Pagination details", "properties": { "currentPage": { "type": "integer", "example": 1 }, "perPage": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 100 }, "lastPage": { "type": "integer", "example": 4 } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/{productId}": { "get": { "tags": [ "SA Products" ], "summary": "Get internal product", "description": "Get a specific internal product.", "operationId": "getInternalProduct", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalProduct" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "delete": { "tags": [ "SA Products" ], "summary": "Delete internal product", "description": "Delete an internal product.", "operationId": "deleteInternalProduct", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P23-123455ABCDEF" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Internal product deleted successfully" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "patch": { "tags": [ "SA Products" ], "summary": "Update internal product", "description": "Update product.", "operationId": "updateInternalProduct", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "title": { "type": [ "string", "null" ], "example": "Updated title" }, "image_url": { "type": [ "string", "null" ], "example": "https://test.com/new-image.jpg" }, "brand": { "type": [ "string", "null" ], "example": "Catan" }, "like_dislike": { "type": [ "boolean", "null" ], "example": false }, "note": { "type": [ "string", "null" ], "example": "This is an updated note" }, "external_products": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ExternalProductUpsertItem" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalProduct" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products": { "post": { "tags": [ "SA Products" ], "summary": "Create internal product", "description": "Create a new internal product.", "operationId": "createInternalProduct", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": [ "string", "null" ], "example": "My internal product" }, "image_url": { "type": [ "string", "null" ], "example": "https://example.com/image.jpg" }, "brand": { "type": [ "string", "null" ], "example": "Catan" }, "like_dislike": { "type": [ "boolean", "null" ], "example": true }, "note": { "type": [ "string", "null" ], "example": "This is not an extension note" }, "external_products": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ExternalProductUpsertItem" } } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalProduct" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/{productId}/set-default-supplier": { "post": { "tags": [ "SA Products" ], "summary": "Set or unset default supplier ", "description": "Set or unset the default supplier for a product.\nPass supplier_id to select, or null to unselect.", "operationId": "setDefaultSupplier", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "default_supplier_id": { "type": [ "integer", "null" ], "example": 33 } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalProduct" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/{productId}/tags": { "post": { "tags": [ "SA Products" ], "summary": "Assign or remove a tag from an internal product", "operationId": "assignTagToInternalProduct", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "tag_id", "remove" ], "properties": { "tag_id": { "description": "Tag ID to assign or remove", "type": "integer", "example": 1 }, "remove": { "description": "If true, removes the tag; if false, assigns it", "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Tag assignment updated successfully" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/{productId}/supplier-offers": { "get": { "tags": [ "SA Products" ], "summary": "List product supplier offers", "description": "Get supplier offers for a product.", "operationId": "listSupplierOffers", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "description": "List of supplier offers", "type": "array", "items": { "$ref": "#/components/schemas/SupplierProductOffer" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "post": { "tags": [ "SA Products" ], "summary": "Create or update product supplier offer", "description": "Add a supplier offer to a product.", "operationId": "upsertSupplierOffer", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "supplier_id" ], "properties": { "supplier_id": { "type": "integer", "example": 10 }, "sku": { "type": [ "string", "null" ], "example": "SUP-123" }, "cog": { "type": [ "number", "null" ], "format": "float", "example": 12.34 }, "product_link": { "type": [ "string", "null" ], "example": "https://example.com/item" }, "supplier_product_title": { "type": [ "string", "null" ], "example": "Supplier title" }, "supplier_product_code": { "type": [ "string", "null" ], "example": "029877030712" }, "supplier_product_code_type": { "type": [ "string", "null" ], "example": "upc" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierProductOffer" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "delete": { "tags": [ "SA Products" ], "summary": "Delete product supplier offer", "description": "Remove a supplier offer from a product.", "operationId": "deleteSupplierOffer", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "supplier_id" ], "properties": { "supplier_id": { "type": "integer", "example": 5 } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Supplier offer deleted successfully" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/{productId}/external-products": { "get": { "tags": [ "SA Products" ], "summary": "List external product identifiers", "description": "Get external products (identifiers) for an internal product.", "operationId": "listExternalProducts", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "description": "List of external products", "type": "array", "items": { "$ref": "#/components/schemas/ExternalProduct" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "post": { "tags": [ "SA Products" ], "summary": "Create or update external product identifier(s)", "operationId": "upsertExternalProduct", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "external_products" ], "properties": { "external_products": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalProductUpsertItem" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalProduct" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "delete": { "tags": [ "SA Products" ], "summary": "Delete external product identifiers", "description": "Remove external product identifiers.", "operationId": "deleteExternalProducts", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "external_products" ], "properties": { "external_products": { "type": "array", "items": { "required": [ "identifier" ], "properties": { "identifier": { "type": "string", "example": "B00U26V4VQ" }, "marketplace_code": { "type": [ "string", "null" ], "example": "ATVPDKIKX0DER" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalProduct" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/filter-data": { "get": { "tags": [ "SA Products" ], "summary": "Get filter data for internal products", "operationId": "getInternalProductFilterData", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "select": { "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/bulk-delete": { "post": { "tags": [ "SA Products" ], "summary": "Bulk delete internal products", "operationId": "bulkDeleteInternalProducts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "product_ids": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Internal products deleted successfully" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/{productId}/notes": { "get": { "tags": [ "SA Products" ], "summary": "Get notes for internal product", "operationId": "getInternalProductNotes", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "post": { "tags": [ "SA Products" ], "summary": "Add note to internal product", "operationId": "addInternalProductNote", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "note": { "type": "string" } }, "type": "object" } } } }, "responses": { "201": { "description": "Note created", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/products/notes/{noteId}": { "put": { "tags": [ "SA Products" ], "summary": "Update internal product note", "operationId": "updateInternalProductNote", "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "note": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Note updated", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "delete": { "tags": [ "SA Products" ], "summary": "Delete internal product note", "operationId": "deleteInternalProductNote", "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Note deleted successfully" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/suppliers": { "get": { "tags": [ "SA Suppliers" ], "summary": "List suppliers", "operationId": "listSuppliers", "parameters": [ { "name": "page", "in": "query", "description": "Page number (default 1)", "required": false, "schema": { "type": "integer", "minimum": 1, "example": 1 } }, { "name": "per_page", "in": "query", "description": "Items per page (default 25)", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "example": 25 } }, { "name": "search", "in": "query", "description": "Search term", "required": false, "schema": { "type": "string", "example": "" } }, { "name": "sortKey", "in": "query", "description": "Sort field", "required": false, "schema": { "type": "string", "example": "created_at" } }, { "name": "sortDirection", "in": "query", "description": "Sort direction (asc or desc)", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "example": "desc" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "description": "List of suppliers", "type": "array", "items": { "$ref": "#/components/schemas/Supplier" } }, "pagination": { "description": "Pagination details", "properties": { "current_page": { "type": "integer", "example": 1 }, "per_page": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 100 }, "last_page": { "type": "integer", "example": 4 } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "post": { "tags": [ "SA Suppliers" ], "summary": "Create supplier", "operationId": "createSupplier", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSupplierForm" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Supplier" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/suppliers/{supplierId}": { "get": { "tags": [ "SA Suppliers" ], "summary": "Get supplier", "operationId": "getSupplier", "parameters": [ { "name": "supplierId", "in": "path", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Supplier" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "delete": { "tags": [ "SA Suppliers" ], "summary": "Delete supplier", "operationId": "deleteSupplier", "parameters": [ { "name": "supplierId", "in": "path", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Supplier deleted successfully" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "patch": { "tags": [ "SA Suppliers" ], "summary": "Update supplier", "operationId": "updateSupplier", "parameters": [ { "name": "supplierId", "in": "path", "required": true, "schema": { "type": "integer", "example": 1 } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSupplierForm" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Supplier" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sa/inventory/suppliers/{supplierId}/offers": { "get": { "tags": [ "SA Suppliers" ], "summary": "Get all supplier offers for a specific supplier", "description": "Returns paginated list of all product offers from a specific supplier with internal product data.", "operationId": "getSupplierOffers", "parameters": [ { "name": "supplierId", "in": "path", "description": "Supplier ID", "required": true, "schema": { "type": "integer", "example": 123 } }, { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "default": 1, "example": 1 } }, { "name": "perPage", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "default": 25, "maximum": 100, "example": 25 } }, { "name": "sortKey", "in": "query", "description": "Sort field (default: created_at)", "required": false, "schema": { "type": "string", "default": "created_at", "example": "created_at" } }, { "name": "sortDirection", "in": "query", "description": "Sort direction (default: desc)", "required": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "example": "desc" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierProductOffer" } }, "pagination": { "properties": { "currentPage": { "type": "integer", "example": 1 }, "perPage": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 100 }, "lastPage": { "type": "integer", "example": 4 } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/users/me": { "get": { "tags": [ "User Info" ], "summary": "Get current user info", "description": "Get current user info including name, email and tokens left.", "operationId": "getCurrentUserInfo", "responses": { "200": { "description": "Current user info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentUserInfoResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCurrentUserInfoInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/estimate-sales": { "post": { "tags": [ "Sales Estimation" ], "summary": "Estimate sales by BSR and category", "description": "Estimate approximate sales number for provided BSR, category and domain. The limit is 60 requests per minute. The following marketplaces are available: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "operationId": "estimateSalesByBsrAndCategory", "requestBody": { "description": "Estimate sales request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateSalesByBsrRequest" } } } }, "responses": { "200": { "description": "Estimated sales number", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateSalesResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateSalesInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/products/{asin}/sales": { "get": { "tags": [ "Sales Estimation" ], "summary": "Estimate sales by ASIN", "description": "Estimate approximate sales number for provided ASIN and domain. The limit is 60 requests per minute. The following marketplaces are available: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "operationId": "estimateSalesByAsin", "parameters": [ { "name": "asin", "in": "path", "description": "Amazon product ASIN.", "required": true, "example": "B00U26V4VQ" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Estimated sales number", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateSalesResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateSalesInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/catalog/2022-04-01/items": { "get": { "tags": [ "SP-API Catalog Items" ], "summary": "Search catalog items", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/searchcatalogitems. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "searchCatalogItemsProxy", "parameters": [ { "name": "identifiers", "in": "query", "description": "A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include `identifiers` and `keywords` in the same request.", "required": false, "example": "B00U26V4VQ,B08MQTYSPT,B08N5WRWNW" }, { "name": "identifiersType", "in": "query", "description": "The type of product identifiers that you can use to search the Amazon catalog. **Note:** `identifiersType` is required when `identifiers` is in the request. Allowed values: ASIN, EAN, GTIN, ISBN, JAN, MINSAN, SKU, UPC.", "required": false, "example": "ASIN" }, { "name": "includedData", "in": "query", "description": "A comma-delimited list of datasets to include in the response. Allowed values: attributes, classifications, dimensions, identifiers, images, productTypes, relationships, salesRanks, summaries, vendorDetails.", "required": false, "example": "summaries,attributes,images" }, { "name": "locale", "in": "query", "description": "The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.", "required": false, "example": "en_US" }, { "name": "keywords", "in": "query", "description": "A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include `keywords` and `identifiers` in the same request.", "required": false }, { "name": "brandNames", "in": "query", "description": "A comma-delimited list of brand names that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.", "required": false }, { "name": "classificationIds", "in": "query", "description": "A comma-delimited list of classification identifiers that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.", "required": false }, { "name": "pageSize", "in": "query", "description": "The number of results to include on each page (Min: 1, Max: 20). Default: 10.", "required": false, "example": "10" }, { "name": "pageToken", "in": "query", "description": "A token that you can use to fetch a specific page when there are multiple pages of results.", "required": false }, { "name": "keywordsLocale", "in": "query", "description": "The language of the keywords that are included in queries based on `keywords`. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCatalogItemsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCatalogItemsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/catalog/2022-04-01/items/{asin}": { "get": { "tags": [ "SP-API Catalog Items" ], "summary": "Get catalog item", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/getcatalogitem. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getCatalogItemProxy", "parameters": [ { "name": "asin", "in": "path", "description": "The Amazon Standard Identification Number (ASIN) of the item.", "required": true, "example": "B00U26V4VQ" }, { "name": "includedData", "in": "query", "description": "A comma-delimited list of datasets to include in the response. Allowed values: attributes, classifications, dimensions, identifiers, images, productTypes, relationships, salesRanks, summaries, vendorDetails.", "required": false, "example": "summaries,attributes,images,relationships" }, { "name": "locale", "in": "query", "description": "The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.", "required": false, "example": "en_US" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogItem" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCatalogItemInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/fba/inventory/v1/summaries": { "get": { "tags": [ "SP-API FBA Inventory" ], "summary": "Get inventory summaries", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/getinventorysummaries. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getInventorySummariesProxy", "parameters": [ { "name": "granularityType", "in": "query", "description": "The granularity type for the inventory aggregation level. Allowed values: Marketplace.", "required": true, "example": "Marketplace" }, { "name": "granularityId", "in": "query", "description": "The granularity ID for the inventory aggregation level. When granularityType is Marketplace, specify the marketplaceId. Defaults to the marketplaceId if not provided.", "required": false, "example": "ATVPDKIKX0DER" }, { "name": "details", "in": "query", "description": "true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).", "required": false, "example": true }, { "name": "startDateTime", "in": "query", "description": "A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API.", "required": false, "example": "2025-01-01T00:00:00Z" }, { "name": "sellerSkus", "in": "query", "description": "A comma-delimited list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.", "required": false, "example": "Test Catan 07-11-2025 B00U26V4VQ,amzn.gr.WoodLink_Ltd._06-05-20-2Y2Zvq-LN,Surreal Entertainm 02-09-2025 B08MQTYSPT" }, { "name": "sellerSku", "in": "query", "description": "A single seller SKU used for querying the specified seller SKU inventory summaries.", "required": false, "example": "Test Catan 07-11-2025 B00U26V4VQ" }, { "name": "nextToken", "in": "query", "description": "String token returned in the response of your previous request. The string token will expire 30 seconds after being created.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInventorySummariesResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInventorySummariesInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/fba/inbound/v0/shipments": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "Get old shipments", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/getshipments. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getOldShipmentsProxy", "parameters": [ { "name": "queryType", "in": "query", "description": "`SHIPMENT` or `DATE_RANGE` or `NEXT_TOKEN`. Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the `LastUpdatedAfter` and `LastUpdatedBefore` parameters), or by using `NextToken` to continue returning items specified in a previous request.", "required": true, "example": "SHIPMENT" }, { "name": "shipmentStatusList", "in": "query", "description": "A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.\n\nPossible values:\n- WORKING: The shipment was created by the seller, but has not yet shipped.\n- READY_TO_SHIP: The seller has printed box labels (for Small parcel shipments) or pallet labels (for Less Than Truckload shipments).\n- SHIPPED: The shipment was picked up by the carrier.\n- RECEIVING: The shipment has arrived at the fulfillment center, but not all items have been marked as received.\n- CANCELLED: The shipment was cancelled by the seller after the shipment was sent to the fulfillment center.\n- DELETED: The shipment was cancelled by the seller before the shipment was sent to the fulfillment center.\n- CLOSED: The shipment has arrived at the fulfillment center and all items have been marked as received.\n- ERROR: There was an error with the shipment and it was not processed by Amazon.\n- IN_TRANSIT: The carrier has notified the fulfillment center that it is aware of the shipment.\n- DELIVERED: The shipment was delivered by the carrier to the fulfillment center.\n- CHECKED_IN: The shipment was checked-in at the receiving dock of the fulfillment center.", "required": false, "example": "WORKING,READY_TO_SHIP,SHIPPED,RECEIVING,CANCELLED,DELETED,CLOSED,ERROR,IN_TRANSIT,DELIVERED,CHECKED_IN" }, { "name": "shipmentIdList", "in": "query", "description": "A list of shipment IDs used to select the shipments that you want. If both `ShipmentStatusList` and `ShipmentIdList` are specified, only shipments that match both parameters are returned.", "required": false, "example": "FBA18VL7CBZ0,FBA18XW7GGHW" }, { "name": "lastUpdatedBefore", "in": "query", "description": "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.", "required": false, "example": "2025-06-01" }, { "name": "lastUpdatedAfter", "in": "query", "description": "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.", "required": false, "example": "2025-01-01" }, { "name": "nextToken", "in": "query", "description": "A string token returned in the response to your previous request.", "required": false, "example": "" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/fba/inbound/v0/shipmentItems": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "Get old shipment items", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/getshipmentitems. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getOldShipmentItemsProxy", "parameters": [ { "name": "queryType", "in": "query", "description": "`DATE_RANGE` or `NEXT_TOKEN`. Indicates whether items are returned using a date range (by providing the `LastUpdatedAfter` and `LastUpdatedBefore` parameters), or using `NextToken`, which continues returning items specified in a previous request.", "required": true, "example": "DATE_RANGE" }, { "name": "lastUpdatedBefore", "in": "query", "description": "A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.", "required": false, "example": "2025-06-01" }, { "name": "lastUpdatedAfter", "in": "query", "description": "A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.", "required": false, "example": "2025-01-01" }, { "name": "nextToken", "in": "query", "description": "A string token returned in the response to your previous request.", "required": false, "example": "" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentItemsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentItemsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/fba/inbound/v0/shipments/{shipmentId}/items": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "Get old shipment items by old shipment id", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/getshipmentitemsbyshipmentid. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getOldShipmentItemsByShipmentIdProxy", "parameters": [ { "name": "shipmentId", "in": "path", "description": "Shipment ID.", "required": true, "example": "FBA18VL7CBZ0" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentItemsByShipmentIdResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentItemsByShipmentIdInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "List inbound plans", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/listinboundplans. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listInboundPlansProxy", "parameters": [ { "name": "pageSize", "in": "query", "description": "1 to 30. Defaults to 10. The number of inbound plans to return in the response matching the given query.", "required": false, "example": "10" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "status", "in": "query", "description": "`ACTIVE` or `VOIDED` or `SHIPPED`. The status of an inbound plan.", "required": false, "example": "ACTIVE" }, { "name": "sortBy", "in": "query", "description": "`LAST_UPDATED_TIME` or `CREATION_TIME`. Sort by field", "required": false, "example": "LAST_UPDATED_TIME" }, { "name": "sortOrder", "in": "query", "description": "`ASC` or `DESC`. The sort order.", "required": false, "example": "DESC" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInboundPlansResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInboundPlansInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "Get inbound plan", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/getinboundplan. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getInboundPlanProxy", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInboundPlanResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInboundPlanInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "List placement options", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/listplacementoptions. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listPlacementOptionsProxy", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "pageSize", "in": "query", "description": "Integer 1 to 20. Defaults to 10. The number of placement options to return in the response matching the given query.", "required": false, "example": "20" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPlacementOptionsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPlacementOptionsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "List transportation options", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/listtransportationoptions. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listTransportationOptionsProxy", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "placementOptionId", "in": "query", "description": "The placement option to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified.", "required": false, "example": "pl3b508968-de24-408a-b708-dbbb3915e070" }, { "name": "shipmentId", "in": "query", "description": "The shipment to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified.", "required": false, "example": "sh7059be6b-54b3-4320-8553-f913d3472cc3" }, { "name": "pageSize", "in": "query", "description": "Integer 1 to 20. Defaults to 10. The number of placement options to return in the response matching the given query.", "required": false, "example": "20" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransportationOptionsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransportationOptionsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "Get shipment", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/getshipment. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getShipmentProxy", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "shipmentId", "in": "path", "description": "Shipment ID.", "required": true, "example": "sh7059be6b-54b3-4320-8553-f913d3472cc3" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentSummary" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/items": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "List shipment items", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/listshipmentitems. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listShipmentItemsProxy", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "shipmentId", "in": "path", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded.", "required": true, "example": "sh7059be6b-54b3-4320-8553-f913d3472cc3" }, { "name": "pageSize", "in": "query", "description": "Integer 1 to 1000. Defaults to 10. The number of placement options to return in the response matching the given query.", "required": false, "example": "20" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShipmentItemsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/boxes": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "List inbound plan boxes", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/listinboundplanboxes. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listInboundPlanBoxesProxy", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "pageSize", "in": "query", "description": "Integer 1 to 1000. Defaults to 10. The number of boxes to return in the response matching the given query.", "required": false, "example": "20" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInboundPlanBoxesResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInboundPlanBoxesInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxes": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "List shipment boxes", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/listshipmentboxes. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listShipmentBoxesProxy", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "shipmentId", "in": "path", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded.", "required": true, "example": "sh7059be6b-54b3-4320-8553-f913d3472cc3" }, { "name": "pageSize", "in": "query", "description": "Integer 1 to 1000. Defaults to 10. The number of boxes to return in the response matching the given query.", "required": false, "example": "20" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShipmentBoxesResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShipmentBoxesInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "List packing options", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/listpackingoptions. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listPackingOptionsProxy", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "pageSize", "in": "query", "description": "Integer 1 to 1000. Defaults to 10. The number of packing options to return in the response matching the given query.", "required": false, "example": "20" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPackingOptionsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPackingOptionsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/boxes": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "List packing group boxes", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/listpackinggroupboxes. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listPackingGroupBoxesProxy", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "packingGroupId", "in": "path", "description": "Identifier of a packing group.", "required": true, "example": "pg07ea0f63-4f42-4bb4-b122-b9ea8fbf0319" }, { "name": "pageSize", "in": "query", "description": "Integer 1 to 1000. Defaults to 10. The number of boxes to return in the response matching the given query.", "required": false, "example": "20" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPackingGroupBoxesResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPackingGroupBoxesInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/items": { "get": { "tags": [ "SP-API FBA Shipments" ], "summary": "List packing group items", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/listpackinggroupitems. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "listPackingGroupItemsProxy", "parameters": [ { "name": "inboundPlanId", "in": "path", "description": "Inbound Plan id (Workflow Id).", "required": true, "example": "wf64bdf98e-986d-4bbe-8e20-7196e3aaa1d2" }, { "name": "packingGroupId", "in": "path", "description": "Identifier of a packing group.", "required": true, "example": "pg07ea0f63-4f42-4bb4-b122-b9ea8fbf0319" }, { "name": "pageSize", "in": "query", "description": "Integer 1 to 1000. Defaults to 10. The number of items to return in the response matching the given query.", "required": false, "example": "20" }, { "name": "paginationToken", "in": "query", "description": "String length between 0 and 1024. A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPackingGroupItemsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPackingGroupItemsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/listings/2021-08-01/items": { "get": { "tags": [ "SP-API Listings Items" ], "summary": "Search listings items", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/searchlistingsitems. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "searchListingsItemsProxy", "parameters": [ { "name": "identifiers", "in": "query", "description": "A comma-delimited list of product identifiers (max 20). Required when 'identifiersType' is specified. Cannot be used with 'variationParentSku' or 'packageHierarchySku'.", "required": false, "example": "Test Catan 07-11-2025 B00U26V4VQ,amzn.gr.WoodLink_Ltd._06-05-20-2Y2Zvq-LN,Surreal Entertainm 02-09-2025 B08MQTYSPT" }, { "name": "identifiersType", "in": "query", "description": "A type of product identifiers. Required when 'identifiers' is provided. Allowed values: SKU, ASIN, EAN, FNSKU, GTIN, ISBN, JAN, MINSAN, UPC.", "required": false, "example": "SKU" }, { "name": "includedData", "in": "query", "description": "A comma-delimited list of datasets to include in the response. \n'summaries' - Summary details for the listing item. \n'attributes' - A JSON object that contains structured listing item attribute data, keyed by attribute name. \n'issues' - Issues that are associated with the listing item. \n'offers' - Current offers for the listing item. \n'fulfillmentAvailability' - Fulfillment availability details for the listing item. \n'procurement' - Vendor procurement details for the listing item. \n'relationships' - Relationship details for a listing item (for example, variations). \n'productTypes' - Product types associated with a listing item. \nDefault: 'summaries'.", "required": false, "example": "summaries,attributes,issues" }, { "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.", "required": false, "example": "en_US" }, { "name": "variationParentSku", "in": "query", "description": "Filters results to variation children of the specified SKU. Cannot be used with 'identifiers' or 'packageHierarchySku'.", "required": false }, { "name": "packageHierarchySku", "in": "query", "description": "Filter results to listing items that contain or are contained by the specified SKU. Cannot be used with 'identifiers' or 'variationParentSku'.", "required": false }, { "name": "createdAfter", "in": "query", "description": "Filter items created at or after this date (ISO 8601 format).", "required": false, "example": "2025-09-01T00:00:00Z" }, { "name": "createdBefore", "in": "query", "description": "Filter items created at or before this date (ISO 8601 format).", "required": false, "example": "2025-11-01T23:59:59Z" }, { "name": "lastUpdatedAfter", "in": "query", "description": "Filter items last updated at or after this date (ISO 8601 format).", "required": false, "example": "2025-09-01T00:00:00Z" }, { "name": "lastUpdatedBefore", "in": "query", "description": "Filter items last updated at or before this date (ISO 8601 format).", "required": false, "example": "2025-11-01T23:59:59Z" }, { "name": "withIssueSeverity", "in": "query", "description": "Filter results by one or more issue severity levels. \n'ERROR' - Indicates that an issue has occurred, which prevented the submission from processing. For example, a validation error.\n'WARNING'\t- Indicates an issue has occurred that should be reviewed, but it has not prevented the submission from processing.", "required": false }, { "name": "withStatus", "in": "query", "description": "Filter results to include only listing items with the specified status.\n'BUYABLE' - The listings item that shoppers can purchase. This status does not apply to vendor listings.\n'DISCOVERABLE' - The listings item is visible to shoppers.", "required": false }, { "name": "withoutStatus", "in": "query", "description": "Filter results to exclude listing items with the specified statuses.\n'BUYABLE' - The listings item that shoppers can purchase. This status does not apply to vendor listings.\n'DISCOVERABLE' - The listings item is visible to shoppers.", "required": false }, { "name": "sortBy", "in": "query", "description": "An attribute by which to sort the returned listing items. Default: 'lastUpdatedDate'. Allowed values: sku, createdDate, lastUpdatedDate.", "required": false }, { "name": "sortOrder", "in": "query", "description": "The order in which to sort the result items. Default: 'DESC'. Allowed values: ASC, DESC.", "required": false }, { "name": "pageSize", "in": "query", "description": "The number of results that you want to include on each page (Min: 1, Max: 20). Default: 10.", "required": false, "example": "10" }, { "name": "pageToken", "in": "query", "description": "A token that you can use to fetch a specific page when there are multiple pages of results.", "required": false }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchListingsItemsResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchListingsItemsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/listings/2021-08-01/items/{sku}": { "get": { "tags": [ "SP-API Listings Items" ], "summary": "Get listings item", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/getlistingsitem. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getListingsItemProxy", "parameters": [ { "name": "sku", "in": "path", "description": "The seller SKU of the item", "required": true, "example": "Test Catan 07-11-2025 B00U26V4VQ" }, { "name": "includedData", "in": "query", "description": "A comma-delimited list of datasets to include in the response. \n'summaries' - Summary details for the listing item. \n'attributes' - A JSON object that contains structured listing item attribute data, keyed by attribute name. \n'issues' - Issues that are associated with the listing item. \n'offers' - Current offers for the listing item. \n'fulfillmentAvailability' - Fulfillment availability details for the listing item. \n'procurement' - Vendor procurement details for the listing item. \n'relationships' - Relationship details for a listing item (for example, variations). \n'productTypes' - Product types associated with a listing item. \nDefault: 'summaries'.", "required": false, "example": "summaries,attributes,issues" }, { "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.", "required": false, "example": "en_US" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingsItem" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingsItem" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "put": { "tags": [ "SP-API Listings Items" ], "summary": "Put listings item", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/putlistingsitem. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "putListingsItemProxy", "parameters": [ { "name": "sku", "in": "path", "description": "The seller SKU of the item", "required": true, "example": "Test Catan 07-11-2025 B00U26V4VQ" }, { "name": "includedData", "in": "query", "description": "A comma-delimited list of data sets to include in the response. Default: issues. Allowed values: identifiers, issues. \n`identifiers`\tIdentifiers associated with the item in the Amazon catalog, such as Amazon Standard Identification Number (ASIN). Can only be requested when `mode` is `VALIDATION_PREVIEW`.\n`issues`\tThe issues associated with the listing item.", "required": false, "example": "issues" }, { "name": "mode", "in": "query", "description": "Enables validation-only mode without creating/updating listings. Use `VALIDATION_PREVIEW` to check for errors before actual submission. When enabled, the system validates the request payload and returns validation results without making any changes to your listings.", "required": false, "example": "VALIDATION_PREVIEW" }, { "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.", "required": false, "example": "en_US" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingsItemPutRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingsItemSubmissionResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutListingsItemInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "delete": { "tags": [ "SP-API Listings Items" ], "summary": "Delete listings item", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/deletelistingsitem. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "deleteListingsItemProxy", "parameters": [ { "name": "sku", "in": "path", "description": "The seller SKU of the item", "required": true, "example": "Test Catan 07-11-2025 B00U26V4VQ" }, { "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.", "required": false, "example": "en_US" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingsItemSubmissionResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteListingsItemInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] }, "patch": { "tags": [ "SP-API Listings Items" ], "summary": "Patch listings item", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/patchlistingsitem. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "patchListingsItemProxy", "parameters": [ { "name": "sku", "in": "path", "description": "The seller SKU of the item", "required": true, "example": "Test Catan 07-11-2025 B00U26V4VQ" }, { "name": "includedData", "in": "query", "description": "A comma-delimited list of data sets to include in the response. Default: issues. Allowed values: identifiers, issues. \n`identifiers`\tIdentifiers associated with the item in the Amazon catalog, such as Amazon Standard Identification Number (ASIN). Can only be requested when `mode` is `VALIDATION_PREVIEW`.\n`issues`\tThe issues associated with the listing item.", "required": false, "example": "issues" }, { "name": "mode", "in": "query", "description": "Enables validation-only mode without creating/updating listings. Use `VALIDATION_PREVIEW` to check for errors before actual submission. When enabled, the system validates the request payload and returns validation results without making any changes to your listings.", "required": false, "example": "VALIDATION_PREVIEW" }, { "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.", "required": false, "example": "en_US" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingsItemPatchRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingsItemSubmissionResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchListingsItemInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/definitions/2020-09-01/productTypes": { "get": { "tags": [ "SP-API Product Type Definitions" ], "summary": "Search definitions product types", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/searchdefinitionsproducttypes. The limit is 10 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "searchDefinitionsProductTypesProxy", "parameters": [ { "name": "keywords", "in": "query", "description": "One or more keywords to search for product types.", "required": false, "example": "luggage,bag" }, { "name": "itemName", "in": "query", "description": "The name of the item to get the product type for. This is useful for grouping different product types under the same item name.", "required": false }, { "name": "locale", "in": "query", "description": "The locale to use for the display elements in the response. Defaults to the locale of the marketplace site.", "required": false, "example": "en_US" }, { "name": "searchLocale", "in": "query", "description": "The locale to use for the product type search. Defaults to the locale of the marketplace site.", "required": false, "example": "en_US" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductTypeListResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchProductTypeDefinitionsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } }, "/api/v1/sp-api/definitions/2020-09-01/productTypes/{productType}": { "get": { "tags": [ "SP-API Product Type Definitions" ], "summary": "Get a product type definition", "description": "Proxy to https://developer-docs.amazon.com/sp-api/reference/getdefinitionsproducttype. The limit is 10 requests per minute. Amazon seller account integration is required to make this request. You can do it [here](https://app.sellerassistant.app/integrations/seller-central).", "operationId": "getDefinitionsProductTypeProxy", "parameters": [ { "name": "productType", "in": "path", "description": "The Amazon product type for which to return the definition. Example: `LUGGAGE`.", "required": true, "example": "LUGGAGE" }, { "name": "productTypeVersion", "in": "query", "description": "The version specification applied to the returned product type definition. Defaults to 'LATEST'. Allowed values: LATEST, ACTIVE, 2.0.", "required": false, "example": "LATEST" }, { "name": "requirements", "in": "query", "description": "The name of the requirements set for which to return a definition. Defaults to 'LISTING'. Allowed values: LISTING, DISPLAY_GUIDANCE, ENFORCEMENT.", "required": false, "example": "LISTING" }, { "name": "requirementsEnforced", "in": "query", "description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Defaults to 'ENFORCED'. Allowed values: ENFORCED, NOT_ENFORCED.", "required": false, "example": "ENFORCED" }, { "name": "locale", "in": "query", "description": "The locale to use for the display elements in the response. Defaults to the locale of the marketplace site.", "required": false, "example": "en_US" }, { "name": "domain", "in": "query", "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.", "required": false, "example": "amazon.com" }, { "name": "marketplaceId", "in": "query", "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "example": "ATVPDKIKX0DER" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductTypeDefinitionResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductTypeDefinitionsInternalApiError" } } } } }, "security": [ { "api_key": [] }, { "header_api_key": [] } ] } } }, "components": { "schemas": { "ConvertToASINResponseItem": { "description": "Identifier object", "required": [ "identifierType", "identifier" ], "properties": { "identifierType": { "description": "Type of identifier", "type": "string", "example": "ASIN" }, "identifier": { "description": "Identifier", "type": "string", "example": "B00U26V4VQ" } }, "type": "object" }, "ConvertToASINResponse": { "description": "Array of identifiers", "type": "array", "items": { "$ref": "#/components/schemas/ConvertToASINResponseItem" } }, "ConvertToASINInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to convert to ASINs" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "GetProductIdentifiersResponseItem": { "description": "Identifier object", "required": [ "identifierType", "identifier" ], "properties": { "identifierType": { "description": "Type of identifier", "type": "string", "example": "UPC" }, "identifier": { "description": "Identifier", "type": "string", "example": "029877030712" } }, "type": "object" }, "GetProductIdentifiersResponse": { "description": "Array of identifiers", "type": "array", "items": { "$ref": "#/components/schemas/GetProductIdentifiersResponseItem" } }, "GetProductIdentifiersInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get product identifiers" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ListPlanShipmentsResponse": { "properties": { "inboundPlan": { "$ref": "#/components/schemas/InboundPlanSummary" }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentSummary" } } }, "type": "object" }, "ListPlanShipmentsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to list plan shipments" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "GetShipmentFeesResponse": { "properties": { "placementFees": { "type": "array", "items": { "$ref": "#/components/schemas/PlacementOption" } }, "transportationFees": { "type": "array", "items": { "$ref": "#/components/schemas/TransportationOption" } } }, "type": "object" }, "GetShipmentFeesInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get shipment fees" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "KeepaProductStats": { "properties": { "current": { "description": "Contains the last updated product prices/ranks using the Price Type indexing (refer to the `csv` field in the `KeepaProduct`). Prices are integers representing the smallest currency unit for the respective Amazon locale (e.g., euro cents or yen). A value of -1 indicates no offer was available in the given interval (e.g., out of stock).", "type": "array", "items": { "type": "integer" }, "example": [ 2500, 2500, -1, 56, 5499, -1, -1, 4647, -1, -1, 3367, 7, -1, -1, -1, 7, 48, 37323, 2500, -1, -1, -1, -1, -1, -1, -1, -1, -1, 1599, 219, -1, -1, -1, -1 ] }, "avg": { "description": "Contains the historical weighted mean for the interval specified in the product request’s `stats` parameter using the Price Type indexing. A value of -1 indicates no offer was available in the interval or insufficient data. ", "type": "array", "items": { "type": "integer" }, "example": [ 2512, 2582, -1, 139, 5499, -1, -1, 4742, -1, -1, 3755, 5, -1, -1, -1, -1, 48, 45366, 2512, -1, -1, -1, -1, -1, -1, -1, -1, -1, 1767, 808, -1, -1, -1, -1 ] }, "avg30": { "description": "Same as avg, but for the last 30 days.", "type": "array", "items": { "type": "integer" }, "example": [ 2512, 2582, -1, 139, 5499, -1, -1, 4742, -1, -1, 3755, 5, -1, -1, -1, -1, 48, 45366, 2512, -1, -1, -1, -1, -1, -1, -1, -1, -1, 1767, 808, -1, -1, -1, -1 ] }, "avg90": { "description": "Same as avg, but for the last 90 days.", "type": "array", "items": { "type": "integer" }, "example": [ 3425, 3378, 3127, 241, 5601, 4298, -1, 4859, -1, 3102, 4434, 5, 1, -1, 0, -1, 48, 45694, 3427, 3286, 3176, -1, 2639, -1, 4298, -1, -1, -1, 1767, 1284, -1, -1, 3279, -1 ] }, "avg180": { "description": "Same as avg, but for the last 180 days.", "type": "array", "items": { "type": "integer" }, "example": [ 3858, 3769, 3223, 221, 5800, 4130, -1, 5124, -1, 3212, 4638, 7, 1, -1, 0, -1, 48, 45067, 3858, 3293, 3184, 3074, 2639, -1, 4162, 2998, -1, -1, 5078, 1300, -1, -1, 3276, 3374 ] }, "avg365": { "description": "Same as avg, but for the last 365 days.", "type": "array", "items": { "type": "integer" }, "example": [ 4075, 3991, 3194, 211, 5813, 3929, -1, 5061, -1, 3185, 4584, 9, 1, -1, 1, -1, 48, 43833, 4074, 3271, 3132, 3074, 2639, -1, 4248, 3579, 2857, -1, 5899, 1300, -1, -1, 3269, 3374 ] }, "atIntervalStart": { "description": "Contains prices registered at the start of the interval specified in the product request’s `stats` parameter using the Price Type indexing. A value of -1 indicates no offer was available in the interval or insufficient data.", "type": "array", "items": { "type": "integer" }, "example": [ 2549, 2549, -1, 96, 5499, -1, -1, 4999, -1, -1, 4659, 4, -1, -1, -1, 4, 48, 47631, 2549, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 1701, -1, -1, -1, -1 ] }, "min": { "description": "Contain the lowest prices ever registered for this product. The first dimension uses the Price Type indexing. The second dimension is either null (no data available for the price type) or an array of size 2 with the first value being the time of the extreme point (in `Keepa Time minutes`) and the second value being the respective extreme value.", "type": "array", "items": { "type": "array", "items": { "type": "integer" } }, "example": [ [ 4709928, 2100 ], [ 3259414, 1 ], [ 5754116, 1825 ], [ 5182524, 2 ], [ 3651144, 3750 ], [ 3449544, 799 ], null, [ 3189672, 1 ], [ 3523616, 2449 ], [ 5735496, 1650 ], [ 6738682, 2099 ], [ 3543146, 1 ], [ 2338720, 1 ], [ 6539248, 0 ], [ 2412158, 1 ], null, [ 4647484, 42 ], [ 4647484, 16 ], [ 6738680, 2099 ], [ 4710276, 1995 ], [ 4710112, 1932 ], [ 4712932, 1969 ], [ 5799036, 1702 ], [ 3506622, 1665 ], [ 4837310, 1799 ], [ 3464492, 2495 ], [ 3526988, 2399 ], null, [ 3226628, 460 ], [ 7350370, 219 ], null, null, [ 6267992, 2400 ], [ 6718184, 2564 ] ] }, "max": { "description": "Contain the highest prices ever registered for this product.The first dimension uses the Price Type indexing. The second dimension is either null (no data available for the price type) or an array of size 2 with the first value being the time of the extreme point (in `Keepa Time minutes`) and the second value being the respective extreme value.", "type": "array", "items": { "type": "array", "items": { "type": "integer" } }, "example": [ [ 5633256, 5299 ], [ 3654504, 9999 ], [ 3778320, 4476 ], [ 2241840, 66517 ], [ 6609220, 5999 ], [ 2627856, 11600 ], null, [ 6247744, 10489 ], [ 6193860, 3349 ], [ 3779252, 4476 ], [ 4872696, 8997 ], [ 3088008, 120 ], [ 4846466, 8 ], [ 6539248, 0 ], [ 5459938, 26 ], null, [ 3464606, 50 ], [ 6882580, 48772 ], [ 6472404, 7047 ], [ 4249052, 4322 ], [ 3779252, 4476 ], [ 4249424, 3881 ], [ 4250884, 3308 ], [ 4870390, 8573 ], [ 3412840, 11699 ], [ 6004564, 5500 ], [ 6299472, 5465 ], null, [ 5230790, 7439 ], [ 3920522, 13000 ], null, null, [ 6604464, 3907 ], [ 6323572, 4632 ] ] }, "minInInterval": { "description": "Same as min, but restricted to the interval specified in the product request’s `stats` parameter.", "type": "array", "items": { "type": "array", "items": { "type": "integer" } }, "example": [ [ 7336466, 2500 ], [ 7336466, 2500 ], [ -1, -1 ], [ 7357514, 2 ], [ 7333196, 5499 ], [ -1, -1 ], null, [ 7333900, 4024 ], [ -1, -1 ], [ -1, -1 ], [ 7341912, 3318 ], [ 7333460, 1 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], null, [ 7333196, 48 ], [ 7366960, 34630 ], [ 7336466, 2500 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], null, [ 7365430, 1599 ], [ 7350370, 219 ], null, null, [ -1, -1 ], [ -1, -1 ] ] }, "maxInInterval": { "description": "Same as max, but restricted to the interval specified in the product request’s `stats` parameter.", "type": "array", "items": { "type": "array", "items": { "type": "integer" } }, "example": [ [ 7333288, 2679 ], [ 7333528, 6412 ], [ -1, -1 ], [ 7340398, 516 ], [ 7333196, 5499 ], [ -1, -1 ], null, [ 7344566, 5499 ], [ -1, -1 ], [ -1, -1 ], [ 7333528, 6412 ], [ 7347928, 9 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], null, [ 7333196, 48 ], [ 7366424, 47813 ], [ 7333288, 2679 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], [ -1, -1 ], null, [ 7335054, 1999 ], [ 7333196, 1701 ], null, null, [ -1, -1 ], [ -1, -1 ] ] }, "outOfStockPercentageInInterval": { "description": "Contains the out-of-stock percentage in the interval specified in the product request’s `stats` parameter using the Price Type indexing. A value of -1 indicates insufficient data or the Price Type is not a price. \n\nExamples: \n\n0: Never out of stock, \n\n100: Out of stock 100% of the time, \n\n25: Out of stock 25% of the time.", "type": "array", "items": { "type": "integer" }, "example": [ 3, 1, 100, -1, 1, 100, -1, 6, 100, 100, 10, -1, -1, -1, -1, -1, -1, -1, 3, 100, 100, 100, 100, 100, 100, 100, 100, -1, 25, 0, -1, -1, 100, 100 ] }, "outOfStockPercentage30": { "description": "Contains the 30-day out-of-stock percentage using the Price Type indexing. A value of -1 indicates insufficient data or the Price Type is not a price.", "type": "array", "items": { "type": "integer" }, "example": [ 3, 1, 100, -1, 1, 100, -1, 6, 100, 100, 10, -1, -1, -1, -1, -1, -1, -1, 3, 100, 100, 100, 100, 100, 100, 100, 100, -1, 25, 0, -1, -1, 100, 100 ] }, "outOfStockPercentage90": { "description": "Same as outOfStockPercentage30, but for the last 90 days.", "type": "array", "items": { "type": "integer" }, "example": [ 2, 1, 92, -1, 1, 84, -1, 3, 100, 93, 41, -1, -1, -1, -1, -1, -1, -1, 3, 96, 97, 100, 99, 100, 84, 100, 100, -1, 75, 3, -1, -1, 97, 100 ] }, "outOfStockPercentage180": { "description": "Same as outOfStockPercentage30, but for the last 180 days.", "type": "array", "items": { "type": "integer" }, "example": [ 1, 1, 87, -1, 1, 90, -1, 2, 100, 89, 21, -1, -1, -1, -1, -1, -1, -1, 2, 91, 97, 100, 100, 100, 91, 100, 100, -1, 61, 44, -1, -1, 93, 98 ] }, "outOfStockPercentage365": { "description": "Same as outOfStockPercentage30, but for the last 365 days.", "type": "array", "items": { "type": "integer" }, "example": [ 1, 1, 82, -1, 1, 87, -1, 2, 100, 84, 11, -1, -1, -1, -1, -1, -1, -1, 1, 88, 95, 100, 99, 100, 88, 100, 100, -1, 59, 73, -1, -1, 89, 99 ] }, "salesRankDrops30": { "description": "The count of sales rank drops (from high to low value) within the last 30 days, considered to indicate sales.", "type": "integer", "example": 115 }, "salesRankDrops90": { "description": "Same as salesRankDrops30, but for the last 90 days.", "type": "integer", "example": 427 }, "salesRankDrops180": { "description": "Same as salesRankDrops30, but for the last 180 days.", "type": "integer", "example": 935 }, "lastOffersUpdate": { "description": "The last time the offers information was updated (in `Keepa Time minutes`).", "type": "integer", "example": 7376384 }, "totalOfferCount": { "description": "The total count of offers for this product (all conditions combined). The offer count per condition can be found in the `current` field.", "type": "integer", "example": 7 }, "lightningDealInfo": { "description": "Used to identify a past, upcoming, or current lightning deal offer. The format is `[startDate, endDate]` (always an array of length 2 if not null). It is null if the product never had a lightning deal. Both timestamps are in UTC and `Keepa Time minutes`. If there is an upcoming lightning deal, only startDate is set (with endDate having a value of -1). If there is a current lightning deal, both startDate and endDate will be set, with startDate older than the current time and endDate in the future. If there is only a past deal, both startDate and endDate will be set in the past.", "type": "array", "items": { "type": "integer" }, "example": [ 6586980, 6589860 ] }, "lastBuyBoxUpdate": { "description": "Timestamp of the last buy box update, in KeepaTime.", "type": "integer", "example": 7376384 }, "buyBoxSellerId": { "description": "The seller ID of the buy box offer, if it exists. Otherwise, \"-1\", \"-2\", or null.", "type": "string", "example": "ATVPDKIKX0DER" }, "buyBoxPrice": { "description": "The buy box new price, if it exists. Otherwise, -1 or -2.", "type": "integer", "example": 2500 }, "buyBoxShipping": { "description": "The buy box new shipping cost, if it exists. Otherwise, -1 or -2.", "type": "integer", "example": 0 }, "buyBoxIsUnqualified": { "description": "Indicates whether a seller won the buy box. If only sellers with poor offers are available, none qualifies for the buy box.", "type": "boolean", "example": false }, "buyBoxIsShippable": { "description": "Indicates whether the buy box is listed as being shippable.", "type": "boolean", "example": true }, "buyBoxIsPreorder": { "description": "Indicates if the buy box is a pre-order.", "type": "boolean", "example": false }, "buyBoxIsBackorder": { "description": "Indicates if the buy box is back-ordered.", "type": "boolean", "example": false }, "buyBoxIsFBA": { "description": "Indicates whether the buy box is fulfilled by Amazon.", "type": "boolean" }, "buyBoxIsAmazon": { "description": "Indicates if Amazon is the seller in the buy box.", "type": "boolean" }, "buyBoxIsMAP": { "description": "Indicates if the buy box new price is hidden on Amazon due to MAP (Minimum Advertised Price) restrictions.", "type": "boolean" }, "buyBoxMinOrderQuantity": { "description": "The minimum order quantity of the buy box. -1 if not available, 0 if no limit exists.", "type": "integer", "example": 1 }, "buyBoxMaxOrderQuantity": { "description": "The maximum order quantity of the buy box. -1 if not available, 0 if no limit exists.", "type": "integer", "example": 3 }, "buyBoxAvailabilityMessage": { "description": "The availability message of the buy box. null if not available", "type": "string", "example": "In Stock." }, "buyBoxShippingCountry": { "description": "The default shipping country of the buy box seller. null if not available or if the seller is Amazon", "type": "string", "example": "US" }, "buyBoxIsPrimeExclusive": { "description": "Indicates if the buy box is Prime exclusive. null if not available.", "type": "boolean" }, "buyBoxIsPrimeEligible": { "description": "Indicates if the buy box is Prime eligible. null if not available.", "type": "boolean" }, "buyBoxIsPrimePantry": { "description": "Indicates if the buy box is a Prime Pantry offer. null if not available.", "type": "boolean" }, "buyBoxStats": { "description": "Contains buy box statistics for the specified interval. Each key represents the sellerId of the buy box seller, and each value is an object with statistics.", "type": "object", "example": { "ATVPDKIKX0DER": { "percentageWon": 97.09722, "avgPrice": 2512, "avgNewOfferCount": 1, "avgUsedOfferCount": -1, "isFBA": true, "lastSeen": 7376396 } }, "additionalProperties": { "properties": { "avgNewOfferCount": { "description": "Average \"New\" offer count during the time the seller held the Buy Box", "type": "integer", "example": 1 }, "avgPrice": { "description": "Average price of the Buy Box offer from this seller", "type": "integer", "example": 2512 }, "isFBA": { "description": "Whether this offer is fulfilled by Amazon", "type": "boolean" }, "lastSeen": { "description": "Last time the seller won the buy box (`Keepa Time minutes`)", "type": "integer", "example": 7376396 }, "percentageWon": { "description": "Percentage of time the seller won the buy box", "type": "number", "example": 97.09722 } }, "type": "object" } }, "buyBoxUsedStats": { "description": "Contains used buy box statistics for the specified interval. The format is the same as buyBoxStats.", "type": "object" }, "buyBoxUsedPrice": { "description": "The buy box used price, if available. Otherwise, -1 or null.", "type": "integer" }, "buyBoxUsedShipping": { "description": "The buy box used shipping cost, if available. Otherwise, -1 or null.", "type": "integer" }, "buyBoxUsedSellerId": { "description": "The seller ID of the used buy box offer, if available. Otherwise, null.", "type": "string", "example": "A2FP3WC79CXYXU" }, "buyBoxUsedIsFBA": { "description": "Indicates whether the used buy box is fulfilled by Amazon.", "type": "boolean" }, "buyBoxUsedCondition": { "description": "The offer sub-condition of the used buy box. \n\nValue: \n\n2 - Used - Like New, \n\n3 - Used - Very Good, \n\n4 - Used - Good, \n\n5 - Used - Acceptable.", "type": "integer" }, "retrievedOfferCount": { "description": "The count of retrieved offers for this request.", "type": "integer", "example": -2 }, "isAddonItem": { "description": "Indicates whether the product is an add-on item (ships with orders that include $25 or more of items shipped by Amazon).", "type": "boolean", "example": false }, "sellerIdsLowestFBA": { "description": "Contains the seller IDs (if any) of the lowest-priced live new FBA offers. Multiple entries exist if multiple offers share the same price.", "type": "array", "items": { "type": "string" }, "example": [ "A2FP3WC79CXYXU" ] }, "sellerIdsLowestFBM": { "description": "Contains the seller IDs (if any) of the lowest-priced live new FBM offers. Multiple entries exist if multiple offers share the same price.", "type": "array", "items": { "type": "string" }, "example": [ "A1TSKR6QH55IJL" ] }, "offerCountFBA": { "description": "The count of retrieved live new FBA offers, if available. Otherwise, -2.", "type": "integer", "example": 3 }, "offerCountFBM": { "description": "The count of retrieved live new FBM offers, if available. Otherwise, -2.", "type": "integer", "example": 4 }, "stockAmazon": { "description": "The stock of the Amazon offer, if available. Otherwise, undefined.", "type": "integer" }, "stockBuyBox": { "description": "The stock of the buy box offer, if available. Otherwise, undefined.", "type": "integer" } }, "type": "object" }, "KeepaProductCsv": { "type": "array", "items": { "type": "array", "items": { "type": "integer" } }, "example": [ [ 7345328, 2500 ], [ 7345328, 2500 ], [ 7303544, -1 ], [ 7371626, 29, 7372008, 30, 7372414, 31, 7372518, 35 ], [ 7339416, 5499 ], [ 7286744, -1 ], null, [ 7362962, 4647, 0 ], [ 6589860, -1 ], [ 7303544, -1 ], [ 7371726, 4936, 7374028, 4931 ], [ 7371574, 7 ], [ 7303544, -1 ], [ 6539280, -1 ], [ 7286744, -1 ], [ 7371726, 7, 7371828, 7, 7372108, 7, 7372314, 7 ], [ 7291578, 48 ], [ 7371112, 37306, 7372020, 37307, 7372108, 37310 ], [ 7345328, 2500, 0 ], [ 7303544, -1, -1 ], [ 7254502, -1, -1 ], [ 7155406, -1, -1 ], [ 7280358, -1, -1 ], [ 6832704, -1, -1 ], [ 7286744, -1, -1 ], [ 7216200, -1, -1 ], [ 7081318, -1, -1 ], null, [ 7365430, 1599, 0 ], [ 7350370, 159, 60 ], null, null, [ 7303544, -1, -1 ], [ 7245096, -1 ] ] }, "KeepaProductOffer": { "properties": { "offerId": { "description": "Unique ID of this offer (in the scope of the product). Not related to the offerIds used by Amazon, as those are user-specific and valid only for a short time. The offerId can be used to identify the same offers throughout requests.", "type": "integer", "example": 553 }, "lastSeen": { "description": "Indicates the last time Keepa have seen (and updated) this offer, in `Keepa Time minutes`. If you are only interested in live offers, use this field to verify that the offer is current.", "type": "integer", "example": 7376384 }, "sellerId": { "description": "The seller ID of the merchant.", "type": "string", "example": "A2FP3WC79CXYXU" }, "isPrime": { "description": "Whether or not this offer is available via Prime shipping. Keepa is unable to reliably identify SFP - Seller Fulfilled Prime.", "type": "boolean", "example": true }, "isFBA": { "description": "Whether or not this offer is fulfilled by Amazon.", "type": "boolean", "example": true }, "isMAP": { "description": "If the price of this offer is hidden on Amazon due to a MAP (“minimum advertised price”) restriction. Even if so, the offer object will contain the price and shipping costs.", "type": "boolean", "example": false }, "isShippable": { "description": "Boolean value indicating whether or not the offer is currently shippable. If not, this could mean, for example, that it is temporarily out of stock or a pre-order.", "type": "boolean", "example": true }, "isAddonItem": { "description": "Indicating whether or not the offer is an Add-on item.", "type": "boolean", "example": false }, "isPreorder": { "description": "Indicating whether or not the offer is a pre-order.", "type": "boolean", "example": false }, "isWarehouseDeal": { "description": "Indicating whether or not the offer is a Warehouse Deal.", "type": "boolean", "example": false }, "isScam": { "description": "Boolean value indicating whether or not Keepa system identified that the offering merchant attempts to scam users.", "type": "boolean", "example": false }, "shipsFromChina": { "description": "Boolean value indicating whether or not this offer’s seller default shipping location is China. This does not apply to FBA offers.", "type": "boolean", "example": false }, "isAmazon": { "description": "True if the seller is Amazon (e.g. “Amazon.com”). Note: Amazon’s Warehouse Deals seller account or other accounts Amazon is maintaining under a different name are not considered to be Amazon.", "type": "boolean", "example": false }, "isPrimeExcl": { "description": "This offer has a discounted Prime exclusive price.", "type": "boolean", "example": false }, "coupon": { "description": "Contains one-time coupon details of this offer. Undefined if none is available. Positive integer for an absolute discount or negative for a percentage discount. \n\n500 - Coupon with a $5 discount. \n\n-15 - Coupon with a 15% discount.", "type": "integer", "example": 500 }, "couponHistory": { "description": "Contains the coupon history of this offer, if available. It has the format `Keepa time minutes, coupon, […]`.", "type": "array", "items": { "type": "integer" }, "example": [ 6872588, 0 ] }, "condition": { "description": "The condition of the offered product. Integer value: \n\n0 - Unknown, \n\n1 - New, \n\n2 - Used - Like New, \n\n3 - Used - Very Good, \n\n4 - Used - Good, \n\n5 - Used - Acceptable, \n\n6 - Refurbished, \n\n7 - Collectible - Like New, \n\n8 - Collectible - Very Good, \n\n9 - Collectible - Good, \n\n10 - Collectible - Acceptable, \n\n11 - Rental. \n\nNote: Open Box conditions are coded as Used conditions.", "type": "integer", "example": 1 }, "conditionComment": { "description": "The describing text of the condition.", "type": "string", "example": "The item may come repackaged. Small cosmetic imperfection on top, […]" }, "offerCSV": { "description": "Contains the current price and shipping costs of the offer as well as, if available, the offer’s history. It has the format `Keepa time minutes, price, shipping cost, […]`. \n\nThe price and shipping cost are integers of the respective Amazon locale’s smallest currency unit (e.g. euro cents or yen). \n\nIf Keepa were unable to determine the price or shipping cost, they have the value -2. \n\nFree shipping has the shipping cost of 0. \n\nIf an offer is not shippable or has unspecified shipping costs, the shipping cost will be -1. \n\nTo get the newest price and shipping cost, access the last two entries of the array. \n\nMost recent price: `offerCSV[offerCSV.length - 2]` \n\nMost recent shipping cost: `offerCSV[offerCSV.length - 1]`", "type": "array", "items": { "type": "integer" }, "example": [ 7371726, 4999, 0, 7376384, 3367, 0 ] }, "stockCSV": { "description": "The stock history for this offer, provided the stock product request parameter was utilized. This data represents Keepa best attempt to determine the available stock quantity for this offer, though it may not always be accurate, such as in instances where per-customer limits apply. Stock data availability is not guaranteed. undefined if unavailable. It has the format `Keepa time minutes, stock, […]`.", "type": "array", "items": { "type": "integer" }, "example": [ 7371494, 1, 7376140, 2 ] }, "primeExclCSV": { "description": "Contains the Prime exclusive price history of this offer, if available. A Prime exclusive offer can only be ordered if the buyer has an active Prime subscription. It has the format `Keepa time minutes, price, […]`.", "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "KeepaProduct": { "properties": { "productType": { "description": "Must always be evaluated first. Determines what data for the product is available. Possible values: \n\n0 - STANDARD: Everything accessible \n\n1 - DOWNLOADABLE: No marketplace offers data \n\n2 - EBOOK: No marketplace offers data \n\n3 - INACCESSIBLE: No price, rating and offers data accessible. Sales rank and offer count data is updated less frequently. Some fields may be missing. \n\n4 - INVALID: No current data available due to invalid or deprecated ASIN, or other issues. Might be temporary. \n\n5 - VARIATION_PARENT: Product is a parent ASIN. variations is set.", "type": "integer", "example": 0 }, "asin": { "description": "The ASIN of the product.", "type": "string", "example": "B00U26V4VQ" }, "domainId": { "description": "The domainId of the product’s Amazon locale. Possible values: [ 1: com | 2: co.uk | 3: de | 4: fr | 5: co.jp | 6: ca | 8: it | 9: es | 10: in | 11: com.mx ]", "type": "integer", "example": 1 }, "title": { "description": "Title of the product. Caution: may contain unescaped HTML markup in rare cases.", "type": "string", "example": "CATAN Board Game - Embark on a Journey of Discovery and Trade! Civilization Building Strategy Game, Family Game for Kids & Adults, Ages 10+, 3-4 Players, 60-90 Minute Playtime, Made by CATAN Studio" }, "trackingSince": { "description": "States the time Keepa have started tracking this product, in `Keepa Time minutes`.", "type": "integer", "example": 2240940 }, "listedSince": { "description": "States the time the item was first listed on Amazon, in `Keepa Time minutes`. This timestamp is only available for some products. If not available, the field has the value 0 or -1.", "type": "integer", "example": 346862 }, "lastUpdate": { "description": "States the last time Keepa have updated the information for this product, in `Keepa Time minutes`.", "type": "integer", "example": 7376140 }, "lastRatingUpdate": { "description": "States the last time Keepa have updated the product rating and review count, in `Keepa Time minutes`.", "type": "integer", "example": 7376140 }, "lastPriceChange": { "description": "States the last time Keepa have registered a price change (any price type), in `Keepa Time minutes`.", "type": "integer", "example": 7374028 }, "lastEbayUpdate": { "description": "States the last time Keepa have updated the eBay prices for this product, in `Keepa Time minutes`. If no matching products were found, the integer is negative.", "type": "integer", "example": 7374894 }, "lastStockUpdate": { "description": "The most recent update of the stock data for this product’s offers, in `Keepa Time minutes`. This field is undefined unless the stock parameter was used and stock data was collected at least once.", "type": "integer", "example": 7349428 }, "imagesCSV": { "description": "CSV list of Amazon image names of the product. null if not available. Note that the variant images (all images after the primary/first one) are not necessarily in the same order as on Amazon.", "type": "string", "example": "81zZW70yiYL.jpg,81SkwdTQypL.jpg,916rkTg6h0L.jpg,81tqU4Hr-fL.jpg,91iOb49w2fL.jpg,81rSEZZBGzL.jpg,81cnasxCU0L.jpg,51Czq2ni9IL.jpg" }, "rootCategory": { "description": "Category node ID of the product’s root category. 0 if no root category known. The ID 9223372036854775807 (max signed long value) denotes a blank category with the name “?”. Keepa use this in cases where a product is listed in no or non-existent categories.", "type": "integer", "example": 165793011 }, "categories": { "description": "Array of Amazon category node IDs this product is listed in. Can be empty.", "type": "array", "items": { "type": "integer" }, "example": [ 166225011, 19520348011, 21394470011, 19419995011, 9765225011, 24996084011, 14052186011, 119186712011, 23717031011, 24417464011, 11308668011, 23946859011, 13443194011, 19419985011 ] }, "categoryTree": { "description": "Represents the category tree as an ordered array of objects, each consisting of two fields: catId - Long - the category ID, name - String - the name of the category", "type": "array", "items": { "properties": { "catId": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "example": [ { "catId": 165793011, "name": "Toys & Games" }, { "catId": 166220011, "name": "Games & Accessories" }, { "catId": 166225011, "name": "Board Games" } ] }, "parentAsin": { "description": "The ASIN of the parent product (if the product has variations, otherwise null).", "type": "string", "example": "B00M0QVG3W" }, "parentAsinHistory": { "description": "The history of the parentAsin field. This array has the format: [keepaTime, previous parent ASIN, …]. The timestamp indicates when the previously associated parentAsin ceased to be valid. For the current parent ASIN, use the parentAsin field. undefined if the parentAsin field never changed. Keepa started tracking parentAsin changes on March 18th 2024.", "type": "array", "items": { "type": "string" }, "example": [ "7367094", "B0CTP7MWMF" ] }, "variations": { "description": "Contains the variations of this product. Each object in the array represents a single variation. A variation object consists of the variation ASIN and an attributes array, where each entry represents one variation theme, including a dimension and its corresponding value. To request live data for this field, the offers parameter must be used.", "type": "array", "items": { "properties": { "asin": { "type": "string" }, "attributes": { "type": "array", "items": { "properties": { "dimension": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } } }, "type": "object" }, "example": [ { "asin": "B07GFPNJL9", "attributes": [ { "dimension": "Size", "value": "7.24 LB" }, { "dimension": "FlavorName", "value": "Cheddar" } ] } ] }, "frequentlyBoughtTogether": { "description": "One or two “Frequently Bought Together” ASINs. null if not available.", "type": "array", "items": { "type": "string" }, "example": [ "B00U26V9CU", "B00U26V4S4" ] }, "upcList": { "description": "A list of UPCs assigned to this product. The first index is the primary UPC. null if not available.", "type": "array", "items": { "type": "string" }, "example": [ "029877030712" ] }, "eanList": { "description": "A list of EANs assigned to this product. The first index is the primary EAN. null if not available.", "type": "array", "items": { "type": "string" }, "example": [ "0029877030712" ] }, "manufacturer": { "description": "Name of the manufacturer. null if not available.", "type": "string", "example": "Asmodee" }, "brand": { "description": "An item’s brand. null if not available.", "type": "string", "example": "Catan" }, "productGroup": { "description": "The item’s productGroup. null if not available.", "type": "string", "example": "Toy" }, "type": { "description": "The item’s productType. null if not available.", "type": "string", "example": "BOARD_GAME" }, "partNumber": { "description": "The item’s partNumber. null if not available.", "type": "string", "example": "CN3071" }, "binding": { "description": "The item’s binding. null if not available. If the item is not a book, it is usually the product category instead.", "type": "string", "example": "Board Game" }, "numberOfItems": { "description": "The number of items of this product. -1 if not available.", "type": "integer", "example": 1 }, "numberOfPages": { "description": "The number of pages of this product. -1 if not available.", "type": "integer", "example": 514 }, "publicationDate": { "description": "The item’s publication date in one of the following three formats: YYYY or YYYYMM or YYYYMMDD (Y = year, M = month, D = day). -1 if not available.", "type": "integer", "example": 20150409 }, "releaseDate": { "description": "The item’s release date. Same format as publicationDate. -1 if not available.", "type": "integer", "example": 20150423 }, "contributors": { "description": "The contributors of the item. A contributor can be an author, actor, director, etc. Each contributor entry has a name and a role type.", "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "example": [ [ "Vin Diesel", "actor" ] ] }, "languages": { "description": "An item can have one or more languages. Each language entry has a name and most also have a type. null if not available.", "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "example": [ [ "English" ], [ "English", "Original Language" ] ] }, "model": { "description": "The item’s model. null if not available.", "type": "string", "example": "CN3071" }, "color": { "description": "The item’s color. null if not available.", "type": "string", "example": "Multicolor" }, "size": { "description": "The item’s size. null if not available.", "type": "string", "example": "One Size" }, "edition": { "description": "The item’s edition. null if not available.", "type": "string", "example": "Standard Edition" }, "format": { "description": "The item’s format. null if not available.", "type": "string", "example": "AC-3" }, "features": { "description": "A list of up to 5 product features / bullet points. null if not available. An entry can contain HTML markup in rare cases. Keepa currently limit each entry to a maximum of 1000 characters (if the feature is longer it will be cut off). This limitation may change in the future without prior notice.", "type": "array", "items": { "type": "string" }, "example": [ "EXPLORE CATAN: Set sail to the uncharted island of Catan and compete with other settlers to establish supremacy.", "RESOURCE MANAGEMENT: Strategically gather and trade resources like ore, brick, lumber, grain, and wool to expand your settlements.", "BUILD AND UPGRADE: Use your resources to build roads, settlements, and cities to earn victory points.", "DYNAMIC GAMEPLAY: Roll the dice to collect resources based on terrain hexes, and employ clever tactics to outmaneuver your opponents.", "CLASSIC GAME: Celebrate the 25th anniversary of CATAN, a timeless strategy board game loved by players worldwide." ] }, "description": { "description": "A description of the product. null if not available. May contain HTML markup and newlines. Keepa limit the product description to a maximum of 4000 characters (if the description is longer it will be cut off). This limitation may change in the future without prior notice. To request live data for this field the offers parameter must be used.", "type": "string", "example": "Your adventurous settlers seek to tame the remote but rich isle of Catan. Start by revealing Catan's many harbors and regions: pastures, fields, mountains, hills, forests, and desert. The random mix creates a different board virtually every game. Guide your settlers to victory by clever trading and cunning development. Use resource combinations- grain, wool, ore, brick, and lumber-to buy handy development cards and build roads, settlements, and cities. Acquire your resources through trades,cards, or lucky dice (even outside your turn). But beware! Someone might cut off your road or buy a monopoly. And you never know when the wily robber might steal some of your precious gains! Catan((aka The Settlers of Catan) has been awarded with \"Game of the Year,\" \"Hall of Fame,\" and even \"Game of the Century\" honors in Germany, the United States, and a host of other countries worldwide. An international favorite, it's been called the \"Perfect Social Game.\" Catan contains: 19 unique hexagonal terrain tile, 6 coastal frame pieces, 9 extra harbor pieces, 20 wooden settlements, 16 wooden cities, 60 wooden roads, 95 resource cards, 25 development cards, 4 building costs cards, 2 special bonus cards, 18 number tokens, 2 six-sided dice, 1 wooden robber pawn, simple rules & almanac." }, "hazardousMaterials": { "description": "The hazardous material types of the product. undefined if not available. Each entry consists of two fields: aspect - String, value - String.", "type": "array", "items": { "properties": { "aspect": { "type": "string", "example": "proper_shipping_name" }, "value": { "type": "string", "example": "AEROSOLS" } }, "type": "object" } }, "packageHeight": { "description": "The package’s height in millimeters. 0 or -1 if not available.", "type": "integer", "example": 81 }, "packageLength": { "description": "The package’s length in millimeters. 0 or -1 if not available.", "type": "integer", "example": 296 }, "packageWidth": { "description": "The package’s width in millimeters. 0 or -1 if not available.", "type": "integer", "example": 240 }, "packageWeight": { "description": "The package’s weight in grams. 0 or -1 if not available.", "type": "integer", "example": 1222 }, "packageQuantity": { "description": "Quantity of items in the package. 0 or -1 if not available.", "type": "integer", "example": 1 }, "itemHeight": { "description": "The item’s height in millimeters. 0 or -1 if not available.", "type": "integer", "example": 84 }, "itemLength": { "description": "The item’s length in millimeters. 0 or -1 if not available.", "type": "integer", "example": 300 }, "itemWidth": { "description": "The item’s width in millimeters. 0 or -1 if not available.", "type": "integer", "example": 241 }, "itemWeight": { "description": "The item’s weight in grams. 0 or -1 if not available.", "type": "integer", "example": 907 }, "availabilityAmazon": { "description": "Availability of the Amazon offer. Possible values: \n\n-1: no Amazon offer exists, \n\n0: Amazon offer is in stock and shippable, \n\n1: Amazon offer is currently not in stock, but will be in the future (pre-order), \n\n2: Amazon offer availability is “unknown”, \n\n3: Amazon offer is currently not in stock, but will be in the future (back-order), \n\n4: Amazon offer shipping is delayed - see “availabilityAmazonDelay” for more details.", "type": "integer", "example": 3 }, "availabilityAmazonDelay": { "description": "If availabilityAmazon has the value 4, this field will provide the delay interval in hours. null if no data is available.", "type": "array", "items": { "type": "integer" }, "example": [ 0, 0 ] }, "buyBoxEligibleOfferCounts": { "description": "If buyBoxEligibleOfferCounts is available, it represents an array of integers, each entry indicating the total number of offers eligible for the Buy Box across specified offer conditions and fulfillment channels. This array contains eight elements, indexed as follows: \n\n0: New FBA, \n\n1: New FBM, \n\n2: Used FBA, \n\n3: Used FBM, \n\n4: Collectible FBA, \n\n5: Collectible FBM, \n\n6: Refurbished FBA, \n\n7: Refurbished FBM.", "type": "array", "items": { "type": "integer" }, "example": [ 3, 2, 0, 0, 0, 0, 0, 0 ] }, "competitivePriceThreshold": { "description": "The competitivePriceThreshold field is a price based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller’s price + shipping is greater than this competitive price. Undefined if it has no value.", "type": "integer", "example": 2500 }, "suggestedLowerPrice": { "description": "The suggested lower price of the item, including shipping. The suggested lower price is based on a range of factors, including historical selling prices, recent Buy Box-eligible prices, and input from customers. Undefined if it has no value.", "type": "integer" }, "ebayListingIds": { "description": "Contains the lowest priced matching eBay listing Ids. Always contains two entries, the first one is the listing id of the lowest priced listing in new condition, the second in used condition. null or 0 if not available.", "type": "array", "items": { "type": "integer" }, "example": [ 710151859, 325289877142 ] }, "isAdultProduct": { "description": "Indicates if the item is considered to be for adults only.", "type": "boolean", "example": false }, "isHeatSensitive": { "description": "Indicates if the item is heat sensitive (e.g. meltable).", "type": "boolean", "example": false }, "isMerchOnDemand": { "description": "True if this product is an Amazon Merch on Demand product. undefined otherwise.", "type": "boolean", "example": true }, "isHaul": { "description": "True if this product is an Amazon Haul product. undefined otherwise. Only basic product information is available for Amazon Haul products.", "type": "boolean", "example": true }, "ingredients": { "description": "The ingredient list of the product. undefined if not available.", "type": "string", "example": "Purified Carbonated Water, Natural Flavors" }, "launchpad": { "description": "Indicates if the item is listed in the launchpad category. If so, the `salesRankReference` will not be available.", "type": "boolean", "example": true }, "audienceRating": { "description": "Audience rating. The rating suggests the age for which the media is appropriate.", "type": "string", "example": "PG-13 (Parents Strongly Cautioned)" }, "urlSlug": { "description": "The product listing URL slug.", "type": "string", "example": "CATAN-Board-Game-Discovery-Civilization" }, "returnRate": { "description": "This field provides information about the customer return rate for a product. The possible values are: \n\nnull: The return rate is either unavailable or considered average. \n\n1: The product has a low return rate. \n\n2: The product has a high return rate.", "type": "integer" }, "newPriceIsMAP": { "description": "Whether or not the lowest new price (either price type AMAZON or NEW) is restricted by MAP (Minimum Advertised Price). Use this to differentiate out of stock (price = -1) vs. MAP restriction.", "type": "boolean", "example": true }, "isEligibleForTradeIn": { "description": "Whether or not the product is eligible for trade-in.", "type": "boolean", "example": false }, "isEligibleForSuperSaverShipping": { "description": "Whether or not the product’s buy box is eligible for free shipping.", "type": "boolean", "example": false }, "fbaFees": { "properties": { "pickAndPackFee": { "description": "The FBA pick & pack fees of this product. The pickAndPackFee is determined by either the current price or, in the absence of a current offer, the previous one. If neither of these prices is available for reference, the fee percent is calculated based on a standard sales price of 100.00. Fees are integers of the respective Amazon locale’s smallest currency unit (e.g. euro cents or yen). null if not available.", "type": "integer", "example": 661 } }, "type": "object" }, "variableClosingFee": { "description": "The variable closing fee. Fees are integers of the respective Amazon locale’s smallest currency unit (e.g. euro cents or yen). Undefined if it has no value.", "type": "integer", "example": 81 }, "referralFeePercentage": { "description": "The Amazon seller referral fee percent is determined by either the current price or, in the absence of a current offer, the previous one. If neither of these prices is available for reference, the fee percent is calculated based on a standard sales price of 100.00. null if not available.", "type": "integer", "example": 15 }, "coupon": { "description": "Contains coupon details for the buy box offer of the product, if available. null if not available. An integer array with two entries: \n\nThe first entry is the discount for a one-time coupon. \n\nThe second entry is a subscribe and save coupon. \n\nEntry value is either 0 if no coupon of that type is offered, positive for an absolute discount, or negative for a percentage discount. The coupons field is always accessible, but only updated if the offers parameter was used in the Product Request.", "type": "array", "items": { "type": "integer" }, "example": [ 200, -15 ] }, "couponHistory": { "description": "Contains historical values for the coupon field, if available. null if not available. Keepa started tracking coupon history on June 15th 2024. Format: `[ keepaTime, one-time coupon, subscribe and save coupon, keepaTime, … ]`", "type": "array", "items": { "type": "integer" }, "example": [ 7339566, 461, 0, 7340010, 0, 0, 7356384, 625, 0 ] }, "promotions": { "description": "Contains an array of active promotions. Not all product promotions can be provided. A promotion object consists of: type - String - The type of promotion, amount - Integer - The discounted price, discountPercent - Integer - The discount percent.", "type": "array", "items": { "properties": { "type": { "description": "The type of promotion", "type": "string", "example": "SNS" }, "amount": { "description": "The discounted price", "type": "integer", "example": 100 }, "discountPercent": { "description": "The discount percent", "type": "integer", "example": 10 } }, "type": "object" } }, "unitCount": { "description": "Object that contains unit count data, Undefined if it has no value.", "properties": { "unitValue": { "description": "The field returns the specified weight or volume to facilitate per unit pricing. For products measured by volume, weight, or linear dimensions, it provides the total net quantity shipped for a single ASIN (e.g., a 12-pack of 6 fl oz bottles of water = 72 fl oz, or a single 2-liter bottle = 2 liters). For products sold as individual units, it returns the total number of units (e.g., a pack of 12 pens = 12).", "type": "number", "format": "double", "example": 1 }, "unitType": { "description": "In cases where the product being sold is measured in units that are relevant to the customer’s purchasing decision, the unitType specifies the type of measurement used. For example, a bottle of soda may be measured in fluid ounces, while a box of screws is measured by the number of screws in the box.", "type": "string", "example": "Count" }, "eachUnitCount": { "description": "The number of units in an ‘each’; where an ‘each’ refers to the smallest component of a product with a UPC, and a unit defines how this ‘each’ is measured.", "type": "number", "format": "double" } }, "type": "object" }, "salesRankReference": { "description": "The category node id of the main sales rank. -1 if not available, -2 if listed in launchpad.", "type": "integer", "example": 165793011 }, "salesRankReferenceHistory": { "description": "A long array containing the historical category node id(s) of the main sales rank. This data, if available, can be used to match historical sales ranks provided in the CSV field to their reference category. The category id has the value -1 if not available or -2 if listed in launchpad. Format: `[ keepaTime, category node id, … ]`", "type": "array", "items": { "type": "integer" }, "example": [ 7333764, 165793011 ] }, "salesRanks": { "description": "An object containing sales rank histories. Each key represents the categoryId of the rank, with the history in the corresponding value.", "type": "object", "example": { "165793011": [ 7371626, 29, 7372008, 30, 7372414, 31, 7372518, 35 ], "166225011": [ 7369930, 1, 7375618, 3, 7375864, 2, 7376008, 3, 7376106, 2 ] }, "additionalProperties": { "type": "array", "items": { "type": "integer" } } }, "lastSoldUpdate": { "description": "States the last time Keepa have updated the monthlySold field, in `Keepa Time minutes`. Undefined if the monthlySold has no value.", "type": "integer", "example": 7376384 }, "monthlySold": { "description": "How often this product was bought in the past month. This field represents the bought past month metric found on Amazon search result pages. It is not an estimate. Amazon only provides the data in bracketed ranges such as “50+” or “100+”, rather than as exact figures. Undefined if it has no value. Most ASINs do not have this value set. The value is variation specific.", "type": "integer", "example": 20000 }, "monthlySoldHistory": { "description": "Contains historical values of the monthlySold field. Undefined if it has no value. Format: `[ keepaTime, monthlySold, … ]`", "type": "array", "items": { "type": "integer" }, "example": [ 7375948, 20000, 7375956, 30000, 7376044, 20000, 7376052, 30000, 7376136, 20000 ] }, "rentalDetails": { "description": "Contains the rental details description of the rental buy box offer. null if not available. Accessible only if the offers and rental parameters were used in the Product Request.", "type": "string", "example": "Rented from: RentU Rental Price One Semester: $25.24 Extension Prices 15 Day: $12.61 Additional Semester: $25.24 Buyout Price: $34.89. Any rental and extension fees paid will be applied towards the buyout price of the book." }, "rentalSellerId": { "description": "Contains the seller id of the rental buy box offer. null if not available. Accessible only if the offers and rental parameters were used in the Product Request.", "type": "string", "example": "A2L77EE7U53NWQ" }, "rentalPrices": { "description": "This object contains the rental prices (as described in the rentalDetails field) initialPrice, shortExtnPrice, longExtnPrice, and fullPrice. null if not available. Accessible only if the offers and rental parameters were used in the Product Request.", "type": "object", "example": null, "additionalProperties": { "type": "integer" } }, "reviews": { "description": "This object contains variation specific review and rating counts histories as well as a last update timestamp. null if not available. It is not possible to force an update to the reviews object data. For non-variation specific ratings and review data access the csv field. Accessible only if the rating parameter was used in the Product Request.", "properties": { "lastUpdate": { "description": "The last update timestamp in `Keepa Time minutes`.", "type": "integer", "example": 7365044 }, "ratingCount": { "description": "Variation specific rating counts history. Format: `[ keepaTime, ratingCount, … ]`", "type": "array", "items": { "type": "integer" }, "example": [ 7353286, 34550, 7363060, 34590, 7365044, 34608 ] }, "reviewCount": { "description": "Variation specific review counts history. Format: `[ keepaTime, reviewCount, … ]`", "type": "array", "items": { "type": "integer" }, "example": [ 7335552, 5383, 7339328, 5385, 7349412, 5393, 7353286, 5396, 7363060, 5408, 7365044, 5411 ] } }, "type": "object" }, "liveOffersOrder": { "description": "Optional field, set only if the offers parameter was used in the Product Request. Contains an ordered array of index positions in the offers array for all Marketplace Offer Objects retrieved for this call. If no offers were found, the field will be null. The sequence of integers reflects the ordering of the offers on the Amazon offer page (for all conditions). Since the offers field contains historical offers as well as current offers, one can use this array to look up all offers that are currently listed on Amazon in the correct order. Note: If there are identical offers (same seller, same condition, same shipping type, and same condition text) Keepa only track the lowest-priced one. If this happens, there will be duplicate offer indexes in the liveOffersOrder field at the position of the omitted duplicate (higher-priced) offer - all pointing to the lowest-priced offer’s index.\n\nExample: [ 3, 5, 2, 18, 15 ] - The offer with the array index 3 of the offers field is currently the first one listed on the offer listings page on Amazon, followed by the offer with the index 5, and so on.\n\nExample with duplicates: [ 3, 5, 2, 18, 5 ] - The second offer, as listed on Amazon, is a lower-priced duplicate of the 5th offer on Amazon. The lower-priced one is included in the offers field at index 5.", "type": "array", "items": { "type": "integer" }, "example": [ 0, 1, 2, 3, 4, 5, 6 ] }, "buyBoxSellerIdHistory": { "description": "Optional field, set only if the offers or buybox parameter was used in the Product Request. Contains a history of sellerIds that held the Buy Box in the format: `Keepa time minutes, sellerId, […]`. If no seller qualified for the Buy Box, the sellerId “-1” is used (suppressed Buy Box). If Keepa were unable to identify the seller or if the product was out of stock (no seller), the sellerId is “-2”.", "type": "array", "items": { "type": "string" }, "example": [ "7339514", "ATVPDKIKX0DER" ] }, "buyBoxUsedHistory": { "description": "Optional field, set only if the offers or buybox parameter was used in the Product Request. A history of used buy box winners, containing the sellerIds, offer sub-condition, and FBA status in the format: `Keepa time minutes, seller id, condition, isFBA, […]`. If no seller qualified for the used buy box, the sellerId “” (empty String) is used.\n\nCondition can have the following values:\n\n“2” - Used - Like New, “3” - Used - Very Good, “4” - Used - Good, “5” - Used - Acceptable\n\nisFBA is either “1” - offer is FBA or “0” - offer is merchant fulfilled.", "type": "array", "items": { "type": "string" }, "example": [ "2860926", "ATVPDKIKX0DER", "4", "1" ] }, "isRedirectASIN": { "description": "Valid only if the offers parameter was used in the Product Request. Boolean indicating if the ASIN will be redirected to another one on Amazon (example: the ASIN has the color black variation, which is not available and is redirected on Amazon to the color red).", "type": "boolean", "example": false }, "isSNS": { "description": "Valid only if the offers parameter was used in the Product Request. Boolean indicating if the product’s Buy Box is available for subscribe and save.", "type": "boolean", "example": false }, "offersSuccessful": { "description": "Valid only if the offers parameter was used in the Product Request. Boolean indicating if the system was able to retrieve fresh offer information. Retrieval of fresh offers will always fail if the product has no offers (compare COUNT_* csv entries).", "type": "boolean", "example": true }, "offers": { "description": "Optional field, set only if the `offers` parameter was used. Contains Marketplace Offer Objects.", "type": "array", "items": { "$ref": "#/components/schemas/KeepaProductOffer" } }, "stats": { "$ref": "#/components/schemas/KeepaProductStats", "description": "Contains a Statistics Object." }, "csv": { "$ref": "#/components/schemas/KeepaProductCsv", "description": "A two-dimensional history array containing the product’s historical data. Access the first dimension index using the following enum/constants: \n\n0 - AMAZON, \n\n1 - NEW, \n\n2 - USED, \n\n3 - SALES, \n\n4 - LISTPRICE, \n\n5 - COLLECTIBLE, \n\n6 - REFURBISHED, \n\n7 - NEW_FBM_SHIPPING, \n\n8 - LIGHTNING_DEAL, \n\n9 - WAREHOUSE, \n\n10 - NEW_FBA, \n\n11 - COUNT_NEW, \n\n12 - COUNT_USED, \n\n13 - COUNT_REFURBISHED, \n\n14 - COUNT_COLLECTIBLE, \n\n15 - EXTRA_INFO_UPDATES, \n\n16 - RATING, \n\n17 - COUNT_REVIEWS, \n\n18 - BUY_BOX_SHIPPING, \n\n19 - USED_NEW_SHIPPING, \n\n20 - USED_VERY_GOOD_SHIPPING, \n\n21 - USED_GOOD_SHIPPING, \n\n22 - USED_ACCEPTABLE_SHIPPING, \n\n23 - COLLECTIBLE_NEW_SHIPPING, \n\n24 - COLLECTIBLE_VERY_GOOD_SHIPPING, \n\n25 - COLLECTIBLE_GOOD_SHIPPING, \n\n26 - COLLECTIBLE_ACCEPTABLE_SHIPPING, \n\n27 - REFURBISHED_SHIPPING, \n\n28 - EBAY_NEW_SHIPPING, \n\n29 - EBAY_USED_SHIPPING, \n\n30 - TRADE_IN, \n\n31 - RENTAL, \n\n32 - BUY_BOX_USED_SHIPPING, \n\n33 - PRIME_EXCL. \n\nThe second dimension contains the price/value history in the format `Keepa time minutes, value, […]` or, if the type includes `*_SHIPPING` costs, the format: `Keepa time minutes, price, shipping costs, […]`. If history is unavailable, it is `null`. The price is an integer of the respective Amazon locale’s smallest currency unit (e.g., euro cents or yen). If no offer was available in the given interval (e.g., out of stock), the price has the value -1. \n\nImportant csv information: \n\nKeepa only append a new entry to the history array if the price/value changed, not every time Keepa update the product. \n\nShipping and Handling costs are not included unless specified. \n\nAmazon is considered to be part of the marketplace. If Amazon has the overall lowest new price, the marketplace new price in the corresponding time interval is identical to the Amazon price. \n\nThe following types are only set if the offers parameter was used in the Product Request: NEW_FBM_SHIPPING, WAREHOUSE, NEW_FBA, RATING, COUNT_REVIEWS, BUY_BOX_SHIPPING, USED_SHIPPING, COLLECTIBLE_SHIPPING, REFURBISHED_SHIPPING, BUY_BOX_USED_SHIPPING, and PRIME_EXCL \n\nAbout Lightning deals: If a deal is currently active, the last entry of the history array will contain the end date (a future date) with a price of -1. When accessing the current deal price, handle this special case. Alternatively, use the current price array of the stats object to access the current price. If no deal is currently active but the last entry has the value -1 with a date in the future, it means an upcoming deal is announced (scheduled to start at that date). \n\nAbout eBay prices: eBay listings often have incorrect information and/or product codes, causing item mismatches and incorrect pricing information. Use eBay price history information with caution and do not rely on their accuracy. Keepa update eBay prices at different intervals than Amazon prices. \n\nKeepa can add new data types to the csv field from time to time without announcement. Do not expect a fixed size of the first array dimension in your implementation." } }, "type": "object" }, "GetKeepaProductInternalApiError": { "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get Keepa product" }, "trace_id": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "SearchKeepaProductsResponse": { "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/KeepaProduct" } } }, "type": "object" }, "SearchKeepaProductsInternalApiError": { "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to search Keepa products" }, "trace_id": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "QueryKeepaProductsResponse": { "properties": { "asinList": { "description": "Ordered array with the result ASINs", "type": "array", "example": [ "B0C9F1QRKR", "B00U26V4VQ", "B0DYK1ZH2D" ] }, "searchInsights": { "$ref": "#/components/schemas/SearchInsightsObject", "description": "Aggregated metrics calculated over matched products: Search Insights Object. Requires the &stats=1 parameter." }, "totalResults": { "description": "Estimated count of all matched products.", "example": 137 } }, "type": "object" }, "SearchInsightsObject": { "properties": { "avgDeltaPercent30BuyBox": { "description": "Average percentage change in Buy Box price over last 30 days. Positive = cheaper, negative = more expensive", "type": "number", "format": "float", "example": -0.12 }, "avgDeltaPercent90BuyBox": { "description": "Average percentage change in Buy Box price over last 90 days. Positive = cheaper, negative = more expensive", "type": "number", "format": "float", "example": -0.12 }, "avgDeltaPercent30Amazon": { "description": "Average percentage change in Amazon price over last 30 days. Positive = cheaper, negative = more expensive", "type": "number", "format": "float", "example": -0.12 }, "avgDeltaPercent90Amazon": { "description": "Average percentage change in Amazon price over last 90 days. Positive = cheaper, negative = more expensive", "type": "number", "format": "float", "example": -0.12 }, "avgBuyBox": { "description": "Average current Buy Box price across all selling products (in smallest currency unit)", "type": "integer", "example": 6711 }, "avgBuyBox90": { "description": "Average 90-day Buy Box price across all selling products (in smallest currency unit)", "type": "integer", "example": 6711 }, "avgBuyBox365": { "description": "Average 365-day Buy Box price across all selling products (in smallest currency unit)", "type": "integer", "example": 6711 }, "avgBuyBoxDeviation": { "description": "Average deviation of Buy Box price over last 30 days (short-term price volatility in smallest currency unit)", "type": "integer" }, "avgReviewCount": { "description": "Average number of reviews of all products in this category", "type": "integer" }, "avgRating": { "description": "Average rating of all products in this category (45 = 4.5 stars)", "type": "integer", "example": 45 }, "isFBAPercent": { "description": "Share of products whose current Buy Box offer is Fulfilled by Amazon (0.0 to 100.0)", "type": "number", "format": "float", "example": 78.3 }, "soldByAmazonPercent": { "description": "Share of products currently sold by Amazon (0.0 to 100.0)", "type": "number", "format": "float" }, "hasCouponPercent": { "description": "Share of products that have an active coupon (0.0 to 100.0)", "type": "number", "format": "float" }, "avgOfferCountNew": { "description": "Average number of new offers per product (excludes out-of-stock)", "type": "number", "format": "float" }, "avgOfferCountUsed": { "description": "Average number of used offers per product (excludes out-of-stock)", "type": "number", "format": "float" }, "sellerCount": { "description": "Total number of distinct sellers with at least one live offer", "type": "integer" }, "brandCount": { "description": "Total number of distinct brands represented", "type": "integer" }, "highestRank": { "description": "The worst (numerically highest) Sales Rank among all matched products", "type": "integer" }, "lowestRank": { "description": "The best (numerically lowest) Sales Rank among all matched products", "type": "integer" }, "relatedCategories": { "description": "Array of related category IDs", "type": "array", "items": { "type": "integer", "format": "int64" } }, "topBrandsWithCounts": { "description": "Up to five most common brands and their product counts (brand name => count)", "type": "object", "example": { "BrandA": 136, "BrandB": 1 }, "additionalProperties": { "type": "integer" } }, "topSellersWithCounts": { "description": "Up to five seller IDs that hold the Buy Box most often, plus occurrence counts (seller ID => count)", "type": "object", "example": { "ATVPDKIKX0DER": 30, "A1BFYBTNOR3LMJ": 22, "A3L2KOXEXJZT5E": 15 }, "additionalProperties": { "type": "integer" } } }, "type": "object" }, "QueryKeepaProductsInternalApiError": { "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to query Keepa products" }, "trace_id": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "PutListingsItemRequest": { "required": [ "asin", "price", "currency", "condition" ], "properties": { "asin": { "description": "Existing ASIN associated with product. Must be not parent ASIN.", "type": "string", "example": "B00U26V4VQ" }, "price": { "description": "Selling price", "type": "number", "format": "float", "example": 40.33 }, "currency": { "description": "Selling price currency", "type": "string", "example": "USD" }, "condition": { "description": "Identifies the condition of the listings item. Allowed values: 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.", "type": "string", "example": "new_new" }, "isBatteriesRequired": { "description": "Indicates if batteries are required for the product. If not provided, defaults to false.", "type": "boolean", "example": false }, "dangerousGoodsRegulation": { "description": "Regulation for dangerous/hazardous goods. Allowed values: ghs, not_applicable, other, storage, transportation, unknown, waste.", "type": "string", "example": "not_applicable" }, "isFBA": { "description": "Is FBA? If yes, `fulfillmentChannel` attribute will be added with correct value based on marketplace.", "type": "boolean", "example": true }, "attributeOverrides": { "description": "Additional attributes to override. See SP-API Product Type Definitions (https://developer-docs.amazon.com/sp-api/docs/product-type-definitions-api) to get required and optional properties with format schema.", "type": "object", "example": { "max_order_quantity": [ { "value": 3, "marketplace_id": "ATVPDKIKX0DER" } ] } } }, "type": "object" }, "PutListingsItemInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to put listings item" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "Currency": { "required": [ "code", "symbol" ], "properties": { "code": { "description": "Currency code (e.g., USD, EUR)", "type": "string", "example": "USD" }, "symbol": { "description": "Currency symbol (e.g., $, €)", "type": "string", "example": "$" } }, "type": "object" }, "Product": { "required": [ "asin", "parentAsin", "title", "brand", "model", "modelName", "partNumber", "releaseDate", "bsr", "estimatedSales", "bulletPoints", "category", "variations", "packageQuantity", "numberOfItems", "marketplace", "urls", "prices", "size", "restrictionStatus", "riskFactors", "offers", "fees" ], "properties": { "asin": { "description": "Amazon product ASIN", "type": "string", "example": "B00U26V4VQ" }, "parentAsin": { "description": "Parent ASIN if the product is a variation. If no variations, it will return `null`.", "type": "string", "example": "B0CTP7MWMF" }, "title": { "description": "Title of the product", "type": "string", "example": "CATAN Board Game (Base Game) | Family Board Game | Board Game for Adults and Family | Adventure Board Game | Ages 10+ | for 3 to 4 Players | Average Playtime 60 Minutes | Made by Catan Studio" }, "brand": { "description": "Brand name of the product", "type": "string", "example": "CATAN" }, "model": { "description": "Model number of the product", "type": "string", "example": "CN3071" }, "modelName": { "description": "Model name of the product", "type": "string", "example": "12271002985" }, "partNumber": { "description": "Part number of the product", "type": "string", "example": "CN3071" }, "releaseDate": { "description": "Release date of the product", "type": "string", "format": "date", "example": "2015-04-23" }, "bsr": { "$ref": "#/components/schemas/ProductBsr", "description": "BSR information of the product" }, "estimatedSales": { "description": "Estimated number of sales per month", "type": "integer", "example": 10000 }, "bulletPoints": { "description": "List of bullet points highlighting features of the product", "type": "array", "items": { "type": "string", "example": "EXPLORE CATAN: Set sail to the uncharted island of Catan and compete with other settlers to establish supremacy." } }, "category": { "$ref": "#/components/schemas/ProductCategory", "description": "Category information of the product" }, "variations": { "$ref": "#/components/schemas/ProductVariations", "description": "Product variations" }, "packageQuantity": { "description": "Quantity of items in a package", "type": "integer", "example": 1 }, "numberOfItems": { "description": "Total number of items", "type": "integer", "example": 1 }, "marketplace": { "$ref": "#/components/schemas/ProductMarketplace", "description": "Marketplace information" }, "urls": { "$ref": "#/components/schemas/ProductUrls", "description": "URLs related to the product" }, "prices": { "$ref": "#/components/schemas/ProductPrices", "description": "Price information of the product" }, "size": { "$ref": "#/components/schemas/ProductSize", "description": "Size details of the product" }, "restrictionStatus": { "description": "Options: `ALLOWED_TO_SELL`, `NOT_ELIGIBLE`, `APPROVAL_REQUIRED`", "type": "string", "example": "ALLOWED_TO_SELL" }, "riskFactors": { "$ref": "#/components/schemas/ProductRisks", "description": "Risk assessment related to the product" }, "offers": { "$ref": "#/components/schemas/ProductOffers", "description": "Offers for the product" }, "fees": { "$ref": "#/components/schemas/ProductFees", "description": "Product fees" } }, "type": "object" }, "ProductBsr": { "required": [ "current", "top" ], "properties": { "current": { "description": "Best Seller Rank of the product", "type": "integer", "example": 308 }, "top": { "description": "Top rank in the category", "type": "number", "format": "float", "example": 0.01 } }, "type": "object" }, "ProductCategory": { "required": [ "name", "id", "productCount", "websiteDisplayGroup" ], "properties": { "name": { "description": "Name of the product category", "type": "string", "example": "Toys & Games" }, "id": { "description": "Unique identifier for the category", "type": "integer", "example": 165793011 }, "productCount": { "description": "Number of products in this category", "type": "integer", "example": 9038711 }, "websiteDisplayGroup": { "description": "Website display group", "type": "string", "example": "toy_display_on_website" } }, "type": "object" }, "ProductVariations": { "required": [ "theme", "variationItems" ], "properties": { "theme": { "description": "Theme of variations (e.g. size, color)", "type": "string", "example": "SIZE_NAME" }, "variationItems": { "description": "Variations of the product. If no variations, it will return null.", "type": "array", "items": { "$ref": "#/components/schemas/ProductVariation" } } }, "type": "object" }, "ProductVariation": { "required": [ "asin" ], "properties": { "asin": { "description": "ASIN of the variation", "type": "string", "example": "B00U26V9CU" } }, "type": "object" }, "ProductMarketplace": { "required": [ "id", "domain" ], "properties": { "id": { "description": "Unique identifier for the marketplace", "type": "string", "example": "ATVPDKIKX0DER" }, "domain": { "description": "Domain name of the marketplace", "type": "string", "example": "amazon.com" } }, "type": "object" }, "ProductUrls": { "required": [ "productUrl", "imageUrl" ], "properties": { "productUrl": { "description": "URL to the product page on Amazon", "type": "string", "example": "https://www.amazon.com/dp/B00U26V9CU" }, "imageUrl": { "description": "URL to the product image", "type": "string", "example": "https://m.media-amazon.com/images/I/41CZwtw9d7L.jpg" } }, "type": "object" }, "ProductPrices": { "required": [ "currency", "regularPrice", "buyBox", "fba", "fbm", "competitivePriceThreshold" ], "properties": { "currency": { "$ref": "#/components/schemas/Currency", "description": "Currency information for the prices" }, "regularPrice": { "description": "Regular price in the standard unit of the currency", "type": "string", "format": "decimal", "example": "43.97" }, "buyBox": { "description": "Product buy box prices", "required": [ "price" ], "properties": { "price": { "description": "Buy box price in the standard unit of the currency", "type": "string", "format": "decimal", "example": "43.97" } }, "type": "object" }, "fba": { "description": "Product FBA prices", "required": [ "minPrice" ], "properties": { "minPrice": { "description": "Minimum FBA price in the standard unit of the currency", "type": "string", "format": "decimal", "example": "43.97" } }, "type": "object" }, "fbm": { "description": "Product FBM prices", "required": [ "minPrice" ], "properties": { "minPrice": { "description": "Minimum FBM price in the standard unit of the currency", "type": "string", "format": "decimal", "example": "43.97" } }, "type": "object" }, "competitivePriceThreshold": { "description": "Competitive price threshold for offers in the standard unit of the currency", "type": "string", "format": "decimal", "example": "43.97" } }, "type": "object" }, "ProductSize": { "description": "Contains information about the product size", "required": [ "packageDimensions", "packageWeight", "sizeType" ], "properties": { "packageDimensions": { "description": "Product package dimensions", "required": [ "inches", "meters", "centimeters" ], "properties": { "inches": { "description": "Dimension values in imperial units (inches)", "required": [ "size", "height", "length", "width", "volume" ], "properties": { "size": { "description": "Dimensions in inches", "type": "string", "example": "3.11x12.323x9.764" }, "height": { "description": "Height in inches", "type": "number", "format": "float", "example": 3.11 }, "length": { "description": "Length in inches", "type": "number", "format": "float", "example": 12.323 }, "width": { "description": "Width in inches", "type": "number", "format": "float", "example": 9.764 }, "volume": { "description": "Volume in inches", "type": "number", "format": "float", "example": 0.217 } }, "type": "object" }, "meters": { "description": "Dimension values in metric units (meters)", "required": [ "size", "height", "length", "width", "volume" ], "properties": { "size": { "description": "Dimensions in meters", "type": "string", "example": "0.079x0.313x0.248" }, "height": { "description": "Height in meters", "type": "number", "format": "float", "example": 0.079 }, "length": { "description": "Length in meters", "type": "number", "format": "float", "example": 0.313 }, "width": { "description": "Width in meters", "type": "number", "format": "float", "example": 0.248 }, "volume": { "description": "Volume in meters", "type": "number", "format": "float", "example": 0.006 } }, "type": "object" }, "centimeters": { "description": "Dimension values in metric units (centimeters)", "required": [ "size", "height", "length", "width", "volume" ], "properties": { "size": { "description": "Dimensions in centimeters", "type": "string", "example": "7.9x31.3x24.8" }, "height": { "description": "Height in centimeters", "type": "number", "format": "float", "example": 7.9 }, "length": { "description": "Length in centimeters", "type": "number", "format": "float", "example": 31.3 }, "width": { "description": "Width in centimeters", "type": "number", "format": "float", "example": 24.8 }, "volume": { "description": "Volume in cubic centimeters", "type": "number", "format": "float", "example": 6132.296 } }, "type": "object" } }, "type": "object" }, "packageWeight": { "description": "Weight of the product with its package", "required": [ "pounds", "kilograms" ], "properties": { "pounds": { "description": "Weight in pounds", "type": "number", "format": "float", "example": 2.822 }, "kilograms": { "description": "Weight in kilograms", "type": "number", "format": "float", "example": 1.28 } }, "type": "object" }, "sizeType": { "description": "Type of the product size", "type": "string", "example": "L Std" } }, "type": "object" }, "ProductRisks": { "description": "Contains information about risks associated with the product", "required": [ "isMeltable", "isFragile", "isOversize", "isHazMat", "isAdultProduct", "isGenericBrand", "isHighRisk", "isBatteriesIncluded", "isPesticide" ], "properties": { "isMeltable": { "description": "Is the product meltable?", "type": "boolean", "example": false }, "isFragile": { "description": "Is the product fragile?", "type": "boolean", "example": false }, "isOversize": { "description": "Does the product exceed standard sizes?", "type": "boolean", "example": false }, "isHazMat": { "description": "Is the product hazardous material?", "type": "boolean", "example": false }, "isAdultProduct": { "description": "Is the product for adults?", "type": "boolean", "example": false }, "isGenericBrand": { "description": "Is the product brand generic?", "type": "boolean", "example": false }, "isHighRisk": { "description": "Is the product considered high risk for potential intellectual property (IP) issues by Seller Assistant IP-Alert based on historical claims?", "type": "boolean", "example": false }, "isBatteriesIncluded": { "description": "Are batteries included?", "type": "boolean", "example": false }, "isPesticide": { "description": "Has the product pesticides?", "type": "boolean", "example": false } }, "type": "object" }, "ProductOffers": { "description": "Contains information about product offers", "required": [ "fbaOffersQty", "fbmOffersQty", "competitors" ], "properties": { "fbaOffersQty": { "description": "Total number of FBA offers", "type": "integer", "example": 4 }, "fbmOffersQty": { "description": "Total number of FBM offers", "type": "integer", "example": 6 }, "competitors": { "description": "Competitors by offers", "required": [ "fbaWithin2Percent", "fbaWithin3Percent", "fbaWithin5Percent", "fbmWithin2Percent", "fbmWithin3Percent", "fbmWithin5Percent" ], "properties": { "fbaWithin2Percent": { "description": "Number of FBA competitors with price within BuyBox price + 2%", "type": "integer", "example": 2 }, "fbaWithin3Percent": { "description": "Number of FBA competitors with price within BuyBox price + 3%", "type": "integer", "example": 2 }, "fbaWithin5Percent": { "description": "Number of FBA competitors with price within BuyBox price + 5%", "type": "integer", "example": 2 }, "fbmWithin2Percent": { "description": "Number of FBM competitors with price within BuyBox price + 2%", "type": "integer", "example": 1 }, "fbmWithin3Percent": { "description": "Number of FBM competitors with price within BuyBox price + 3%", "type": "integer", "example": 2 }, "fbmWithin5Percent": { "description": "Number of FBM competitors with price within BuyBox price + 5%", "type": "integer", "example": 2 } }, "type": "object" } }, "type": "object" }, "ProductFees": { "description": "Contains information about product fees", "required": [ "currency", "fbaFee", "variableClosingFee", "referralFee", "referralFeeRate", "storageFee" ], "properties": { "currency": { "$ref": "#/components/schemas/Currency", "description": "Currency information for the prices" }, "fbaFee": { "description": "FBA fee in the standard unit of the currency", "type": "string", "format": "decimal", "example": "6.62" }, "variableClosingFee": { "description": "Variable closing fee in the standard unit of the currency", "type": "string", "format": "decimal", "example": "0.00" }, "referralFee": { "description": "Referral fee in the standard unit of the currency", "type": "string", "format": "decimal", "example": "6.60" }, "referralFeeRate": { "description": "Referral fee rate (e.g., 0.15 means 15%)", "type": "number", "format": "float", "example": 0.15 }, "storageFee": { "description": "Storage fee in the standard unit of the currency", "type": "string", "format": "decimal", "example": "0.17" }, "inboundPlacementFees": { "description": "Inbound placement service fee for amazon.com", "properties": { "minimalShipment": { "description": "Inbound placement service fees range for Minimal shipment splits", "properties": { "min": { "description": "Minimal shipment fee min in the standard unit of the currency", "type": "string", "format": "decimal", "example": "0.32" }, "max": { "description": "Minimal shipment fee max in the standard unit of the currency", "type": "string", "format": "decimal", "example": "0.49" } }, "type": "object" }, "partialShipment": { "description": "Inbound placement service fees range for Partial shipment splits", "properties": { "min": { "description": "Partial shipment fee min in the standard unit of the currency", "type": "string", "format": "decimal", "example": "0.17" }, "max": { "description": "Partial shipment fee max in the standard unit of the currency", "type": "string", "format": "decimal", "example": "0.34" } }, "type": "object" }, "optimizedShipment": { "description": "Inbound placement service fees range for Amazon optimized shipment splits", "properties": { "min": { "description": "Optimized shipment fee min in the standard unit of the currency", "type": "string", "format": "decimal", "example": "0.00" }, "max": { "description": "Optimized shipment fee max in the standard unit of the currency", "type": "string", "format": "decimal", "example": "0.00" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "GetProductInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get product" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "CalculateProductProfitRequest": { "required": [ "cog", "fba3pl", "fbm3pl" ], "properties": { "cog": { "description": "Cost of Goods. Please add taxes to COG if necessary.", "type": "string", "format": "decimal", "example": "29.99" }, "fba3pl": { "description": "Third Party Logistics for FBA. Please add FBA inbound placement service fee to Third Party Logistics for FBA if necessary (https://www.sellerassistant.app/blog/amazon-inbound-placement-fees).", "type": "string", "format": "decimal", "example": "2.15" }, "fbm3pl": { "description": "Third Party Logistics for FBM.", "type": "string", "format": "decimal", "example": "3.21" }, "overridePrice": { "description": "Optional price that overrides the price from Amazon to calculate profit. If not provided, the price from Amazon is used.", "type": [ "string", "null" ], "format": "decimal", "example": null } }, "type": "object" }, "ProductProfit": { "required": [ "currency", "calculations", "profit", "estimate" ], "properties": { "currency": { "description": "Currency information", "required": [ "code", "symbol" ], "properties": { "code": { "description": "Currency code", "type": "string", "example": "USD" }, "symbol": { "description": "Currency symbol", "type": "string", "example": "$" } }, "type": "object" }, "calculations": { "description": "Calculation details", "required": [ "fba", "fbm" ], "properties": { "fba": { "description": "FBA calculation details", "required": [ "price", "cog", "referralFee", "fbaFee", "storageFee", "variableClosingFee", "fba3pl", "profit" ], "properties": { "price": { "description": "Selling price. Can be overridden by `overridePrice`.", "type": "string", "format": "decimal", "example": "43.97" }, "cog": { "description": "Cost of goods", "type": "string", "format": "decimal", "example": "29.99" }, "referralFee": { "description": "Referral fee", "type": "string", "format": "decimal", "example": "6.60" }, "fbaFee": { "description": "FBA fee", "type": "string", "format": "decimal", "example": "6.61" }, "storageFee": { "description": "Storage fee for FBA", "type": "string", "format": "decimal", "example": "0.49" }, "variableClosingFee": { "description": "Variable closing fee", "type": "string", "format": "decimal", "example": "0.00" }, "fba3pl": { "description": "Third-party logistics expenses for FBA", "type": "string", "format": "decimal", "example": "2.15" }, "profit": { "description": "Profit for FBA, also represented as `profit.fba.amount` for summary purposes. Calculated as: `= price - cog - referralFee - fbaFee - storageFee - variableClosingFee - fba3pl`.", "type": "string", "format": "decimal", "example": "-1.87" } }, "type": "object" }, "fbm": { "description": "FBM calculation details", "required": [ "price", "cog", "referralFee", "variableClosingFee", "fbm3pl", "profit" ], "properties": { "price": { "description": "Selling price. Can be overridden by `overridePrice`.", "type": "string", "format": "decimal", "example": "43.97" }, "cog": { "description": "Cost of goods", "type": "string", "format": "decimal", "example": "29.99" }, "referralFee": { "description": "Referral fee", "type": "string", "format": "decimal", "example": "6.60" }, "variableClosingFee": { "description": "Variable closing fee", "type": "string", "format": "decimal", "example": "0.00" }, "fbm3pl": { "description": "Third-party logistics expenses for FBM", "type": "string", "format": "decimal", "example": "3.21" }, "profit": { "description": "Profit for FBM, also represented as `profit.fbm.amount` for summary purposes. Calculated as: `= price - cog - referralFee - variableClosingFee - fbm3pl`.", "type": "string", "format": "decimal", "example": "4.17" } }, "type": "object" } }, "type": "object" }, "profit": { "description": "Profit details", "required": [ "fba", "fbm" ], "properties": { "fba": { "description": "FBA profit details", "required": [ "amount", "breakEven", "roi10", "roi20", "roi", "margin" ], "properties": { "amount": { "description": "Profit amount for FBA. The value is the same as `calculations.fba.profit`.", "type": "string", "format": "decimal", "example": "-1.87" }, "breakEven": { "description": "Break-even details for FBA", "required": [ "price", "profit" ], "properties": { "price": { "description": "Price at which total revenue equals total costs for FBA", "type": "string", "format": "decimal", "example": "46.16" }, "profit": { "description": "Break-even profit for FBA (always 0, as break-even means no profit and ROI is 0%)", "type": "string", "format": "decimal", "example": "0.00" } }, "type": "object" }, "roi10": { "description": "ROI 10% details for FBA", "required": [ "price", "profit" ], "properties": { "price": { "description": "Price to achieve a 10% ROI for FBA", "type": "string", "format": "decimal", "example": "49.95" }, "profit": { "description": "Profit at 10% ROI for FBA", "type": "string", "format": "decimal", "example": "3.21" } }, "type": "object" }, "roi20": { "description": "ROI 20% details for FBA", "required": [ "price", "profit" ], "properties": { "price": { "description": "Price to achieve a 20% ROI for FBA", "type": "string", "format": "decimal", "example": "53.73" }, "profit": { "description": "Profit at 20% ROI for FBA", "type": "string", "format": "decimal", "example": "6.43" } }, "type": "object" }, "roi": { "description": "Return on investment for FBA is calculated as: ` = (fba.profit / (cog + fba3pl)) x 100`", "type": "number", "format": "float", "example": -5.82 }, "margin": { "description": "Profit margin for FBA is calculated as: ` = (fba.profit / price) x 100`", "type": "number", "format": "float", "example": -4.25 } }, "type": "object" }, "fbm": { "description": "FBM profit details", "required": [ "amount", "breakEven", "roi10", "roi20", "roi", "margin" ], "properties": { "amount": { "description": "Profit amount for FBM. The value is the same as `calculations.fbm.profit`.", "type": "string", "format": "decimal", "example": "4.17" }, "breakEven": { "description": "Break-even details for FBM", "required": [ "price", "profit" ], "properties": { "price": { "description": "Price at which total revenue equals total costs for FBM", "type": "string", "format": "decimal", "example": "39.06" }, "profit": { "description": "Break-even profit for FBM (always 0, as break-even means no profit and ROI is 0%)", "type": "string", "format": "decimal", "example": "0.00" } }, "type": "object" }, "roi10": { "description": "ROI 10% details for FBM", "required": [ "price", "profit" ], "properties": { "price": { "description": "Price to achieve a 10% ROI for FBM", "type": "string", "format": "decimal", "example": "42.96" }, "profit": { "description": "Profit at 10% ROI for FBM", "type": "string", "format": "decimal", "example": "3.00" } }, "type": "object" }, "roi20": { "description": "ROI 20% details for FBM", "required": [ "price", "profit" ], "properties": { "price": { "description": "Price to achieve a 20% ROI for FBM", "type": "string", "format": "decimal", "example": "46.87" }, "profit": { "description": "Profit at 20% ROI for FBM", "type": "string", "format": "decimal", "example": "7.00" } }, "type": "object" }, "roi": { "description": "Return on investment for FBM is calculated as: ` = (fbm.profit / (cog + fbm3pl)) x 100`.", "type": "number", "format": "float", "example": 12.56 }, "margin": { "description": "Profit margin for FBM is calculated as: ` = (fbm.profit / price) x 100`", "type": "number", "format": "float", "example": 9.48 } }, "type": "object" } }, "type": "object" }, "estimate": { "description": "Estimate details", "required": [ "sales", "revenue" ], "properties": { "sales": { "description": "Estimated sales (pieces per month)", "type": "integer", "example": 10000 }, "revenue": { "description": "Estimated revenue is calculated as: ` = sales x price` (per month).", "type": "string", "format": "decimal", "example": "439700.00" } }, "type": "object" } }, "type": "object" }, "CalculateProductProfitInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to calculate product profit" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ProductStats": { "description": "Product statistics. If the value is `null`, it means that there is insufficient data.", "required": [ "currency", "amazonPrice", "marketplaceNewPrice", "buyBoxPrice", "fbmPrice", "fbaPrice", "bsr", "offersCount", "reviewsCount", "bsrDropsCount", "monthlySold" ], "properties": { "currency": { "$ref": "#/components/schemas/Currency", "description": "Currency information for the prices" }, "amazonPrice": { "description": "Amazon price statistics (price set by Amazon itself)", "required": [ "current", "avg30", "avg90", "avg180", "avg365" ], "properties": { "current": { "description": "Current Amazon price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "43.97" }, "avg30": { "description": "30-day average Amazon price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "43.92" }, "avg90": { "description": "90-day average Amazon price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "43.41" }, "avg180": { "description": "180-day average Amazon price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "43.63" }, "avg365": { "description": "365-day average Amazon price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "42.12" } }, "type": "object" }, "marketplaceNewPrice": { "description": "Marketplace new price statistics (typically the lowest price set by third-party sellers for new products)", "required": [ "current", "avg30", "avg90", "avg180", "avg365" ], "properties": { "current": { "description": "Current marketplace new price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "43.97" }, "avg30": { "description": "30-day average marketplace new price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "43.92" }, "avg90": { "description": "90-day average marketplace new price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "42.40" }, "avg180": { "description": "180-day average marketplace new price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "42.83" }, "avg365": { "description": "365-day average marketplace new price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "40.21" } }, "type": "object" }, "buyBoxPrice": { "description": "Buy Box price statistics (price of the product that appears in the Buy Box)", "required": [ "current", "avg30", "avg90", "avg180", "avg365" ], "properties": { "current": { "description": "Current Buy Box price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "43.97" }, "avg30": { "description": "30-day average Buy Box price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "43.92" }, "avg90": { "description": "90-day average Buy Box price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "43.39" }, "avg180": { "description": "180-day average Buy Box price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "43.61" }, "avg365": { "description": "365-day average Buy Box price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "42.10" } }, "type": "object" }, "fbmPrice": { "description": "FBM price statistics", "required": [ "current", "avg30", "avg90", "avg180", "avg365" ], "properties": { "current": { "description": "Current FBM price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "55.33" }, "avg30": { "description": "30-day average FBM price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "52.78" }, "avg90": { "description": "90-day average FBM price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "53.46" }, "avg180": { "description": "180-day average FBM price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "51.59" }, "avg365": { "description": "365-day average FBM price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "50.17" } }, "type": "object" }, "fbaPrice": { "description": "FBA price statistics", "required": [ "current", "avg30", "avg90", "avg180", "avg365" ], "properties": { "current": { "description": "Current FBA price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "59.99" }, "avg30": { "description": "30-day average FBA price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "50.06" }, "avg90": { "description": "90-day average FBA price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "45.46" }, "avg180": { "description": "180-day average FBA price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "46.08" }, "avg365": { "description": "365-day average FBA price in the standard unit of the currency", "type": [ "string", "null" ], "format": "decimal", "example": "45.71" } }, "type": "object" }, "bsr": { "description": "Best Sellers Rank (BSR) statistics", "required": [ "current", "avg30", "avg90", "avg180", "avg365" ], "properties": { "current": { "description": "Current Best Sellers Rank (BSR)", "type": [ "integer", "null" ], "example": 245 }, "avg30": { "description": "30-day average BSR", "type": [ "integer", "null" ], "example": 241 }, "avg90": { "description": "90-day average BSR", "type": [ "integer", "null" ], "example": 192 }, "avg180": { "description": "180-day average BSR", "type": [ "integer", "null" ], "example": 195 }, "avg365": { "description": "365-day average BSR", "type": [ "integer", "null" ], "example": 239 } }, "type": "object" }, "offersCount": { "description": "Offers count statistics", "required": [ "current", "avg30", "avg90", "avg180", "avg365" ], "properties": { "current": { "description": "Current number of offers", "type": [ "integer", "null" ], "example": 8 }, "avg30": { "description": "30-day average number of offers", "type": [ "integer", "null" ], "example": 10 }, "avg90": { "description": "90-day average number of offers", "type": [ "integer", "null" ], "example": 10 }, "avg180": { "description": "180-day average number of offers", "type": [ "integer", "null" ], "example": 10 }, "avg365": { "description": "365-day average number of offers", "type": [ "integer", "null" ], "example": 11 } }, "type": "object" }, "reviewsCount": { "description": "Reviews count statistics", "required": [ "current", "avg30", "avg90", "avg180", "avg365" ], "properties": { "current": { "description": "Current number of reviews", "type": [ "integer", "null" ], "example": 44639 }, "avg30": { "description": "30-day average number of reviews", "type": [ "integer", "null" ], "example": 44555 }, "avg90": { "description": "90-day average number of reviews", "type": [ "integer", "null" ], "example": 44374 }, "avg180": { "description": "180-day average number of reviews", "type": [ "integer", "null" ], "example": 44090 }, "avg365": { "description": "365-day average number of reviews", "type": [ "integer", "null" ], "example": 40854 } }, "type": "object" }, "bsrDropsCount": { "description": "BSR drops count statistics. Indicates the number of times the Best Sellers Rank (BSR) has dropped within the specified period, which can be an indicator of sales spikes.", "required": [ "avg30", "avg90", "avg180", "avg365" ], "properties": { "avg30": { "description": "30-day average BSR drops count", "type": [ "integer", "null" ], "example": 217 }, "avg90": { "description": "90-day average BSR drops count", "type": [ "integer", "null" ], "example": 443 }, "avg180": { "description": "180-day average BSR drops count", "type": [ "integer", "null" ], "example": 767 }, "avg365": { "description": "365-day average BSR drops count", "type": [ "integer", "null" ], "example": 1676 } }, "type": "object" }, "monthlySold": { "description": "Monthly units sold", "type": [ "integer", "null" ], "example": 5000 } }, "type": "object" }, "GetProductStatsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get product stats" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "CheckAsinRestrictionsResponse": { "required": [ "status" ], "properties": { "status": { "description": "Options: ALLOWED_TO_SELL, NOT_ELIGIBLE, APPROVAL_REQUIRED", "type": "string", "example": "ALLOWED_TO_SELL" } }, "type": "object" }, "CheckRestrictionsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to check ASIN restrictions" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "InternalProduct": { "description": "Internal product entity", "properties": { "id": { "description": "Unique product identifier", "type": "string", "maxLength": 20, "example": "P-5XK1S0NQNO" }, "team_id": { "description": "Team ID that owns this product", "type": "integer", "example": 123 }, "user_id": { "description": "User ID who created this product", "type": "integer", "example": 456 }, "default_supplier_id": { "description": "ID of the selected supplier offer", "type": [ "integer", "null" ], "example": 5 }, "title": { "description": "Product title", "type": [ "string", "null" ], "example": "My Product Title" }, "attributes": { "description": "Additional product attributes as JSON", "type": [ "object", "null" ], "example": [] }, "created_at": { "description": "Creation timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T10:00:00.000000Z" }, "updated_at": { "description": "Last update timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T12:30:00.000000Z" } }, "type": "object" }, "ExternalProduct": { "description": "External product identifier (e.g., ASIN, UPC) linked to an internal product", "properties": { "id": { "description": "Unique external product identifier", "type": "integer", "example": 1 }, "internal_product_id": { "description": "Internal product ID this external product belongs to", "type": "string", "maxLength": 20, "example": "P-5XK1S0NQNO" }, "team_id": { "description": "Team ID that owns this external product", "type": "integer", "example": 123 }, "user_id": { "description": "User ID who created this external product", "type": "integer", "example": 456 }, "platform": { "description": "Platform name (e.g., amazon, walmart, global)", "type": "string", "example": "amazon" }, "identifier_type": { "description": "Type of identifier (e.g., asin, upc, ean, gtin, unknown)", "type": "string", "example": "asin" }, "identifier": { "description": "The actual product identifier (e.g., B00U26V4VQ)", "type": "string", "example": "B00U26V4VQ" }, "marketplace_code": { "description": "Marketplace code/ID (e.g., ATVPDKIKX0DER for Amazon US)", "type": [ "string", "null" ], "example": "ATVPDKIKX0DER" }, "title": { "description": "External product title", "type": [ "string", "null" ], "example": "External Product Title" }, "attributes": { "description": "Additional external product attributes as JSON", "type": [ "object", "null" ], "example": [] }, "created_at": { "description": "Creation timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T10:00:00.000000Z" }, "updated_at": { "description": "Last update timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T12:30:00.000000Z" } }, "type": "object" }, "ExternalProductUpsertItem": { "description": "External product item for upsert operations", "required": [ "identifier", "identifier_type", "platform" ], "properties": { "platform": { "description": "Platform name (e.g., amazon, walmart, global)", "type": "string", "example": "amazon" }, "marketplace_code": { "description": "Marketplace code/ID (e.g., ATVPDKIKX0DER for Amazon US)", "type": [ "string", "null" ], "example": "ATVPDKIKX0DER" }, "identifier": { "description": "The actual product identifier (e.g., B00U26V4VQ)", "type": "string", "example": "B00U26V4VQ" }, "identifier_type": { "description": "Type of identifier (e.g., asin, upc, ean, gtin, unknown)", "type": "string", "example": "asin" }, "title": { "description": "External product title", "type": [ "string", "null" ], "example": "External Product Title" } }, "type": "object" }, "SupplierProductOffer": { "description": "Supplier offer for an internal product", "properties": { "id": { "description": "Unique supplier offer identifier", "type": "integer", "example": 1 }, "internal_product_id": { "description": "Internal product ID this offer belongs to", "type": "string", "maxLength": 20, "example": "P-5XK1S0NQNO" }, "team_id": { "description": "Team ID that owns this offer", "type": "integer", "example": 123 }, "user_id": { "description": "User ID who created this offer", "type": "integer", "example": 456 }, "supplier_id": { "description": "Supplier ID", "type": "integer", "example": 10 }, "sku": { "description": "Supplier SKU", "type": [ "string", "null" ], "example": "SUP-12345" }, "cog": { "description": "Cost of goods from supplier", "type": "number", "format": "float", "example": 12.34 }, "product_link": { "description": "Link to supplier's product page", "type": [ "string", "null" ], "example": "https://supplier.com/product/123" }, "supplier_product_title": { "description": "Product title from supplier", "type": [ "string", "null" ], "example": "Supplier Product Title" }, "supplier_product_code": { "description": "Supplier's product code (e.g., UPC, EAN)", "type": [ "string", "null" ], "example": "029877030712" }, "supplier_product_code_type": { "description": "Type of supplier product code (e.g., upc, ean, gtin, asin, unknown)", "type": [ "string", "null" ], "example": "upc" }, "attributes": { "description": "Additional supplier offer attributes as JSON", "type": [ "object", "null" ], "example": { "shipping_time": "2-3 days" } }, "updated_by": { "description": "User ID who last updated this offer", "type": [ "integer", "null" ], "example": 456 }, "created_at": { "description": "Creation timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T10:00:00.000000Z" }, "updated_at": { "description": "Last update timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T12:30:00.000000Z" } }, "type": "object" }, "Supplier": { "description": "Supplier entity", "properties": { "id": { "description": "Unique supplier identifier", "type": "integer", "example": 1 }, "team_id": { "description": "Team ID that owns this supplier", "type": "integer", "example": 123 }, "user_id": { "description": "Responsible user ID", "type": "integer", "example": 456 }, "name": { "description": "Supplier name", "type": [ "string", "null" ], "example": "Acme Wholesalers" }, "website": { "description": "Supplier website", "type": [ "string", "null" ], "example": "https://acme.com" }, "status": { "description": "Supplier status (1=New, 2=Contacted, 3=Approved, 4=Rejected, 5=Negotiation, 6=No response, 7=Active, 8=On hold)", "type": [ "integer", "null" ], "example": 1 }, "type": { "description": "Supplier type (0=Not selected, 1=Distributor, 2=Manufacturer, 3=Brand, 4=Wholesaler)", "type": [ "integer", "null" ], "example": 1 }, "payment_method": { "description": "Payment methods (1=Credit card, 2=ACH, 3=Wire transfer)", "type": [ "array", "null" ], "items": { "type": "integer" }, "example": [ 1, 2 ] }, "payment_terms": { "description": "Payment terms (0=Not selected, 1=Net15, 2=Net30, 3=Net45, 4=Net60, 5=COD, 6=Prepaid)", "type": [ "integer", "null" ], "example": 2 }, "currency": { "description": "Currency code (USD, EUR, GBP, etc.)", "type": [ "string", "null" ], "example": "USD" }, "contacts": { "description": "Contact information", "type": [ "string", "null" ], "example": "contact@acme.com" }, "contact_name": { "description": "Contact person name", "type": [ "string", "null" ], "example": "John Doe" }, "phone": { "description": "Phone number", "type": [ "string", "null" ], "example": "+1234567890" }, "address": { "description": "Address", "type": [ "string", "null" ], "example": "123 Main St, City, State" }, "default_prep_center_id": { "description": "Default warehouse/prep center ID", "type": [ "integer", "null" ], "example": 3 }, "note": { "description": "Additional notes", "type": [ "string", "null" ], "example": "Preferred supplier for electronics" }, "created_at": { "description": "Creation timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T10:00:00.000000Z" }, "updated_at": { "description": "Last update timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T12:30:00.000000Z" } }, "type": "object" }, "CreateSupplierForm": { "description": "Payload to create a supplier", "properties": { "name": { "type": "string", "example": "Acme Wholesalers" }, "website": { "type": [ "string", "null" ], "example": "acme.com" }, "payment_terms": { "type": [ "integer", "null" ], "example": 2 }, "contacts": { "type": [ "string", "null" ], "example": "contact@acme.com" }, "status": { "type": [ "integer", "null" ], "example": 1 }, "warehouse_id": { "type": [ "integer", "null" ], "example": null }, "responsible_user_id": { "type": [ "integer", "null" ], "example": 4 }, "type": { "type": [ "integer", "null" ], "example": 1 }, "address": { "type": [ "string", "null" ], "example": "123 Main St" }, "currency": { "type": [ "string", "null" ], "example": "USD" }, "phone": { "type": [ "string", "null" ], "example": "+1234567890" } }, "type": "object" }, "UpdateSupplierForm": { "description": "Payload to update supplier fields", "properties": { "name": { "type": [ "string", "null" ], "example": "Updated Name" }, "website": { "type": [ "string", "null" ], "example": "updated.com" }, "payment_terms": { "type": [ "integer", "null" ], "example": 3 }, "contacts": { "type": [ "string", "null" ], "example": "new@contact.com" }, "status": { "type": [ "integer", "null" ], "example": 2 }, "warehouse_id": { "type": [ "integer", "null" ], "example": null }, "responsible_user_id": { "type": "integer", "example": 4 }, "currency": { "type": [ "string", "null" ], "example": "EUR" }, "address": { "type": [ "string", "null" ], "example": "456 Not Main St" }, "phone": { "type": [ "string", "null" ], "example": "+9876543210" }, "contact_name": { "type": [ "string", "null" ], "example": "Jane Smith" }, "mov": { "type": [ "number", "null" ], "example": 5000.75 }, "free_shipping_ov": { "type": [ "number", "null" ], "example": 150 }, "sold_by_case": { "type": [ "boolean", "null" ], "example": true }, "lead_time_min": { "type": [ "integer", "null" ], "example": 3 }, "lead_time_max": { "type": [ "integer", "null" ], "example": 7 }, "type": { "type": [ "integer", "null" ], "example": 2 }, "payment_method": { "type": [ "array", "null" ], "items": { "type": "integer" }, "example": [ 1, 2 ] }, "note": { "type": [ "string", "null" ], "example": "Updated notes" } }, "type": "object" }, "CurrentUserInfoResponse": { "required": [ "id", "email", "name", "tokensLeft", "tokensUsed", "tokensLimit", "tokensRefillAt" ], "properties": { "id": { "description": "ID of user", "type": "number", "example": 123 }, "email": { "description": "Email of user", "type": "string", "example": "test@gmail.com" }, "name": { "description": "Name of user", "type": "string", "example": "My Name" }, "tokensLeft": { "description": "API requests left", "type": "number", "example": 555 }, "tokensUsed": { "description": "API requests used", "type": "number", "example": 445 }, "tokensLimit": { "description": "API requests limit", "type": "number", "example": 1000 }, "tokensRefillAt": { "description": "API requests refill date", "type": "string", "format": "date", "example": "2024-10-02T00:00:00.000000Z" } }, "type": "object" }, "GetCurrentUserInfoInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get current user info" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "EstimateSalesInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to estimate sales" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "EstimateSalesResponse": { "required": [ "sales" ], "properties": { "sales": { "type": "number", "example": 123 } }, "type": "object" }, "EstimateSalesByBsrRequest": { "required": [ "bsr", "category" ], "properties": { "bsr": { "description": "Best Seller Rank number.", "type": "number", "example": "10000" }, "category": { "description": "Name of root category. See all root categories [here](https://keepa.com/#!categorytree).", "type": "string", "example": "Home & Kitchen" }, "domain": { "description": "Amazon marketplace domain. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br", "type": "string", "example": "amazon.com" }, "marketplaceId": { "description": "Amazon marketplace id. Domain `amazon.com` is used by default if `domain` and `marketplaceId` are not provided. If both `domain` and `marketplaceId` are chosen, `domain` has bigger priority. See all options [here](https://developer.sellerassistant.app/doc-648175).", "type": "string", "example": "ATVPDKIKX0DER" } }, "type": "object" }, "SearchCatalogItemsResponse": { "description": "The response object for searching catalog items.", "properties": { "numberOfResults": { "description": "For searches that are based on `identifiers`, `numberOfResults` is the total number of Amazon catalog items found. For searches that are based on `keywords`, `numberOfResults` is the estimated total number of Amazon catalog items that are matched by the search query. Only results up to the page count limit are returned per request regardless of the number found. Note: The maximum number of items (ASINs) that can be returned and paged through is 1,000.", "type": "integer", "example": 3 }, "pagination": { "oneOf": [ { "$ref": "#/components/schemas/CatalogItemsPagination", "description": "Pagination tokens for next and previous pages of results." }, { "type": "null" } ], "description": "Pagination tokens for next and previous pages of results." }, "items": { "description": "A list of items from the Amazon catalog.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogItem" } }, "refinements": { "oneOf": [ { "$ref": "#/components/schemas/Refinements", "description": "Optional fields that you can use to refine your search results." }, { "type": "null" } ], "description": "Optional fields that you can use to refine your search results." } }, "type": "object" }, "CatalogItemsPagination": { "description": "Pagination tokens for multi-page responses.", "properties": { "nextToken": { "description": "A token that can be used to retrieve the next page.", "type": [ "string", "null" ], "example": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234" }, "previousToken": { "description": "A token that can be used to retrieve the previous page.", "type": [ "string", "null" ], "example": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d" } }, "type": "object" }, "Refinements": { "description": "Optional fields that you can use to refine your search results.", "properties": { "brands": { "description": "A list of brands you can use to refine your search.", "type": "array", "items": { "$ref": "#/components/schemas/BrandRefinement" } }, "classifications": { "description": "A list of classifications you can use to refine your search.", "type": "array", "items": { "$ref": "#/components/schemas/ClassificationRefinement" } } }, "type": "object" }, "BrandRefinement": { "description": "Brand refinement for search results.", "properties": { "numberOfResults": { "description": "The estimated number of results that would still be returned if refinement key applied.", "type": "integer", "example": 5 }, "brandName": { "description": "Brand name. For display and can be used as a search refinement.", "type": "string", "example": "Samsung" } }, "type": "object" }, "ClassificationRefinement": { "description": "Classification refinement for search results.", "properties": { "numberOfResults": { "description": "The estimated number of results that would still be returned if refinement key applied.", "type": "integer", "example": 10 }, "displayName": { "description": "Display name for the classification.", "type": "string", "example": "Electronics" }, "classificationId": { "description": "Identifier of the classification.", "type": "string", "example": "123456789" } }, "type": "object" }, "CatalogItem": { "description": "A single Amazon catalog item.", "properties": { "asin": { "description": "The unique identifier of an item in the Amazon catalog.", "type": "string", "example": "B00U26V4VQ" }, "attributes": { "description": "A JSON object containing structured item attribute data that is keyed by attribute name. Catalog item attributes conform to the related Amazon product type definitions.", "type": [ "object", "null" ] }, "classifications": { "description": "An array of classifications (browse nodes) that is associated with the item in the Amazon catalog, grouped by `marketplaceId`.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemBrowseClassificationsByMarketplace" } }, "dimensions": { "description": "An array of dimensions that are associated with the item in the Amazon catalog, grouped by `marketplaceId`.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemDimensionsByMarketplace" } }, "identifiers": { "description": "Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemIdentifiersByMarketplace" } }, "images": { "description": "The images for an item in the Amazon catalog.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemImagesByMarketplace" } }, "productTypes": { "description": "Product types that are associated with the Amazon catalog item.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemProductTypeByMarketplace" } }, "relationships": { "description": "Relationships grouped by `marketplaceId` for an Amazon catalog item (for example, variations).", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemRelationshipsByMarketplace" } }, "salesRanks": { "description": "Sales ranks of an Amazon catalog item.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemSalesRanksByMarketplace" } }, "summaries": { "description": "Summaries of Amazon catalog items.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemSummaryByMarketplace" } }, "vendorDetails": { "description": "The vendor details that are associated with an Amazon catalog item. Vendor details are only available to vendors.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemVendorDetailsByMarketplace" } } }, "type": "object" }, "CatalogItemBrowseClassificationsByMarketplace": { "description": "Classifications (browse nodes) for an item grouped by marketplace.", "properties": { "marketplaceId": { "description": "Amazon marketplace identifier.", "type": "string", "example": "ATVPDKIKX0DER" }, "classifications": { "description": "Classifications (browse nodes) that are associated with the item in the Amazon catalog.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemBrowseClassification" } } }, "type": "object" }, "CatalogItemBrowseClassification": { "description": "Classification (browse node) for an Amazon catalog item.", "properties": { "displayName": { "description": "Display name for the classification.", "type": "string", "example": "Electronics" }, "classificationId": { "description": "Identifier of the classification.", "type": "string", "example": "123456789" }, "parent": { "oneOf": [ { "$ref": "#/components/schemas/CatalogItemBrowseClassification", "description": "Parent classification." }, { "type": "null" } ], "description": "Parent classification." } }, "type": "object" }, "CatalogItemDimensionsByMarketplace": { "description": "Dimensions for an item grouped by marketplace.", "properties": { "marketplaceId": { "description": "Amazon marketplace identifier.", "type": "string", "example": "ATVPDKIKX0DER" }, "item": { "oneOf": [ { "$ref": "#/components/schemas/Dimensions", "description": "Dimensions of an Amazon catalog item." }, { "type": "null" } ], "description": "Dimensions of an Amazon catalog item." }, "package": { "oneOf": [ { "$ref": "#/components/schemas/Dimensions", "description": "Dimensions of an Amazon catalog item in its packaging." }, { "type": "null" } ], "description": "Dimensions of an Amazon catalog item in its packaging." } }, "type": "object" }, "Dimensions": { "description": "Dimensions of an Amazon catalog item or item in its packaging.", "properties": { "height": { "oneOf": [ { "$ref": "#/components/schemas/Dimension", "description": "Height dimension." }, { "type": "null" } ], "description": "Height dimension." }, "length": { "oneOf": [ { "$ref": "#/components/schemas/Dimension", "description": "Length dimension." }, { "type": "null" } ], "description": "Length dimension." }, "weight": { "oneOf": [ { "$ref": "#/components/schemas/Dimension", "description": "Weight dimension." }, { "type": "null" } ], "description": "Weight dimension." }, "width": { "oneOf": [ { "$ref": "#/components/schemas/Dimension", "description": "Width dimension." }, { "type": "null" } ], "description": "Width dimension." } }, "type": "object" }, "Dimension": { "description": "The value of an individual dimension for an Amazon catalog item or item package.", "properties": { "unit": { "description": "Unit of measurement for the dimension value.", "type": [ "string", "null" ], "example": "inches" }, "value": { "description": "Numeric value of the dimension.", "type": [ "number", "null" ], "format": "float", "example": 10.5 } }, "type": "object" }, "CatalogItemIdentifiersByMarketplace": { "description": "Identifiers for an item grouped by marketplace.", "properties": { "marketplaceId": { "description": "Amazon marketplace identifier.", "type": "string", "example": "ATVPDKIKX0DER" }, "identifiers": { "description": "Identifiers associated with the item in the Amazon catalog for the indicated `marketplaceId`.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogItemIdentifier" } } }, "type": "object" }, "CatalogItemIdentifier": { "description": "Identifier for an Amazon catalog item.", "properties": { "identifierType": { "description": "Type of identifier, such as UPC, EAN, or ISBN.", "type": "string", "example": "UPC" }, "identifier": { "description": "Identifier of the item.", "type": "string", "example": "123456789012" } }, "type": "object" }, "CatalogItemImagesByMarketplace": { "description": "Images for an item grouped by marketplace.", "properties": { "marketplaceId": { "description": "Amazon marketplace identifier.", "type": "string", "example": "ATVPDKIKX0DER" }, "images": { "description": "Images for an item in the Amazon catalog, grouped by `marketplaceId`.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogItemImage" } } }, "type": "object" }, "CatalogItemImage": { "description": "Image for an Amazon catalog item.", "properties": { "variant": { "description": "Variant of the image, such as `MAIN` or `PT01`.", "type": "string", "example": "MAIN" }, "link": { "description": "URL for the image.", "type": "string", "format": "url", "example": "https://www.example.com/image.jpg" }, "height": { "description": "Height of the image in pixels.", "type": "integer", "example": 500 }, "width": { "description": "Width of the image in pixels.", "type": "integer", "example": 500 } }, "type": "object" }, "CatalogItemProductTypeByMarketplace": { "description": "Product type for an item grouped by marketplace.", "properties": { "marketplaceId": { "description": "Amazon marketplace identifier.", "type": [ "string", "null" ], "example": "ATVPDKIKX0DER" }, "productType": { "description": "Name of the product type that is associated with the Amazon catalog item.", "type": [ "string", "null" ], "example": "LUGGAGE" } }, "type": "object" }, "CatalogItemRelationshipsByMarketplace": { "description": "Relationships for an item grouped by marketplace.", "properties": { "marketplaceId": { "description": "Amazon marketplace identifier.", "type": "string", "example": "ATVPDKIKX0DER" }, "relationships": { "description": "Relationships for the item.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogItemRelationship" } } }, "type": "object" }, "CatalogItemRelationship": { "description": "Relationship for an Amazon catalog item.", "properties": { "type": { "description": "Type of relationship.", "type": "string", "example": "VARIATION" }, "childAsins": { "description": "ASINs of the related items that are children of this item.", "type": [ "array", "null" ], "items": { "type": "string" }, "example": [ "B00U26V4VQ", "B08T8YZ49Z" ] }, "parentAsins": { "description": "ASINs of the related items that are parents of this item.", "type": [ "array", "null" ], "items": { "type": "string" }, "example": [ "B08T8YZ47X" ] }, "variationTheme": { "oneOf": [ { "$ref": "#/components/schemas/CatalogItemVariationTheme", "description": "The variation theme is a list of Amazon catalog item attributes that define the variation family." }, { "type": "null" } ], "description": "The variation theme is a list of Amazon catalog item attributes that define the variation family." } }, "type": "object" }, "CatalogItemVariationTheme": { "description": "Variation theme for an Amazon catalog item.", "properties": { "attributes": { "description": "Names of the Amazon catalog item attributes that are associated with the variation theme.", "type": [ "array", "null" ], "items": { "type": "string" }, "example": [ "Color", "Size" ] }, "theme": { "description": "Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family.", "type": [ "string", "null" ], "example": "ColorSize" } }, "type": "object" }, "CatalogItemSalesRanksByMarketplace": { "description": "Sales ranks for an item grouped by marketplace.", "properties": { "marketplaceId": { "description": "Amazon marketplace identifier.", "type": "string", "example": "ATVPDKIKX0DER" }, "classificationRanks": { "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemClassificationSalesRank" } }, "displayGroupRanks": { "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemDisplayGroupSalesRank" } } }, "type": "object" }, "CatalogItemClassificationSalesRank": { "description": "Sales rank by classification.", "properties": { "classificationId": { "description": "Identifier of the classification that is associated with the sales rank.", "type": "string", "example": "123456789" }, "title": { "description": "Name of the sales rank.", "type": "string", "example": "Best Sellers in Electronics" }, "rank": { "description": "Sales rank.", "type": "integer", "example": 1 }, "link": { "description": "Corresponding Amazon retail website URL for the sales category.", "type": [ "string", "null" ], "format": "url", "example": "https://www.amazon.com/gp/bestsellers/electronics" } }, "type": "object" }, "CatalogItemDisplayGroupSalesRank": { "description": "Sales rank by display group.", "properties": { "websiteDisplayGroup": { "description": "Name of the website display group that is associated with the sales rank", "type": "string", "example": "electronics" }, "title": { "description": "Name of the sales rank.", "type": "string", "example": "Best Sellers in Electronics" }, "rank": { "description": "Sales rank.", "type": "integer", "example": 1 }, "link": { "description": "Corresponding Amazon retail website URL for the sales rank.", "type": [ "string", "null" ], "format": "url", "example": "https://www.amazon.com/gp/bestsellers/electronics" } }, "type": "object" }, "CatalogItemSummaryByMarketplace": { "description": "Summary of an Amazon catalog item by marketplace.", "properties": { "marketplaceId": { "description": "Amazon marketplace identifier.", "type": "string", "example": "ATVPDKIKX0DER" }, "adultProduct": { "description": "When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature.", "type": [ "boolean", "null" ], "example": false }, "autographed": { "description": "When `true`, the Amazon catalog item is autographed.", "type": [ "boolean", "null" ], "example": false }, "brand": { "description": "Name of the brand that is associated with the Amazon catalog item.", "type": [ "string", "null" ], "example": "Samsung" }, "browseClassification": { "oneOf": [ { "$ref": "#/components/schemas/CatalogItemBrowseClassification", "description": "Classification (browse node) for an Amazon catalog item." }, { "type": "null" } ], "description": "Classification (browse node) for an Amazon catalog item." }, "color": { "description": "The color that is associated with the Amazon catalog item.", "type": [ "string", "null" ], "example": "Black" }, "contributors": { "description": "Individual contributors to the creation of the item, such as the authors or actors.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CatalogItemContributor" } }, "itemClassification": { "description": "Classification type that is associated with the Amazon catalog item.", "type": [ "string", "null" ], "example": "BASE_PRODUCT" }, "itemName": { "description": "The name that is associated with the Amazon catalog item.", "type": [ "string", "null" ], "example": "Samsung QLED TV" }, "manufacturer": { "description": "The name of the manufacturer that is associated with the Amazon catalog item.", "type": [ "string", "null" ], "example": "Samsung Electronics" }, "memorabilia": { "description": "When true, the item is classified as memorabilia.", "type": [ "boolean", "null" ], "example": false }, "modelNumber": { "description": "The model number that is associated with the Amazon catalog item.", "type": [ "string", "null" ], "example": "QN82Q60RAFXZA" }, "packageQuantity": { "description": "The quantity of the Amazon catalog item within one package.", "type": [ "integer", "null" ], "example": 1 }, "partNumber": { "description": "The part number that is associated with the Amazon catalog item.", "type": [ "string", "null" ], "example": "QN82Q60RAFXZA" }, "releaseDate": { "description": "The earliest date on which the Amazon catalog item can be shipped to customers.", "type": [ "string", "null" ], "format": "date-time", "example": "2021-03-01T00:00:00Z" }, "size": { "description": "The name of the size of the Amazon catalog item.", "type": [ "string", "null" ], "example": "82-inch" }, "style": { "description": "The name of the style that is associated with the Amazon catalog item.", "type": [ "string", "null" ], "example": "Flat" }, "tradeInEligible": { "description": "When true, the Amazon catalog item is eligible for trade-in.", "type": [ "boolean", "null" ], "example": true }, "websiteDisplayGroup": { "description": "The identifier of the website display group that is associated with the Amazon catalog item.", "type": [ "string", "null" ], "example": "electronics" }, "websiteDisplayGroupName": { "description": "The display name of the website display group that is associated with the Amazon catalog item.", "type": [ "string", "null" ], "example": "Electronics" } }, "type": "object" }, "CatalogItemContributor": { "description": "Contributor to an Amazon catalog item.", "properties": { "role": { "$ref": "#/components/schemas/CatalogItemContributorRole", "description": "Role of an individual contributor in the creation of an item, such as author or actor." }, "value": { "description": "Name of the contributor, such as `Jane Austen`.", "type": "string", "example": "John Smith" } }, "type": "object" }, "CatalogItemContributorRole": { "description": "Role of a contributor.", "properties": { "value": { "description": "Role value for the Amazon catalog item, such as `author` or `actor`.", "type": "string", "example": "author" }, "displayName": { "description": "Display name of the role in the requested locale, such as `Author` or `Actor`.", "type": [ "string", "null" ], "example": "Author" } }, "type": "object" }, "CatalogItemVendorDetailsByMarketplace": { "description": "Vendor details for an item grouped by marketplace.", "properties": { "marketplaceId": { "description": "Amazon marketplace identifier.", "type": "string", "example": "ATVPDKIKX0DER" }, "brandCode": { "description": "The brand code that is associated with an Amazon catalog item.", "type": [ "string", "null" ], "example": "SAMSUNG" }, "manufacturerCode": { "description": "The manufacturer code that is associated with an Amazon catalog item.", "type": [ "string", "null" ], "example": "SAMSUNG" }, "manufacturerCodeParent": { "description": "The parent vendor code of the manufacturer code.", "type": [ "string", "null" ], "example": "SAMSUNG_PARENT" }, "productCategory": { "oneOf": [ { "$ref": "#/components/schemas/CatalogItemVendorDetailsCategory", "description": "The product category or subcategory that is associated with an Amazon catalog item." }, { "type": "null" } ], "description": "The product category or subcategory that is associated with an Amazon catalog item." }, "productGroup": { "description": "The product group that is associated with an Amazon catalog item.", "type": [ "string", "null" ], "example": "Electronics" }, "productSubcategory": { "oneOf": [ { "$ref": "#/components/schemas/CatalogItemVendorDetailsCategory", "description": "The product category or subcategory that is associated with an Amazon catalog item." }, { "type": "null" } ], "description": "The product category or subcategory that is associated with an Amazon catalog item." }, "replenishmentCategory": { "description": "The replenishment category that is associated with an Amazon catalog item.", "type": [ "string", "null" ], "example": "BASIC" } }, "type": "object" }, "CatalogItemVendorDetailsCategory": { "description": "Vendor details category.", "properties": { "displayName": { "description": "The display name of the product category or subcategory.", "type": [ "string", "null" ], "example": "Electronics" }, "value": { "description": "The code that identifies the product category or subcategory.", "type": [ "string", "null" ], "example": "50400100" } }, "type": "object" }, "SearchCatalogItemsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to search catalog items" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "GetCatalogItemInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get catalog item" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "GetInventorySummariesResponse": { "description": "The response object for getting inventory summaries.", "properties": { "payload": { "oneOf": [ { "$ref": "#/components/schemas/GetInventorySummariesResult", "description": "The payload schema for the getInventorySummaries operation." }, { "type": "null" } ], "description": "The payload schema for the getInventorySummaries operation." }, "pagination": { "oneOf": [ { "$ref": "#/components/schemas/InventoryPagination", "description": "The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management." }, { "type": "null" } ], "description": "The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management." } }, "type": "object" }, "GetInventorySummariesResult": { "description": "The result object for getting inventory summaries.", "properties": { "granularity": { "$ref": "#/components/schemas/Granularity", "description": "Describes a granularity at which inventory data can be aggregated." }, "inventorySummaries": { "description": "A list of inventory summaries.", "type": "array", "items": { "$ref": "#/components/schemas/InventorySummary" } } }, "type": "object" }, "InventoryPagination": { "description": "The process of returning the results to a request in batches of a defined size called pages.", "properties": { "nextToken": { "description": "A token that can be used to retrieve the next page of results.", "type": [ "string", "null" ], "example": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234" }, "previousToken": { "description": "A token that can be used to retrieve the previous page of results.", "type": [ "string", "null" ], "example": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d" } }, "type": "object" }, "Granularity": { "description": "Describes a granularity at which inventory data can be aggregated.", "properties": { "granularityType": { "description": "The granularity type for the inventory aggregation level.", "type": "string", "example": "Marketplace" }, "granularityId": { "description": "The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId.", "type": "string", "example": "ATVPDKIKX0DER" } }, "type": "object" }, "InventorySummary": { "description": "Inventory summary for an item.", "properties": { "asin": { "description": "The Amazon Standard Identification Number (ASIN) of an item.", "type": [ "string", "null" ], "example": "B00U26V4VQ" }, "fnSku": { "description": "Amazon's fulfillment network SKU identifier.", "type": [ "string", "null" ], "example": "X0000000XX" }, "sellerSku": { "description": "The seller SKU of the item.", "type": [ "string", "null" ], "example": "SKU-12345" }, "condition": { "description": "The condition of the item as described by the seller (for example, New Item).", "type": [ "string", "null" ], "example": "New Item" }, "inventoryDetails": { "oneOf": [ { "$ref": "#/components/schemas/InventoryDetails", "description": "Summarized inventory details. This object will not appear if the details parameter in the request is false." }, { "type": "null" } ], "description": "Summarized inventory details. This object will not appear if the details parameter in the request is false." }, "lastUpdatedTime": { "description": "The date and time that any quantity was last updated.", "type": [ "string", "null" ], "format": "date-time", "example": "2023-01-15T12:30:45Z" }, "productName": { "description": "The localized language product title of the item within the specific marketplace.", "type": [ "string", "null" ], "example": "Samsung QLED TV 82-inch" }, "totalQuantity": { "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers.", "type": [ "integer", "null" ], "example": 150 }, "stores": { "description": "A list of seller-enrolled stores that apply to this seller SKU.", "type": [ "array", "null" ], "items": { "type": "string" } } }, "type": "object" }, "InventoryDetails": { "description": "Summarized inventory details.", "properties": { "fulfillableQuantity": { "description": "The item quantity that can be picked, packed, and shipped.", "type": [ "integer", "null" ], "example": 100 }, "inboundWorkingQuantity": { "description": "The number of units in an inbound shipment for which you have notified Amazon.", "type": [ "integer", "null" ], "example": 25 }, "inboundShippedQuantity": { "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number.", "type": [ "integer", "null" ], "example": 15 }, "inboundReceivingQuantity": { "description": "The number of units that have not yet been received at an Amazon fulfillment center for processing, but are part of an inbound shipment with some units that have already been received and processed.", "type": [ "integer", "null" ], "example": 10 }, "reservedQuantity": { "oneOf": [ { "$ref": "#/components/schemas/ReservedQuantity", "description": "The quantity of reserved inventory." }, { "type": "null" } ], "description": "The quantity of reserved inventory." }, "researchingQuantity": { "oneOf": [ { "$ref": "#/components/schemas/ResearchingQuantity", "description": "The number of misplaced or warehouse damaged units that are actively being confirmed at our fulfillment centers." }, { "type": "null" } ], "description": "The number of misplaced or warehouse damaged units that are actively being confirmed at our fulfillment centers." }, "unfulfillableQuantity": { "oneOf": [ { "$ref": "#/components/schemas/UnfulfillableQuantity", "description": "The quantity of unfulfillable inventory." }, { "type": "null" } ], "description": "The quantity of unfulfillable inventory." } }, "type": "object" }, "ReservedQuantity": { "description": "The quantity of reserved inventory.", "properties": { "totalReservedQuantity": { "description": "The total number of units in Amazon's fulfillment network that are currently being picked, packed, and shipped; or are sidelined for measurement, sampling, or other internal processes.", "type": [ "integer", "null" ], "example": 20 }, "pendingCustomerOrderQuantity": { "description": "The number of units reserved for customer orders.", "type": [ "integer", "null" ], "example": 15 }, "pendingTransshipmentQuantity": { "description": "The number of units being transferred from one fulfillment center to another.", "type": [ "integer", "null" ], "example": 3 }, "fcProcessingQuantity": { "description": "The number of units that have been sidelined at the fulfillment center for additional processing.", "type": [ "integer", "null" ], "example": 2 } }, "type": "object" }, "ResearchingQuantity": { "description": "The number of misplaced or warehouse damaged units that are actively being confirmed at our fulfillment centers.", "properties": { "totalResearchingQuantity": { "description": "The total number of units currently being researched in Amazon's fulfillment network.", "type": [ "integer", "null" ], "example": 5 }, "researchingQuantityBreakdown": { "description": "A list of quantity details for items currently being researched.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ResearchingQuantityEntry" } } }, "type": "object" }, "ResearchingQuantityEntry": { "description": "Quantity details for items currently being researched.", "properties": { "name": { "description": "The duration of the research.", "type": "string", "example": "researching_quantity_short_term" }, "quantity": { "description": "The number of units.", "type": "integer", "example": 3 } }, "type": "object" }, "UnfulfillableQuantity": { "description": "The quantity of unfulfillable inventory.", "properties": { "totalUnfulfillableQuantity": { "description": "The total number of units in Amazon's fulfillment network in unsellable condition.", "type": [ "integer", "null" ], "example": 8 }, "customerDamagedQuantity": { "description": "The number of units in customer damaged disposition.", "type": [ "integer", "null" ], "example": 2 }, "warehouseDamagedQuantity": { "description": "The number of units in warehouse damaged disposition.", "type": [ "integer", "null" ], "example": 3 }, "distributorDamagedQuantity": { "description": "The number of units in distributor damaged disposition.", "type": [ "integer", "null" ], "example": 1 }, "carrierDamagedQuantity": { "description": "The number of units in carrier damaged disposition.", "type": [ "integer", "null" ], "example": 1 }, "defectiveQuantity": { "description": "The number of units in defective disposition.", "type": [ "integer", "null" ], "example": 1 }, "expiredQuantity": { "description": "The number of units in expired disposition.", "type": [ "integer", "null" ], "example": 0 } }, "type": "object" }, "GetInventorySummariesInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get inventory summaries" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "SpApiMoney": { "properties": { "CurrencyCode": { "type": "string", "example": "USD" }, "Value": { "type": "number", "format": "float", "example": 0 } }, "type": "object" }, "ShipmentAddress": { "properties": { "Name": { "type": "string" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": [ "string", "null" ], "example": null }, "DistrictOrCounty": { "type": [ "string", "null" ], "example": null }, "City": { "type": "string" }, "StateOrProvinceCode": { "type": "string" }, "CountryCode": { "type": "string" }, "PostalCode": { "type": "string" } }, "type": "object" }, "OldShipment": { "properties": { "ShipmentId": { "type": "string", "example": "FBA3MXN6HN" }, "ShipmentName": { "type": "string", "example": "FBA (5/25/16 9:36 AM) - 1" }, "ShipFromAddress": { "$ref": "#/components/schemas/ShipmentAddress" }, "DestinationFulfillmentCenterId": { "type": "string", "example": "CHA1" }, "ShipmentStatus": { "type": "string", "enum": [ "WORKING", "CLOSED", "CANCELLED", "DELETED" ], "example": "CLOSED" }, "LabelPrepType": { "type": "string", "enum": [ "NO_LABEL", "SELLER_LABEL" ], "example": "SELLER_LABEL" }, "AreCasesRequired": { "type": [ "boolean", "null" ], "example": true }, "ConfirmedNeedByDate": { "type": [ "string", "null" ], "format": "date", "example": "2025-05-26" }, "BoxContentsSource": { "type": [ "string", "null" ], "enum": [ "NONE", "FEED", "INTERACTIVE" ], "example": "INTERACTIVE" }, "EstimatedBoxContentsFee": { "properties": { "TotalUnits": { "type": "integer", "example": 0 }, "FeePerUnit": { "$ref": "#/components/schemas/SpApiMoney" }, "TotalFee": { "$ref": "#/components/schemas/SpApiMoney" } }, "type": [ "object", "null" ] } }, "type": "object" }, "GetShipmentsResponse": { "properties": { "payload": { "properties": { "ShipmentData": { "type": "array", "items": { "$ref": "#/components/schemas/OldShipment" } }, "NextToken": { "description": "Pagination token for next page of results", "type": "string" } }, "type": "object" } }, "type": "object" }, "GetShipmentsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get shipments" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "OldShipmentItem": { "required": [ "SellerSKU", "QuantityShipped" ], "properties": { "ShipmentId": { "description": "A shipment identifier originally returned by the createInboundShipmentPlan operation.", "type": "string", "example": "FBA3MXN6HN" }, "SellerSKU": { "description": "The seller SKU of the item.", "type": "string", "example": "SKU12345" }, "FulfillmentNetworkSKU": { "description": "Amazon's fulfillment network SKU of the item.", "type": [ "string", "null" ], "example": "X00012345" }, "QuantityShipped": { "description": "The item quantity shipped.", "type": "integer", "format": "int32", "example": 10 }, "QuantityReceived": { "description": "The item quantity received.", "type": [ "integer", "null" ], "format": "int32", "example": 8 }, "QuantityInCase": { "description": "The item quantity per case.", "type": [ "integer", "null" ], "format": "int32", "example": 2 }, "ReleaseDate": { "description": "The release date of the item.", "type": [ "string", "null" ], "format": "date", "example": "2025-05-26" }, "PrepDetailsList": { "description": "A list of preparation instructions and who is responsible for that preparation.", "type": [ "array", "null" ], "items": { "required": [ "PrepInstruction", "PrepOwner" ], "properties": { "PrepInstruction": { "description": "Preparation instructions for shipping an item to Amazon's fulfillment network.", "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ], "example": "Labeling" }, "PrepOwner": { "description": "Indicates who will prepare the item.", "type": "string", "enum": [ "AMAZON", "SELLER" ], "example": "SELLER" } }, "type": "object" } } }, "type": "object" }, "GetShipmentItemsResponse": { "properties": { "payload": { "properties": { "ItemData": { "type": "array", "items": { "$ref": "#/components/schemas/OldShipmentItem" } }, "NextToken": { "description": "Pagination token for next page of results", "type": "string" } }, "type": "object" } }, "type": "object" }, "GetShipmentItemsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get shipment items" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "GetShipmentItemsByShipmentIdResponse": { "properties": { "payload": { "properties": { "ItemData": { "type": "array", "items": { "$ref": "#/components/schemas/OldShipmentItem" } }, "NextToken": { "description": "Pagination token for next page of results", "type": "string" } }, "type": "object" } }, "type": "object" }, "GetShipmentItemsByShipmentIdInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get shipment items by shipment id" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ListInboundPlansResponse": { "properties": { "inboundPlans": { "description": "A list of inbound plans.", "type": "array", "items": { "$ref": "#/components/schemas/InboundPlanSummary" } }, "pagination": { "properties": { "nextToken": { "description": "When present, pass this string token in the next request to return the next response page.", "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1, "example": "eyJNYXJrZXJ..." } }, "type": [ "object", "null" ] } }, "type": "object" }, "InboundPlanSummary": { "required": [ "createdAt", "inboundPlanId", "lastUpdatedAt", "marketplaceIds", "name", "sourceAddress", "status" ], "properties": { "createdAt": { "description": "The time at which the inbound plan was created. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.", "type": "string", "format": "date-time", "example": "2025-05-26T09:36:00Z" }, "inboundPlanId": { "description": "Identifier of an inbound plan.", "type": "string", "maxLength": 38, "minLength": 38, "example": "ABCDEFGH1234567890ABCDEFGH1234567890" }, "lastUpdatedAt": { "description": "The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.", "type": "string", "format": "date-time", "example": "2025-05-26T10:36:00Z" }, "marketplaceIds": { "description": "A list of marketplace IDs.", "type": "array", "items": { "type": "string" }, "example": [ "ATVPDKIKX0DER" ] }, "name": { "description": "Human-readable name of the inbound plan.", "type": "string", "example": "Summer 2025 Inventory Shipment" }, "sourceAddress": { "$ref": "#/components/schemas/Address" }, "status": { "description": "The current status of the inbound plan.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "ACTIVE", "VOIDED", "SHIPPED", "ERRORED" ], "example": "ACTIVE" } }, "type": "object" }, "Address": { "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ], "properties": { "addressLine1": { "description": "Street address information.", "type": "string", "maxLength": 180, "minLength": 1, "example": "123 Main St" }, "addressLine2": { "description": "Additional street address information.", "type": [ "string", "null" ], "maxLength": 60, "minLength": 1, "example": "Suite 100" }, "city": { "description": "The city.", "type": "string", "maxLength": 30, "minLength": 1, "example": "Seattle" }, "companyName": { "description": "The name of the business.", "type": [ "string", "null" ], "maxLength": 50, "minLength": 1, "example": "Acme Inc" }, "countryCode": { "description": "The country code in two-character ISO 3166-1 alpha-2 format.", "type": "string", "maxLength": 2, "minLength": 2, "example": "US" }, "email": { "description": "The email address.", "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1, "example": "contact@example.com" }, "name": { "description": "The name of the individual who is the primary contact.", "type": "string", "maxLength": 50, "minLength": 1, "example": "John Doe" }, "phoneNumber": { "description": "The phone number.", "type": [ "string", "null" ], "maxLength": 20, "minLength": 1, "example": "+12065551234" }, "postalCode": { "description": "The postal code.", "type": "string", "maxLength": 32, "minLength": 1, "example": "98109" }, "stateOrProvinceCode": { "description": "The state or province code.", "type": [ "string", "null" ], "maxLength": 64, "minLength": 1, "example": "WA" } }, "type": "object" }, "ListInboundPlansInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to list inbound plans" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "GetInboundPlanResponse": { "required": [ "createdAt", "inboundPlanId", "lastUpdatedAt", "marketplaceIds", "name", "sourceAddress", "status" ], "properties": { "createdAt": { "description": "The time at which the inbound plan was created. In ISO 8601 datetime with pattern yyyy-MM-ddTHH:mm:ssZ.", "type": "string", "format": "date-time", "example": "2025-05-26T09:36:00Z" }, "inboundPlanId": { "description": "Identifier of an inbound plan.", "type": "string", "maxLength": 38, "minLength": 38, "example": "ABCDEFGH1234567890ABCDEFGH1234567890" }, "lastUpdatedAt": { "description": "The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.", "type": "string", "format": "date-time", "example": "2025-05-26T10:36:00Z" }, "marketplaceIds": { "description": "A list of marketplace IDs.", "type": "array", "items": { "type": "string" }, "example": [ "ATVPDKIKX0DER" ] }, "name": { "description": "Human-readable name of the inbound plan.", "type": "string", "example": "Summer 2025 Inventory Shipment" }, "packingOptions": { "description": "Packing options for the inbound plan.", "type": [ "array", "null" ], "items": { "required": [ "packingOptionId", "status" ], "properties": { "packingOptionId": { "description": "Identifier of a packing option.", "type": "string", "example": "pof3a5b9e4-6aa4-45f8-bf96-6603da02e3a0" }, "status": { "description": "The status of a packing option.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "OFFERED", "ACCEPTED", "EXPIRED" ], "example": "OFFERED" } }, "type": "object" } }, "placementOptions": { "description": "Placement options for the inbound plan.", "type": [ "array", "null" ], "items": { "required": [ "placementOptionId", "status" ], "properties": { "placementOptionId": { "description": "The identifier of a placement option.", "type": "string", "maxLength": 38, "minLength": 38, "example": "PLACE1234567890ABCDEFGH1234567890ABCD" }, "status": { "description": "The status of a placement option.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "OFFERED", "ACCEPTED" ], "example": "OFFERED" } }, "type": "object" } }, "shipments": { "description": "A list of shipment IDs for the inbound plan.", "type": [ "array", "null" ], "items": { "required": [ "shipmentId", "status" ], "properties": { "shipmentId": { "description": "Identifier of a shipment.", "type": "string", "maxLength": 38, "minLength": 38, "example": "SHIP1234567890ABCDEFGH1234567890ABCDEF" }, "status": { "description": "The status of a shipment.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ], "example": "UNCONFIRMED" } }, "type": "object" } }, "sourceAddress": { "$ref": "#/components/schemas/Address" }, "status": { "description": "Current status of the inbound plan.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "ACTIVE", "VOIDED", "SHIPPED", "ERRORED" ], "example": "ACTIVE" } }, "type": "object" }, "GetInboundPlanInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get inbound plan" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ListPlacementOptionsResponse": { "required": [ "placementOptions" ], "properties": { "pagination": { "properties": { "nextToken": { "description": "When present, pass this string token in the next request to return the next response page.", "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1, "example": "eyJNYXJrZXJ..." } }, "type": [ "object", "null" ] }, "placementOptions": { "description": "Placement options generated for the inbound plan.", "type": "array", "items": { "$ref": "#/components/schemas/PlacementOption" } } }, "type": "object" }, "PlacementOption": { "required": [ "discounts", "fees", "placementOptionId", "shipmentIds", "status" ], "properties": { "discounts": { "description": "Discount for the offered option.", "type": "array", "items": { "$ref": "#/components/schemas/Incentive" } }, "expiration": { "description": "The expiration date of the placement option.", "type": [ "string", "null" ], "format": "date-time", "example": "2025-12-31T23:59:59.999Z" }, "fees": { "description": "The fee for the offered option.", "type": "array", "items": { "$ref": "#/components/schemas/Incentive" } }, "placementOptionId": { "description": "The identifier of a placement option.", "type": "string", "maxLength": 38, "minLength": 38, "example": "PLACE1234567890ABCDEFGH1234567890ABCD" }, "shipmentIds": { "description": "Shipment ids.", "type": "array", "items": { "type": "string" }, "example": [ "SHIP1234567890ABCDEFGH1234567890ABCDEF" ] }, "status": { "description": "The status of a placement option.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "OFFERED", "ACCEPTED", "EXPIRED" ], "example": "OFFERED" } }, "type": "object" }, "Incentive": { "required": [ "description", "target", "type", "value" ], "properties": { "description": { "description": "Description of the incentive.", "type": "string", "maxLength": 1024, "minLength": 1, "example": "10% discount on fulfillment fees" }, "target": { "description": "Target of the incentive.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "Placement Services", "Fulfillment Fee Discount" ], "example": "Fulfillment Fee Discount" }, "type": { "description": "Type of incentive.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "FEE", "DISCOUNT" ], "example": "DISCOUNT" }, "value": { "$ref": "#/components/schemas/CurrencyValue" } }, "type": "object" }, "CurrencyValue": { "required": [ "amount", "code" ], "properties": { "amount": { "description": "Decimal value of the currency.", "type": "number", "format": "float", "example": 10.5 }, "code": { "description": "ISO 4217 standard of a currency code.", "type": "string", "maxLength": 3, "minLength": 3, "example": "USD" } }, "type": "object" }, "ListPlacementOptionsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to list placement options" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "TransportationOption": { "required": [ "carrier", "preconditions", "shipmentId", "shippingMode", "shippingSolution", "transportationOptionId" ], "properties": { "carrier": { "required": [ "alphaCode", "name" ], "properties": { "alphaCode": { "description": "The carrier code.", "type": "string", "maxLength": 1024, "minLength": 1, "example": "USPS" }, "name": { "description": "The name of the carrier.", "type": "string", "maxLength": 1024, "minLength": 1, "example": "United States Postal Service" } }, "type": "object" }, "carrierAppointment": { "required": [ "endTime", "startTime" ], "properties": { "endTime": { "description": "The end timestamp of the appointment in UTC.", "type": "string", "format": "date-time", "example": "2025-12-31T23:59:59.999Z" }, "startTime": { "description": "The start timestamp of the appointment in UTC.", "type": "string", "format": "date-time", "example": "2025-12-31T09:00:00.000Z" } }, "type": [ "object", "null" ] }, "preconditions": { "description": "Identifies a list of preconditions for confirming the transportation option.", "type": "array", "items": { "type": "string" } }, "quote": { "required": [ "cost" ], "properties": { "cost": { "$ref": "#/components/schemas/CurrencyValue" }, "expiration": { "description": "The time at which this transportation option quote expires.", "type": [ "string", "null" ], "format": "date-time", "example": "2025-12-31T23:59:59.999Z" }, "voidableUntil": { "description": "Voidable until timestamp.", "type": [ "string", "null" ], "format": "date-time", "example": "2025-12-31T23:59:59.999Z" } }, "type": [ "object", "null" ] }, "shipmentId": { "description": "Identifier of a shipment.", "type": "string", "maxLength": 38, "minLength": 38, "example": "SHIP1234567890ABCDEFGH1234567890ABCDEF" }, "shippingMode": { "description": "Mode of shipment transportation.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "GROUND_SMALL_PARCEL", "FREIGHT_LTL", "FREIGHT_FTL_PALLET", "FREIGHT_FTL_NONPALLET", "OCEAN_LCL", "OCEAN_FCL", "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS" ], "example": "GROUND_SMALL_PARCEL" }, "shippingSolution": { "description": "Shipping program for the option.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ], "example": "AMAZON_PARTNERED_CARRIER" }, "transportationOptionId": { "description": "Identifier of a transportation option.", "type": "string", "maxLength": 38, "minLength": 38, "example": "TRANS1234567890ABCDEFGH1234567890ABCD" } }, "type": "object" }, "ListTransportationOptionsResponse": { "required": [ "transportationOptions" ], "properties": { "pagination": { "properties": { "nextToken": { "description": "When present, pass this string token in the next request to return the next response page.", "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 } }, "type": "object" }, "transportationOptions": { "description": "Transportation options generated for the placement option.", "type": "array", "items": { "$ref": "#/components/schemas/TransportationOption" } } }, "type": "object" }, "ListTransportationOptionsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to list transportation options" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ShipmentSummary": { "properties": { "amazonReferenceId": { "description": "A unique identifier created by Amazon that identifies this Amazon-partnered shipment.", "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 }, "contactInformation": { "properties": { "email": { "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 }, "name": { "description": "The contact's name.", "type": "string", "maxLength": 50, "minLength": 1 }, "phoneNumber": { "description": "The phone number.", "type": "string", "maxLength": 20, "minLength": 1 } }, "type": [ "object", "null" ] }, "dates": { "properties": { "readyToShipWindow": { "required": [ "end", "start" ], "properties": { "editableUntil": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "start": { "type": "string", "format": "date-time" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "destination": { "properties": { "address": { "$ref": "#/components/schemas/Address" }, "destinationType": { "description": "The type of destination for this shipment.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "AMAZON_OPTIMIZED", "AMAZON_WAREHOUSE" ] }, "warehouseId": { "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 } }, "type": "object" }, "freightInformation": { "properties": { "declaredValue": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyValue" }, { "type": "null" } ] }, "freightClass": { "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1, "enum": [ "NONE", "FC_50", "FC_55", "FC_60", "FC_65", "FC_70", "FC_77_5", "FC_85", "FC_92_5", "FC_100", "FC_110", "FC_125", "FC_150", "FC_175", "FC_200", "FC_250", "FC_300", "FC_400", "FC_500" ] }, "name": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "placementOptionId": { "description": "The identifier of a placement option.", "type": "string", "maxLength": 38, "minLength": 38 }, "selectedDeliveryWindow": { "required": [ "availabilityType", "deliveryWindowOptionId", "endDate", "startDate" ], "properties": { "availabilityType": { "description": "Identifies type of Delivery Window Availability.", "type": "string", "enum": [ "AVAILABLE", "CONGESTED" ] }, "deliveryWindowOptionId": { "description": "Identifier of a delivery window option.", "type": "string", "maxLength": 38, "minLength": 36 }, "editableUntil": { "type": [ "string", "null" ], "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" } }, "type": [ "object", "null" ] }, "selectedTransportationOptionId": { "type": [ "string", "null" ], "maxLength": 38, "minLength": 38 }, "selfShipAppointmentDetails": { "type": [ "array", "null" ], "items": { "properties": { "appointmentId": { "description": "Identifier for appointment.", "type": "number" }, "appointmentSlotTime": { "required": [ "endTime", "startTime" ], "properties": { "endTime": { "type": "string", "format": "date-time" }, "startTime": { "type": "string", "format": "date-time" } }, "type": "object" }, "appointmentStatus": { "type": "string", "maxLength": 1024, "minLength": 1 } }, "type": "object" } }, "shipmentConfirmationId": { "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 }, "shipmentId": { "description": "Identifier of a shipment.", "type": "string", "maxLength": 38, "minLength": 38 }, "source": { "properties": { "address": { "$ref": "#/components/schemas/Address" }, "sourceType": { "description": "The type of source for this shipment.", "type": "string", "maxLength": 1024, "minLength": 1, "enum": [ "SELLER_FACILITY" ] } }, "type": "object" }, "status": { "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1, "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ] }, "trackingDetails": { "properties": { "ltlTrackingDetail": { "properties": { "billOfLadingNumber": { "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 }, "freightBillNumber": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "type": [ "object", "null" ] }, "spdTrackingDetail": { "properties": { "spdTrackingItems": { "type": [ "array", "null" ], "items": { "properties": { "boxId": { "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 }, "trackingId": { "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 }, "trackingNumberValidationStatus": { "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1, "enum": [ "VALIDATED", "NOT_VALIDATED" ] } }, "type": "object" } } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] } }, "type": "object" }, "GetShipmentInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get shipment" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ShipmentItem": { "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ], "properties": { "asin": { "description": "The Amazon Standard Identification Number (ASIN) of the item.", "type": "string", "example": "B00U26V4VQ" }, "expiration": { "description": "The expiration date of the MSKU in YYYY-MM-DD format.", "type": [ "string", "null" ], "format": "date", "example": "2025-12-31" }, "fnsku": { "description": "A unique identifier assigned by Amazon to products stored in fulfillment centers.", "type": "string", "example": "X004PJ3U37" }, "labelOwner": { "description": "Specifies who will label the items.", "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "example": "SELLER" }, "manufacturingLotCode": { "description": "Manufacturing lot code.", "type": [ "string", "null" ], "example": "LOT12345" }, "msku": { "description": "The merchant SKU identifier.", "type": "string", "example": "M.Cornell Import 14-03-2025 B00U26V4VQ" }, "prepInstructions": { "description": "Special preparations that are required for an item.", "type": "array", "items": { "$ref": "#/components/schemas/PrepInstruction" } }, "quantity": { "description": "The number of the specified MSKU.", "type": "integer", "example": 10 } }, "type": "object" }, "PrepInstruction": { "properties": { "fee": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyValue", "description": "The fee for the preparation." }, { "type": "null" } ], "description": "The fee for the preparation." }, "prepOwner": { "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations.", "type": [ "string", "null" ], "enum": [ "AMAZON", "SELLER", "NONE" ], "example": "SELLER" }, "prepType": { "description": "Type of preparation that should be done.", "type": [ "string", "null" ], "enum": [ "ITEM_LABELING", "ITEM_BUBBLEWRAP", "ITEM_POLYBAGGING", "ITEM_TAPING", "ITEM_BLACK_SHRINKWRAP", "ITEM_HANG_GARMENT", "ITEM_BOXING", "ITEM_SETCREAT", "ITEM_RMOVHANG", "ITEM_SUFFOSTK", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_NO_PREP", "ADULT", "BABY", "TEXTILE", "HANGER", "FRAGILE", "LIQUID", "SHARP", "SMALL", "PERFORATED", "GRANULAR", "SET", "FC_PROVIDED", "UNKNOWN", "NONE" ], "example": "ITEM_LABELING" } }, "type": "object" }, "ListShipmentItemsResponse": { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentItem" } }, "pagination": { "properties": { "nextToken": { "description": "Token for pagination to fetch next page of results.", "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 } }, "type": [ "object", "null" ] } }, "type": "object" }, "ListShipmentItemsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to list shipment items" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ListInboundPlanBoxesResponse": { "required": [ "boxes" ], "properties": { "boxes": { "description": "A list of boxes in an inbound plan.", "type": "array", "items": { "$ref": "#/components/schemas/Box" } }, "pagination": { "properties": { "nextToken": { "description": "When present, pass this string token in the next request to return the next response page.", "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 } }, "type": [ "object", "null" ] } }, "type": "object" }, "Box": { "required": [ "packageId" ], "properties": { "packageId": { "description": "Primary key to uniquely identify a Package (Box or Pallet).", "type": "string", "example": "pk6949947a-ffd4-4bfa-a55a-c73b3403d633" }, "boxId": { "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID and the index of the box.", "type": [ "string", "null" ], "example": "FBA18XW7GGHWU000001" }, "contentInformationSource": { "description": "Indication of how box content is meant to be provided.", "type": [ "string", "null" ], "enum": [ "INTERACTIVE", "FEED", "NONE" ], "example": "INTERACTIVE" }, "destinationRegion": { "oneOf": [ { "$ref": "#/components/schemas/Region", "description": "Representation of a location used within the inbounding experience." }, { "type": "null" } ], "description": "Representation of a location used within the inbounding experience." }, "dimensions": { "oneOf": [ { "$ref": "#/components/schemas/BoxDimensions", "description": "Measurement of a package's dimensions." }, { "type": "null" } ], "description": "Measurement of a package's dimensions." }, "externalContainerIdentifier": { "description": "The external identifier for this container / box.", "type": [ "string", "null" ], "example": "FBA18XW7GGHWU000001" }, "externalContainerIdentifierType": { "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`.", "type": [ "string", "null" ], "example": "AMAZON" }, "items": { "description": "Items contained within the box.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ShipmentItem" } }, "quantity": { "description": "The number of containers where all other properties like weight or dimensions are identical.", "type": [ "integer", "null" ], "example": 1 }, "templateName": { "description": "Template name of the box.", "type": [ "string", "null" ], "example": "Standard Box" }, "weight": { "oneOf": [ { "$ref": "#/components/schemas/BoxWeight", "description": "The weight of a package." }, { "type": "null" } ], "description": "The weight of a package." } }, "type": "object" }, "Region": { "properties": { "countryCode": { "description": "ISO 3166 standard alpha-2 country code.", "type": [ "string", "null" ], "example": "US" }, "state": { "description": "State.", "type": [ "string", "null" ], "example": "WA" }, "warehouseId": { "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage.", "type": [ "string", "null" ], "example": "ABE1" } }, "type": "object" }, "BoxDimensions": { "required": [ "height", "length", "unitOfMeasurement", "width" ], "properties": { "height": { "description": "The height of a package.", "type": "number", "format": "float", "example": 10.5 }, "length": { "description": "The length of a package.", "type": "number", "format": "float", "example": 15.2 }, "unitOfMeasurement": { "description": "Unit of linear measure.", "type": "string", "example": "in" }, "width": { "description": "The width of a package.", "type": "number", "format": "float", "example": 12.8 } }, "type": "object" }, "BoxWeight": { "required": [ "unit", "value" ], "properties": { "unit": { "description": "Unit of the weight being measured.", "type": "string", "example": "LB" }, "value": { "description": "Value of a weight.", "type": "number", "format": "float", "example": 10 } }, "type": "object" }, "ListInboundPlanBoxesInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to list inbound plan boxes" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ListShipmentBoxesResponse": { "required": [ "boxes" ], "properties": { "boxes": { "description": "A list of boxes in a shipment.", "type": "array", "items": { "$ref": "#/components/schemas/Box" } }, "pagination": { "properties": { "nextToken": { "description": "When present, pass this string token in the next request to return the next response page.", "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 } }, "type": [ "object", "null" ] } }, "type": "object" }, "ListShipmentBoxesInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to list shipment boxes" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ListPackingOptionsResponse": { "required": [ "packingOptions" ], "properties": { "packingOptions": { "description": "List of packing options.", "type": "array", "items": { "$ref": "#/components/schemas/PackingOption" } }, "pagination": { "properties": { "nextToken": { "description": "When present, pass this string token in the next request to return the next response page.", "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 } }, "type": [ "object", "null" ] } }, "type": "object" }, "PackingOption": { "required": [ "discounts", "fees", "packingGroups", "packingOptionId", "status", "supportedConfigurations", "supportedShippingConfigurations" ], "properties": { "discounts": { "description": "Discount for the offered option.", "type": "array", "items": { "$ref": "#/components/schemas/Incentive" } }, "expiration": { "description": "The time at which this packing option is no longer valid.", "type": [ "string", "null" ], "format": "date-time", "example": "2025-12-31T23:59:59.999Z" }, "fees": { "description": "Fee for the offered option.", "type": "array", "items": { "$ref": "#/components/schemas/Incentive" } }, "packingGroups": { "description": "Packing group IDs.", "type": "array", "items": { "type": "string" }, "example": [ "pg07ea0f63-4f42-4bb4-b122-b9ea8fbf0319" ] }, "packingOptionId": { "description": "Identifier of a packing option.", "type": "string", "example": "pof3a5b9e4-6aa4-45f8-bf96-6603da02e3a0" }, "status": { "description": "The status of the packing option.", "type": "string", "enum": [ "OFFERED", "ACCEPTED", "EXPIRED" ], "example": "OFFERED" }, "supportedConfigurations": { "description": "A list of possible configurations for this option.", "type": "array", "items": { "$ref": "#/components/schemas/PackingConfiguration" } }, "supportedShippingConfigurations": { "description": "List of supported shipping modes.", "type": "array", "items": { "$ref": "#/components/schemas/ShippingConfiguration" } } }, "type": "object" }, "PackingConfiguration": { "properties": { "boxPackingMethods": { "description": "The box content information sources that are allowed.", "type": [ "array", "null" ], "items": { "type": "string", "example": "BOX_CONTENT_PROVIDED" } }, "boxRequirements": { "oneOf": [ { "$ref": "#/components/schemas/BoxRequirements", "description": "The requirements for a box in the packing option." }, { "type": "null" } ], "description": "The requirements for a box in the packing option." }, "shippingRequirements": { "description": "A list of supported shipping requirements for this packing configuration.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ShippingRequirements" } } }, "type": "object" }, "BoxRequirements": { "required": [ "weight" ], "properties": { "weight": { "$ref": "#/components/schemas/WeightRange", "description": "The range of weights that are allowed for a package." } }, "type": "object" }, "WeightRange": { "required": [ "maximum", "minimum", "unit" ], "properties": { "maximum": { "description": "Maximum allowed weight.", "type": "number", "format": "float", "example": 50 }, "minimum": { "description": "Minimum allowed weight.", "type": "number", "format": "float", "example": 0.1 }, "unit": { "description": "Unit of the weight being measured.", "type": "string", "example": "pounds" } }, "type": "object" }, "ShippingRequirements": { "required": [ "modes", "solution" ], "properties": { "modes": { "description": "Available shipment modes for this shipping program.", "type": "array", "items": { "type": "string" }, "example": [ "GROUND_SMALL_PARCEL" ] }, "solution": { "description": "Shipping program for the option.", "type": "string", "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ], "example": "AMAZON_PARTNERED_CARRIER" } }, "type": "object" }, "ShippingConfiguration": { "properties": { "shippingMode": { "description": "Mode of shipment transportation that this option will provide.", "type": [ "string", "null" ], "enum": [ "GROUND_SMALL_PARCEL", "FREIGHT_LTL", "FREIGHT_FTL_PALLET", "FREIGHT_FTL_NONPALLET", "OCEAN_LCL", "OCEAN_FCL", "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS" ], "example": "GROUND_SMALL_PARCEL" }, "shippingSolution": { "description": "Shipping program for the option.", "type": [ "string", "null" ], "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ], "example": "AMAZON_PARTNERED_CARRIER" } }, "type": "object" }, "ListPackingOptionsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to list packing options" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ListPackingGroupBoxesResponse": { "required": [ "boxes" ], "properties": { "boxes": { "description": "Provides the information about the list of boxes in the packing group.", "type": "array", "items": { "$ref": "#/components/schemas/Box" } }, "pagination": { "properties": { "nextToken": { "description": "When present, pass this string token in the next request to return the next response page.", "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 } }, "type": [ "object", "null" ] } }, "type": "object" }, "ListPackingGroupBoxesInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to list packing group boxes" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ListPackingGroupItemsResponse": { "required": [ "items" ], "properties": { "items": { "description": "Provides the information about the list of items in the packing group.", "type": "array", "items": { "$ref": "#/components/schemas/ShipmentItem" } }, "pagination": { "properties": { "nextToken": { "description": "When present, pass this string token in the next request to return the next response page.", "type": [ "string", "null" ], "maxLength": 1024, "minLength": 1 } }, "type": [ "object", "null" ] } }, "type": "object" }, "ListPackingGroupItemsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to list packing group items" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "SearchListingsItemsResponse": { "description": "The response object for searching listings items.", "properties": { "numberOfResults": { "description": "The total number of selling partner listings items found for the search criteria (only results up to the page count limit is returned per request regardless of the number found). Note: The maximum number of items (SKUs) that can be returned and paged through is 1000.", "type": "integer", "example": 3 }, "pagination": { "oneOf": [ { "$ref": "#/components/schemas/Pagination", "description": "Pagination token for next and previous pages of results." }, { "type": "null" } ], "description": "Pagination token for next and previous pages of results." }, "items": { "description": "A list of listings items.", "type": "array", "items": { "$ref": "#/components/schemas/ListingsItem" } } }, "type": "object" }, "Pagination": { "description": "Pagination tokens for multi-page responses.", "properties": { "nextToken": { "description": "A token that can be used to fetch the next page.", "type": [ "string", "null" ], "example": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234" }, "previousToken": { "description": "A token that can be used to fetch the previous page.", "type": [ "string", "null" ], "example": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d" } }, "type": "object" }, "CurrencyAmount": { "description": "The currency type and amount.", "properties": { "currencyCode": { "description": "Three-digit currency code in ISO 4217 format.", "type": "string", "maxLength": 3, "minLength": 3, "example": "USD" }, "amount": { "description": "A decimal number with no loss of precision. Follows RFC7159 for number representation.", "type": "string", "example": "100.00" } }, "type": "object" }, "Points": { "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).", "properties": { "pointsNumber": { "description": "The number of points awarded.", "type": "integer", "example": 10 } }, "type": "object" }, "Image": { "description": "The image details for the listings item.", "properties": { "link": { "description": "URL to the image.", "type": "string", "format": "url", "example": "https://www.example.com/luggage.png" }, "height": { "description": "Image height in pixels.", "type": [ "integer", "null" ], "example": 500 }, "width": { "description": "Image width in pixels.", "type": [ "integer", "null" ], "example": 500 } }, "type": "object" }, "VariationTheme": { "description": "A variation theme that indicates the combination of listing item attributes that define the variation family.", "properties": { "attributes": { "description": "The names of the listing item attributes that are associated with the variation theme.", "type": "array", "items": { "type": "string" }, "example": [ "Color", "Size" ] }, "theme": { "description": "The variation theme.", "type": "string", "example": "SizeColor" } }, "type": "object" }, "ListingsItemSummary": { "description": "Summary details of a listings item.", "properties": { "marketplaceId": { "description": "A marketplace identifier. Identifies the Amazon marketplace for the listings item.", "type": "string", "example": "ATVPDKIKX0DER" }, "asin": { "description": "Amazon Standard Identification Number (ASIN) of the listings item.", "type": [ "string", "null" ], "example": "B00U26V4VQ" }, "productType": { "description": "The Amazon product type of the listings item.", "type": "string", "example": "BOARD_GAME" }, "conditionType": { "description": "Identifies the condition of the listings item. Allowed values: 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.", "type": [ "string", "null" ], "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" ], "example": "new_new" }, "status": { "description": "Statuses that apply to the listings item. (e.g., BUYABLE: The listings item can be purchased by shoppers. DISCOVERABLE: The listings item is visible to shoppers.)", "type": "array", "items": { "type": "string", "enum": [ "BUYABLE", "DISCOVERABLE" ] }, "example": [ "BUYABLE" ] }, "fnSku": { "description": "The fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item.", "type": [ "string", "null" ], "example": "X000P8X3J2" }, "itemName": { "description": "The name or title associated with an Amazon catalog item.", "type": "string", "example": "Hardside Carry-On Spinner Suitcase Luggage" }, "createdDate": { "description": "The date the listings item was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2021-02-01T00:00:00Z" }, "lastUpdatedDate": { "description": "The date the listings item was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2021-03-01T00:00:00Z" }, "mainImage": { "oneOf": [ { "$ref": "#/components/schemas/Image", "description": "The main image for the listings item." }, { "type": "null" } ], "description": "The main image for the listings item." } }, "type": "object" }, "ListingsItemIssue": { "description": "An issue encountered during the listings item submission.", "properties": { "code": { "description": "An issue code that identifies the type of issue.", "type": "string", "example": "90220" }, "message": { "description": "A message that describes the issue.", "type": "string", "example": "'size' is required but not supplied." }, "severity": { "description": "The severity of the issue. ERROR: Indicates an issue has occurred preventing the submission from processing. WARNING: Indicates an issue has occurred that should be reviewed, but has not prevented the submission from processing. INFO: Indicates additional information has been provided that should be reviewed.", "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "example": "ERROR" }, "attributeNames": { "description": "The names of the attributes associated with the issue, if applicable.", "type": [ "array", "null" ], "items": { "type": "string" }, "example": [ "size" ] }, "categories": { "description": "List of issue categories. Possible values: 'INVALID_ATTRIBUTE' - Invalid attribute; 'MISSING_ATTRIBUTE' - Missing attribute; 'INVALID_IMAGE' - Invalid image; 'MISSING_IMAGE' - Missing image; 'INVALID_PRICE' - Issues with price-related attributes; 'MISSING_PRICE' - Absence of a price attribute; 'DUPLICATE' - Potential duplicate listing (e.g., ASIN duplicate); 'QUALIFICATION_REQUIRED' - Listing requires qualification-related approval.", "type": "array", "items": { "type": "string", "enum": [ "INVALID_ATTRIBUTE", "MISSING_ATTRIBUTE", "INVALID_IMAGE", "MISSING_IMAGE", "INVALID_PRICE", "MISSING_PRICE", "DUPLICATE", "QUALIFICATION_REQUIRED" ] } }, "enforcements": { "oneOf": [ { "$ref": "#/components/schemas/Enforcements", "description": "This field provides information about the enforcement actions taken by Amazon that affect the publishing or status of a listing. It also includes details about any associated exemptions." }, { "type": "null" } ], "description": "This field provides information about the enforcement actions taken by Amazon that affect the publishing or status of a listing. It also includes details about any associated exemptions." }, "identifiers": { "description": "Identity attributes associated with the item in the Amazon catalog, such as the ASIN.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ListingsItemIdentifier" } } }, "type": "object" }, "Enforcements": { "description": "Enforcement actions and exemption status.", "properties": { "actions": { "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing.", "type": "array", "items": { "$ref": "#/components/schemas/EnforcementAction" } }, "exemption": { "$ref": "#/components/schemas/Exemption", "description": "Conveying the status of the listed enforcement actions and, if applicable, provides information about the exemption's expiry date." } }, "type": "object" }, "EnforcementAction": { "description": "Details of a single enforcement action.", "properties": { "action": { "description": "The enforcement action name. **LISTING_SUPPRESSED**: Takes down the current listing item's buyability. **ATTRIBUTE_SUPPRESSED**: An attribute's value on the listing item is invalid, causing it to be rejected by Amazon. **CATALOG_ITEM_REMOVED**: This catalog item is inactive on Amazon, and all offers against it are non-buyable. **SEARCH_SUPPRESSED**: The catalog item is hidden from search results.", "type": "string", "enum": [ "LISTING_SUPPRESSED", "ATTRIBUTE_SUPPRESSED", "CATALOG_ITEM_REMOVED", "SEARCH_SUPPRESSED" ] } }, "type": "object" }, "Exemption": { "description": "Exemption details for enforcement actions.", "properties": { "status": { "description": "This field indicates the current exemption status for the listed enforcement actions. **EXEMPT**: Permanent exemption. Amazon acknowledges the enforcement actions but assures they are not applied to the listing. **EXEMPT_UNTIL_EXPIRY_DATE**: Temporary exemption until a specified expiry date, after which Amazon will enforce the listed actions. **NOT_EXEMPT**: No exemptions are in place; Amazon has already taken the specified enforcement actions, and they are actively enforced.", "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ] }, "expiryDate": { "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires.", "type": "string", "format": "date-time" } }, "type": "object" }, "ListingsItemIdentifier": { "description": "Identity attributes for the item in the Amazon catalog.", "properties": { "marketplaceId": { "description": "A marketplace identifier. Identifies the Amazon marketplace for the listings item.", "type": "string", "example": "ATVPDKIKX0DER" }, "asin": { "description": "Amazon Standard Identification Number (ASIN) of the listings item.", "type": "string", "example": "B00U26V4VQ" } }, "type": "object" }, "ListingOfferPrice": { "description": "The price for a specific offer type.", "properties": { "marketplaceId": { "description": "The Amazon marketplace identifier.", "type": "string", "example": "ATVPDKIKX0DER" }, "offerType": { "description": "Type of offer for the listings item. (B2C: Business to Consumer, B2B: Business to Business)", "type": "string", "enum": [ "B2C", "B2B" ], "example": "B2C" }, "price": { "$ref": "#/components/schemas/CurrencyAmount", "description": "The currency type and amount of the offer price." }, "points": { "oneOf": [ { "$ref": "#/components/schemas/Points", "description": "The number of Amazon Points offered with the purchase of an item." }, { "type": "null" } ], "description": "The number of Amazon Points offered with the purchase of an item." }, "audience": { "oneOf": [ { "$ref": "#/components/schemas/OfferAudience", "description": "Buyer segment or program this offer is applicable to." }, { "type": "null" } ], "description": "Buyer segment or program this offer is applicable to." } }, "type": "object" }, "OfferAudience": { "description": "Buyer segment or program this offer is applicable to.", "properties": { "value": { "description": "Name of the audience an offer is applicable to. (ALL, B2B)", "type": "string", "enum": [ "ALL", "B2B" ], "example": "ALL" }, "displayName": { "description": "Localized display name for the audience.", "type": "string", "example": "Standard Buyers" } }, "type": "object" }, "FulfillmentAvailability": { "description": "The fulfillment availability for the listings item.", "properties": { "fulfillmentChannelCode": { "description": "Designates which fulfillment network is used.", "type": "string", "example": "DEFAULT" }, "quantity": { "description": "The quantity of the item available for sale.", "type": "integer", "minimum": 0, "example": 1 } }, "type": "object" }, "Procurement": { "description": "The vendor procurement information for the listings item.", "properties": { "costPrice": { "$ref": "#/components/schemas/CurrencyAmount", "description": "The currency type and amount of the cost price." } }, "type": "object" }, "ProductRelationship": { "description": "Relationships for the listing item (e.g., variation, package hierarchy).", "properties": { "childSkus": { "description": "Identifiers (SKUs) of the related items that are children of this listing item.", "type": [ "array", "null" ], "items": { "type": "string" }, "example": [ "CHILD-SKU-1", "CHILD-SKU-2" ] }, "parentSkus": { "description": "Identifiers (SKUs) of the related items that are parents of this listing item.", "type": [ "array", "null" ], "items": { "type": "string" }, "example": [ "PARENT-SKU-A" ] }, "variationTheme": { "oneOf": [ { "$ref": "#/components/schemas/VariationTheme", "description": "Details about the variation theme." }, { "type": "null" } ], "description": "Details about the variation theme." }, "type": { "description": "The type of relationship. (VARIATION, PACKAGE_HIERARCHY)", "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "example": "VARIATION" } }, "type": "object" }, "MarketplaceRelationship": { "description": "Relationships for a listing item, by marketplace.", "properties": { "marketplaceId": { "description": "Amazon marketplace identifier.", "type": "string", "example": "ATVPDKIKX0DER" }, "relationships": { "description": "Relationships for the listing item.", "type": "array", "items": { "$ref": "#/components/schemas/ProductRelationship" } } }, "type": "object" }, "ProductTypeDefinition": { "description": "Product types for a listing item, by marketplace.", "properties": { "marketplaceId": { "description": "Amazon marketplace identifier.", "type": "string", "example": "ATVPDKIKX0DER" }, "productType": { "description": "The name of the product type that is submitted by the Selling Partner.", "type": "string", "example": "BOARD_GAME" } }, "type": "object" }, "ListingsItem": { "description": "A single selling partner listings item.", "properties": { "sku": { "description": "A selling partner provided identifier for an Amazon listing.", "type": "string", "example": "Test Catan 07-11-2025 B00U26V4VQ" }, "summaries": { "description": "Summary details of a listings item.", "type": "array", "items": { "$ref": "#/components/schemas/ListingsItemSummary" } }, "attributes": { "description": "A JSON object containing structured listings item attribute data keyed by attribute name. This structure is highly product-type-dependent.", "type": [ "object", "null" ], "example": { "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’s 4K QLED TV offers over a billion shades of brilliant color and 100% color volume for exceptional depth of detail that can 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écor, 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" } ], "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" } ] } }, "issues": { "description": "The issues associated with the listings item.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ListingsItemIssue" } }, "offers": { "description": "Offer details for the listings item.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ListingOfferPrice" } }, "fulfillmentAvailability": { "description": "The fulfillment availability for the listings item.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/FulfillmentAvailability" } }, "procurement": { "description": "The vendor procurement information for the listings item.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/Procurement" } }, "relationships": { "description": "Relationships for a listing item, by marketplace (for example, variations).", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/MarketplaceRelationship" } }, "productTypes": { "description": "Product types for a listing item, by marketplace.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ProductTypeDefinition" } } }, "type": "object" }, "SearchListingsItemsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to search listings items" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "GetListingsItemInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get listings item" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ListingsItemPutRequest": { "required": [ "productType", "attributes" ], "properties": { "productType": { "description": "The Amazon product type of the listings item.", "type": "string", "example": "TREE_TOPPER" }, "attributes": { "description": "A JSON object containing structured listings item attribute data keyed by attribute name.", "type": "object", "example": { "merchant_suggested_asin": [ { "value": "B00U26V4VQ", "marketplace_id": "ATVPDKIKX0DER" } ], "condition_type": [ { "value": "new_new", "marketplace_id": "ATVPDKIKX0DER" } ], "fulfillment_availability": [ { "fulfillment_channel_code": "AMAZON_NA" } ], "purchasable_offer": [ { "currency": "USD", "audience": "ALL", "our_price": [ { "schedule": [ { "value_with_tax": 40.33 } ] } ], "marketplace_id": "ATVPDKIKX0DER" } ], "batteries_required": [ { "value": false, "marketplace_id": "ATVPDKIKX0DER" } ], "supplier_declared_dg_hz_regulation": [ { "value": "not_applicable", "marketplace_id": "ATVPDKIKX0DER" } ], "max_order_quantity": [ { "value": 3, "marketplace_id": "ATVPDKIKX0DER" } ] } }, "requirements": { "description": "The name of the requirements set for the provided data.\nLISTING\tIndicates the submitted data contains product facts and sales terms.\nLISTING_PRODUCT_ONLY\tIndicates the submitted data contains product facts only.\nLISTING_OFFER_ONLY\tIndicates the submitted data contains sales terms only. Not supported for vendors (vendors will receive an HTTP status code 400 response).\nAllowed: `LISTING`, `LISTING_PRODUCT_ONLY`, `LISTING_OFFER_ONLY`", "type": [ "string", "null" ], "example": "LISTING_OFFER_ONLY" } }, "type": "object" }, "ListingsItemSubmissionResponse": { "properties": { "sku": { "description": "A selling partner provided identifier for an Amazon listing.", "type": "string", "example": "Test Catan 07-11-2025 B00U26V4VQ" }, "status": { "description": "The status of the listings item submission. ACCEPTED: The listings submission was accepted for processing. INVALID: The listings submission was not valid and was not accepted for processing. VALID: The listings submission was valid. Only returned when the mode is VALIDATION_PREVIEW.", "type": "string", "enum": [ "ACCEPTED", "INVALID", "VALID" ], "example": "INVALID" }, "submissionId": { "description": "The unique identifier of the listings item submission", "type": "string", "example": "f1dc2914-75dd-11ea-bc55-0242ac130003" }, "issues": { "description": "Listings item issues related to the listings item submission.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ListingsItemIssue" } } }, "type": "object" }, "ListingsItemPatchRequest": { "required": [ "productType", "patches" ], "properties": { "productType": { "description": "The Amazon product type of the listings item.", "type": "string", "example": "TREE_TOPPER" }, "patches": { "description": "The patches to apply to the listings item", "type": "array", "items": { "required": [ "op", "path", "value" ], "properties": { "op": { "description": "Type of JSON Patch operation. Supported JSON Patch operations include add, replace, merge and delete. Refer to https://tools.ietf.org/html/rfc6902.\nThe `add` operation adds or replaces the target property.\nThe `replace` operation adds or replaces the target property.\nThe `merge` operation merges the target property.\nThe `delete` operation removes the target property. Not supported for vendors (vendors will receive an HTTP status code 400 response).", "type": "string", "enum": [ "add", "replace", "merge", "delete" ], "example": "replace" }, "path": { "description": "JSON Pointer path of the element to patch. Refer to JavaScript Object Notation Patch (https://datatracker.ietf.org/doc/html/rfc6902) for more information.", "type": "string", "example": "/attributes/purchasable_offer" }, "value": { "description": "JSON value to add, replace, merge or delete at the target path.", "type": "array", "items": { "type": "object" }, "example": [ { "currency": "USD", "audience": "ALL", "our_price": [ { "schedule": [ { "value_with_tax": 50.45 } ] } ], "marketplace_id": "ATVPDKIKX0DER" } ] } }, "type": "object" } } }, "type": "object" }, "PatchListingsItemInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to patch listings item" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "DeleteListingsItemInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to delete listings item" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ProductType": { "description": "A product type for the Amazon marketplace.", "properties": { "name": { "description": "The name of the Amazon product type.", "type": "string", "example": "LUGGAGE" }, "displayName": { "description": "Human-readable and localized description of the Amazon product type.", "type": "string", "example": "Luggage" } }, "type": "object" }, "ProductTypeListResponse": { "description": "The response object for searching product types.", "properties": { "productTypes": { "description": "A list of product types.", "type": "array", "items": { "$ref": "#/components/schemas/ProductType" } }, "productTypeVersion": { "description": "Amazon product type version identifier.", "type": "string", "example": "LATEST" } }, "type": "object" }, "SearchProductTypeDefinitionsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to search product type definitions" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" }, "ProductTypeDefinitionResponse": { "description": "The complete product type definition including schema, requirements, and property groups.", "properties": { "schema": { "$ref": "#/components/schemas/SchemaLink", "description": "Link to retrieve the schema." }, "requirements": { "description": "Name of the requirements set represented in this product type definition.", "type": "string", "example": "LISTING" }, "requirementsEnforced": { "description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all of the required attributes being present (such as for partial updates).", "type": "string", "example": "ALL" }, "propertyGroups": { "description": "Mapping of property group names to property groups.", "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroup" } }, "locale": { "description": "Locale of the display elements contained in the product type definition.", "type": "string", "example": "en_US" }, "marketplaceIds": { "description": "Amazon marketplace identifiers for which the product type definition is applicable.", "type": "array", "items": { "type": "string" }, "example": [ "ATVPDKIKX0DER" ] }, "productType": { "description": "The name of the Amazon product type that this product type definition applies to.", "type": "string", "example": "LUGGAGE" }, "displayName": { "description": "Human-readable and localized description of the Amazon product type.", "type": "string", "example": "Luggage" }, "productTypeVersion": { "$ref": "#/components/schemas/ProductTypeVersion", "description": "The version details for an Amazon product type." }, "metaSchema": { "oneOf": [ { "$ref": "#/components/schemas/SchemaLink", "description": "Link to retrieve the meta schema." }, { "type": "null" } ], "description": "Link to retrieve the meta schema." } }, "type": "object" }, "ProductTypeVersion": { "description": "The version details for an Amazon product type.", "properties": { "version": { "description": "Version identifier.", "type": "string", "example": "2.0" }, "latest": { "description": "When true, the version indicated by the version identifier is the latest available for the Amazon product type.", "type": "boolean", "example": true }, "releaseCandidate": { "description": "When true, the version indicated by the version identifier is the prerelease (release candidate) for the Amazon product type.", "type": [ "boolean", "null" ], "example": false } }, "type": "object" }, "Link": { "description": "URI resource and HTTP method for a link.", "properties": { "resource": { "description": "URI resource for the link.", "type": "string", "example": "/definitions/2020-09-01/productTypes/LUGGAGE" }, "verb": { "description": "HTTP method for the link operation.", "type": "string", "example": "GET" } }, "type": "object" }, "SchemaLink": { "description": "Link to retrieve the schema and its checksum.", "properties": { "link": { "$ref": "#/components/schemas/Link", "description": "Link to retrieve the schema." }, "checksum": { "description": "Checksum hash of the schema (Base64 MD5).", "type": "string", "example": "p+5e2+8/xK27tD+z3+e+Vw==" } }, "type": "object" }, "PropertyGroup": { "description": "A logical grouping of schema properties.", "properties": { "title": { "description": "The display label of the property group.", "type": [ "string", "null" ], "example": "Key Product Features" }, "description": { "description": "The description of the property group.", "type": [ "string", "null" ], "example": "Important attributes to consider when listing this product type." }, "propertyNames": { "description": "The names of the schema properties for the property group.", "type": [ "array", "null" ], "items": { "type": "string" }, "example": [ "bullet_point", "item_name" ] } }, "type": "object" }, "ProductTypeDefinitionsInternalApiError": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown_error" }, "message": { "description": "Error message", "type": "string", "example": "Failed to get product type definition" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" } }, "responses": { "BadRequest": { "description": "Bad request - validation failed or invalid parameters", "content": { "application/json": { "schema": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "validation_error" }, "message": { "description": "Error message", "type": "string", "example": "The selected domain is invalid." }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" } } } }, "PaymentRequired": { "description": "Payment Required - subscription expired or payment method required", "content": { "application/json": { "schema": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "subscription_required" }, "message": { "description": "Error message", "type": "string", "example": "Subscription Required" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" } } } }, "AccessDenied": { "description": "Access denied - insufficient permissions or invalid API key", "content": { "application/json": { "schema": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "access_denied" }, "message": { "description": "Error message", "type": "string", "example": "API Token is invalid" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" } } } }, "NotFound": { "description": "Resource not found", "content": { "application/json": { "schema": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "not_found" }, "message": { "description": "Error message", "type": "string", "example": "Resource not found" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" } } } }, "BusinessLogicError": { "description": "Business logic error - operation cannot be completed due to business rules", "content": { "application/json": { "schema": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "business_logic_error" }, "message": { "description": "Error message", "type": "string", "example": "e.g. Amazon seller account connection required" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" } } } }, "TooManyRequests": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "too_many_requests" }, "message": { "description": "Error message", "type": "string", "example": "Too Many Requests" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" } } } }, "InternalError": { "description": "Internal server error", "content": { "application/json": { "schema": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown" }, "message": { "description": "Error message", "type": "string", "example": "An unknown error occurred" }, "traceId": { "description": "Id of error to easily find if needed", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" } } } } }, "securitySchemes": { "api_key": { "type": "apiKey", "description": "To authenticate with the Seller Assistant Public API, you can generate an API key in your Seller Assistant account under the [API Keys](https://app.sellerassistant.app/settings/api-keys) section. This API key should be included in your requests as a query parameter `api_key` or as a header `X-Api-Key`.", "name": "api_key", "in": "query" }, "header_api_key": { "type": "apiKey", "description": "Pass API Key to header", "name": "X-Api-Key", "in": "header" } } }, "tags": [ { "name": "UPC-EAN-ASIN converters", "description": "UPC-EAN-ASIN converters" }, { "name": "FBA Inbound Shipments", "description": "FBA Inbound Shipments" }, { "name": "Keepa", "description": "Keepa" }, { "name": "Listings Items", "description": "Listings Items" }, { "name": "Products", "description": "Products" }, { "name": "Restrictions", "description": "Restrictions" }, { "name": "SA Products History", "description": "SA Products History" }, { "name": "SA Products", "description": "SA Products" }, { "name": "SA Suppliers", "description": "SA Suppliers" }, { "name": "User Info", "description": "User Info" }, { "name": "Sales Estimation", "description": "Sales Estimation" }, { "name": "SP-API Catalog Items", "description": "SP-API Catalog Items" }, { "name": "SP-API FBA Inventory", "description": "SP-API FBA Inventory" }, { "name": "SP-API FBA Shipments", "description": "SP-API FBA Shipments" }, { "name": "SP-API Listings Items", "description": "SP-API Listings Items" }, { "name": "SP-API Product Type Definitions", "description": "SP-API Product Type Definitions" } ] }