{ "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. A section that starts its description with Beta can change without notice, and a change there does not keep the old shape. A trial can use the API with 500 requests for the whole trial. On trial a list shows only its first 25 rows, and `meta.trial_limit` gives the true total and the subscribe link.", "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": "seller_account_id", "in": "query", "description": "Active seller account of this team in the marketplace region. Required when multiple sellers are connected.", "required": false, "schema": { "type": "string" } }, { "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": [] } ] } }, "/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": "seller_account_id", "in": "query", "description": "Active seller account of this team in the marketplace region. Required when multiple sellers are connected.", "required": false, "schema": { "type": "string" } }, { "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": [] } ] } }, "/api/v1/documents": { "get": { "tags": [ "Documents (Beta)" ], "summary": "List documents", "description": "Lists the documents of the team. Give `target_type` and `target_id` to get the documents of one purchase order or one supplier.", "operationId": "listDocuments", "parameters": [ { "name": "target_type", "in": "query", "description": "Keeps the documents of one kind of owner. Send `target_id` with it to keep the documents of one owner.", "required": false, "schema": { "type": "string", "enum": [ "purchase_order", "supplier" ] } }, { "name": "target_id", "in": "query", "description": "The id of the purchase order or of the supplier. It needs `target_type`.", "required": false, "schema": { "type": "integer", "example": 42 } }, { "name": "filter[type][eq]", "in": "query", "description": "Keeps the documents of one type.", "required": false, "schema": { "type": "string", "enum": [ "invoice", "confirmation", "credit_memo", "packing_slip", "contract", "authorization_letter", "credit_agreement", "other" ] } }, { "name": "filter[status][eq]", "in": "query", "description": "Keeps the documents of one parser status.", "required": false, "schema": { "type": "string", "enum": [ "uploaded", "classifying", "processing", "parsed", "empty", "failed" ] } }, { "$ref": "#/components/parameters/ApiV1Search" }, { "name": "sort", "in": "query", "description": "The column to order by: created_at, updated_at, original_name, file_size, type, status. A minus sign in front of the name orders from the highest down. Without a sort the order is `-created_at`. Another name answers 400.", "required": false, "schema": { "type": "string", "example": "-created_at" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the documents", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "post": { "tags": [ "Documents (Beta)" ], "summary": "Upload a document", "description": "The upload is idempotent. The same file on the same owner answers 200 with the document that is already there, and a new file answers 201. The file hash decides.", "operationId": "uploadDocument", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "file", "target_type", "target_id" ], "properties": { "file": { "description": "At most 25 MB. pdf, jpg, jpeg, png, webp, doc, docx, xls, xlsx, csv, txt.", "type": "string", "format": "binary" }, "target_type": { "type": "string", "enum": [ "purchase_order", "supplier" ] }, "target_id": { "type": "integer", "example": 42 }, "type": { "description": "The type a caller forces. Without it the classifier reads the file.", "type": "string", "enum": [ "invoice", "confirmation", "credit_memo", "packing_slip", "contract", "authorization_letter", "credit_agreement", "other" ] } }, "type": "object" } } } }, "responses": { "201": { "description": "The document is new", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Document" } }, "type": "object" } } } }, "200": { "description": "The owner already has this file. The answer is that document.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Document" } }, "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": [] } ] }, "delete": { "tags": [ "Documents (Beta)" ], "summary": "Delete documents", "description": "The call names the rows with `ids`. The answer keeps the order of the input, so the caller can match an error to the id it sent. The path with an id removes one row and answers 204.", "operationId": "deleteDocuments", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "integer", "example": 7 }, "maxItems": 100 } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/documents/{id}": { "get": { "tags": [ "Documents (Beta)" ], "summary": "Get a document", "description": "Gives one document of the team. `has_parsed_data` tells if the parser read lines from the file. `GET /api/v1/documents/{id}/import-preview` gives the lines.", "operationId": "getDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 5 } } ], "responses": { "200": { "description": "The document", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Document" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Documents (Beta)" ], "summary": "Delete a document", "description": "The file leaves the storage too.", "operationId": "deleteDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 5 } } ], "responses": { "204": { "description": "The document is gone" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "patch": { "tags": [ "Documents (Beta)" ], "summary": "Update a document", "description": "Changes the type of a document, or turns its import offer off or on. A document that becomes an invoice of a purchase order goes to the parser again. `dismissed: false` shows the import offer again.", "operationId": "updateDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 5 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "type": { "type": "string", "enum": [ "invoice", "confirmation", "credit_memo", "packing_slip", "contract", "authorization_letter", "credit_agreement", "other" ] }, "dismissed": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The document", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Document" } }, "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": [] } ] } }, "/api/v1/documents/{id}/download-url": { "get": { "tags": [ "Documents (Beta)" ], "summary": "Get a download link", "description": "The link expires in 30 minutes. The file itself never goes through this API.", "operationId": "getDocumentDownloadUrl", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 5 } } ], "responses": { "200": { "description": "The link", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "url": { "type": "string", "example": "https://files.example.com/documents/4/po_42/invoice.pdf?signature=..." }, "expires_in": { "description": "In seconds.", "type": "integer", "example": 1800 } }, "type": "object" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/documents/{id}/import-preview": { "get": { "tags": [ "Documents (Beta)" ], "summary": "Preview an invoice import", "description": "A document the parser is still reading answers its status and no items. A document the parser failed on answers 422 with the reason, and 503 when the fault is ours. The plan must carry the feature `invoice_parsing`.\n\n The answer holds `resolved` and `unresolved` (what the parser read), `invoice_meta` (what the invoice itself says) and `diff` (how the invoice compares with the order). `diff` reads for a person: the import writes the lines of the body and removes nothing. Every list of the diff stops at 100 lines, and `diff.diff_summary` keeps the real counts.\n\n `po_level_changes` compares the order with the lines the parser matched, so its `subtotal` counts `resolved` alone, rounded to 2 decimals. When a line of `resolved` has no price, the subtotal of the invoice is unknown: its `inv_value` is null and it is not a change. The total of the invoice is `invoice_meta.subtotal`. An `inv_value` of null means that the invoice does not show that cost. It is not a change, and the order keeps its cost.\n\n A line of `changed` or `unchanged` compares on the price basis of the order item. Its `changes` hold the values that the import writes: the price of one case for an item priced per case, and the quantity in units. `item_unit_cost` and `item_unit_count` give the same values for a line with no change. `basis` tells if the line price is per `unit` or per `case`. `basis_unknown` is true when SA is not sure of the basis: neither the price nor the quantity tells it, the price is 10% to 25% off the item price, or the quantity tells the other basis. `basis` is the basis that the import writes. With no basis found, it is `unit`. A line with no price on the invoice has `unit_price` and `item_unit_cost` null. It is never a price change, so only its quantity can change. A price of 0 on the invoice is a price.\n\n Until the document is applied, the diff compares the invoice with the order as it is now.", "operationId": "previewDocumentImport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 5 } } ], "responses": { "200": { "description": "What the parser read", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "status": { "type": "string", "example": "parsed", "enum": [ "uploaded", "classifying", "processing", "parsed", "empty", "failed" ] }, "document_id": { "type": "integer", "example": 5 }, "items": { "type": "array", "items": { "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/documents/{id}/import": { "post": { "tags": [ "Documents (Beta)" ], "summary": "Import an invoice", "description": "The caller sends the lines it confirmed, not the lines the parser read. A line with no ASIN does not go in. Every item of the order goes back through the profit calculation, because the order level costs are spread over all of them. The plan must carry the feature `invoice_parsing`.\n\n A line for a product that the order already holds updates that item on its price basis. The quantity of the item becomes the quantity of the line. When the item is priced per case and the line price is a unit price, the import writes the unit price times the case quantity, and the item stays priced per case.\n\n One document goes into the order once. A line for a product that the order does not hold becomes a new item, so a second call would add it twice. A document that carries `applied_at` answers 409, and a retry cannot make it work.", "operationId": "importDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 5 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "required": [ "quantity", "unit_price" ], "properties": { "asin": { "type": [ "string", "null" ], "example": "B08N5WRWNW" }, "title": { "type": [ "string", "null" ] }, "sku": { "type": [ "string", "null" ] }, "upc": { "type": [ "string", "null" ] }, "ean": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "quantity": { "type": "integer", "example": 12 }, "unit_price": { "description": "The price of the line. Send null when the invoice shows no price: the item keeps its cost, and a new item gets no cost. A 0 is a price.", "type": [ "number", "null" ], "example": 9.5 } }, "type": "object" } }, "order_costs": { "properties": { "taxes": { "type": "number" }, "shipping_cost": { "type": "number" }, "misc_expenses": { "type": "number" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "What the import wrote", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "purchase_order_id": { "type": "integer", "example": 42 }, "imported_count": { "type": "integer", "example": 12 }, "costs_applied": { "type": "boolean", "example": true }, "applied_at": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/api/v1/ip-alerts/products/{asin}": { "get": { "tags": [ "IP-Alert (Beta)" ], "summary": "Get IP-Alert warnings of a product", "description": "The IP-Alert warnings of the ASIN and of its brand, as the High-Risk Product note of the extension shows them. The fields are the fields of the Help Center article [IP-Alert warning types](https://help.sellerassistant.app/en/articles/18320816-ip-alert-warning-types-in-seller-assistant). A clean ASIN gives empty lists, not an error. Without `brand`, Seller Assistant finds the brand of the ASIN. The call counts as one request of the API request limit. It does not use the IP-Alert checks of the extension.", "operationId": "getProductIpAlerts", "parameters": [ { "name": "asin", "in": "path", "description": "Amazon product ASIN.", "required": true, "schema": { "type": "string", "example": "B00U26V4VQ" } }, { "name": "marketplace_id", "in": "query", "description": "Amazon marketplace id. The default is `ATVPDKIKX0DER` (amazon.com). The names `marketplaceId` and `domain` of the older product calls give 400. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "schema": { "type": "string", "example": "ATVPDKIKX0DER" } }, { "name": "brand", "in": "query", "description": "The brand of the ASIN. Send it when you know it: the call then does not look up the brand.", "required": false, "schema": { "type": "string", "example": "CATAN", "maxLength": 255 } } ], "responses": { "200": { "description": "The IP-Alert warnings", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IpAlertReport" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/ip-alerts/brands": { "get": { "tags": [ "IP-Alert (Beta)" ], "summary": "Get IP-Alert warnings of a brand", "description": "The IP-Alert warnings of the brand on all of its ASINs. The fields are the fields of the Help Center article [IP-Alert warning types](https://help.sellerassistant.app/en/articles/18320816-ip-alert-warning-types-in-seller-assistant). A brand without warnings gives empty lists, not an error. The answer has the shape of the product call: `asin` is null and `asin_warnings` is empty. The call counts as one request of the API request limit. It does not use the IP-Alert checks of the extension.", "operationId": "getBrandIpAlerts", "parameters": [ { "name": "brand", "in": "query", "description": "The brand name. The match ignores the case.", "required": true, "schema": { "type": "string", "example": "CATAN", "maxLength": 255 } }, { "name": "marketplace_id", "in": "query", "description": "Amazon marketplace id. The default is `ATVPDKIKX0DER` (amazon.com). The names `marketplaceId` and `domain` give 400. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": false, "schema": { "type": "string", "example": "ATVPDKIKX0DER" } } ], "responses": { "200": { "description": "The IP-Alert warnings", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IpAlertReport" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/ip-alerts/sellers/{seller_id}": { "get": { "tags": [ "IP-Alert (Beta)" ], "summary": "List seller IP-Alerts", "description": "Gives the products of the latest storefront of the seller that are high-risk for IP-Alert, with the newest warning first. Use it to check the risk of a seller or a supplier before you buy from it. The IP-Alert data has no seller: it shows the warnings of the ASINs and brands that the seller sells, not the warnings of the seller account. The team must track the seller in Seller Spy in the marketplace of the call: add it with POST /api/v1/sa/seller-spy/sellers. A seller that Seller Assistant still reads gives an empty list. `meta.summary` gives the counts of the whole storefront. The call counts as one request of the API request limit.", "operationId": "listSellerIpAlerts", "parameters": [ { "name": "seller_id", "in": "path", "description": "The id of the seller on Amazon, as `seller_id` of Seller Spy shows it.", "required": true, "schema": { "type": "string", "example": "A1B2C3D4E5F6G7" } }, { "name": "marketplace_id", "in": "query", "description": "Amazon marketplace id of the tracked seller. Seller Spy tracks one seller once for each marketplace, so the call has no default. The names `marketplaceId` and `domain` give 400. See all options [here](https://developer.sellerassistant.app/doc-648175).", "required": true, "schema": { "type": "string", "example": "ATVPDKIKX0DER" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the high-risk products", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IpAlertSellerProduct" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" }, "summary": { "properties": { "products": { "description": "The products of the latest storefront snapshot.", "type": "integer", "example": 340 }, "high_risk_products": { "description": "The high-risk products of the storefront. It is equal to `pagination.total`.", "type": "integer", "example": 47 }, "high_risk_brands": { "description": "The brands of the storefront with a warning or a brand owner request.", "type": "integer", "example": 5 } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "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 10 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": [] } ] } }, "/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 10 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": [] } ] } }, "/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 10 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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] }, "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": [] } ] }, "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": [] } ] } }, "/api/v1/me": { "get": { "tags": [ "Account (Beta)" ], "summary": "Get account", "description": "One call answers the whole account. The call does not count against the API request limit, and it answers also when the limit is reached. `GET /api/v1/users/me` answers a part of the same data in the older shape, and it carries a Deprecation header.", "operationId": "getAccount", "responses": { "200": { "description": "The account", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "user": { "properties": { "id": { "type": "integer", "example": 123 }, "name": { "type": [ "string", "null" ], "example": "My Name" }, "email": { "type": "string", "example": "test@gmail.com" } }, "type": "object" }, "team": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": [ "string", "null" ], "example": "Acme" }, "role": { "type": "string", "example": "owner", "enum": [ "owner", "member" ] } }, "type": "object" }, "subscription": { "properties": { "active": { "type": "boolean", "example": true }, "on_trial": { "type": "boolean", "example": false }, "plan_id": { "type": [ "string", "null" ], "example": "pro-monthly" }, "gateway": { "type": [ "string", "null" ], "example": "stripe", "enum": [ "stripe", "braintree" ] }, "ends_at": { "type": [ "string", "null" ], "format": "date-time" }, "trial_ends_at": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object" }, "marketplaces": { "type": "array", "items": { "properties": { "marketplace_id": { "type": "string", "example": "ATVPDKIKX0DER" }, "domain": { "type": "string", "example": "amazon.com" }, "country_code": { "type": "string", "example": "US" }, "region": { "type": "string", "example": "na" }, "seller_account_id": { "type": "string", "example": "A1B2C3D4E5" } }, "type": "object" } }, "quotas": { "description": "One entry for each tool that has a limit.", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Quota" } }, "features": { "description": "One entry for each tool that can go under maintenance.", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FeatureFlag" } } }, "type": "object" } }, "type": "object" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] }, { "oauth2": [ "read_write" ] } ] } }, "/api/v1/notes": { "get": { "tags": [ "Notes (Beta)" ], "summary": "List notes", "description": "The call names what the notes hang on. The application keeps notes in two tables, and this endpoint reads both.", "operationId": "listNotes", "parameters": [ { "name": "target_type", "in": "query", "description": "What the notes belong to.", "required": true, "schema": { "type": "string", "example": "asin", "enum": [ "asin", "supplier", "purchase_order", "warehouse", "price_list" ] } }, { "name": "target_id", "in": "query", "description": "For the type `asin` the id is `/`.", "required": true, "schema": { "type": "string", "example": "ATVPDKIKX0DER/B08N5WRWNW" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the notes, newest first", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "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": [] } ] }, "post": { "tags": [ "Notes (Beta)" ], "summary": "Create a note", "description": "Adds notes. The body is one note, or an array of up to 100 notes. `target_type` and `target_id` name what a note belongs to. For `asin` the id is `/`.", "operationId": "createNote", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/NoteForm" }, { "title": "Several rows in one call", "type": "array", "items": { "$ref": "#/components/schemas/NoteForm" }, "maxItems": 100 } ] } } } }, "responses": { "201": { "description": "The note", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Note" } }, "type": "object" } } } }, "200": { "description": "One result for each element. An array answers this shape.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "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": [] } ] }, "delete": { "tags": [ "Notes (Beta)" ], "summary": "Delete notes", "description": "The call names the notes with `ids`, and the target type says which store holds them. The answer keeps the order of the input, so the caller can match an error to the id it sent. `DELETE /api/v1/notes/{id}` removes one note and answers 204.", "operationId": "deleteNotes", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids", "target_type" ], "properties": { "ids": { "type": "array", "items": { "type": "integer", "example": 7 }, "maxItems": 200 }, "target_type": { "type": "string", "example": "asin", "enum": [ "asin", "supplier", "purchase_order", "warehouse", "price_list" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/notes/{id}": { "delete": { "tags": [ "Notes (Beta)" ], "summary": "Delete a note", "description": "The body carries `target_type`, because the id alone does not say which store holds the row.", "operationId": "deleteNote", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 7 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "target_type" ], "properties": { "target_type": { "type": "string", "example": "asin", "enum": [ "asin", "supplier", "purchase_order", "warehouse", "price_list" ] } }, "type": "object" } } } }, "responses": { "204": { "description": "The note is gone" }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "patch": { "tags": [ "Notes (Beta)" ], "summary": "Update a note", "description": "The body carries `target_type`, because the id alone does not say which of the two stores holds the row.", "operationId": "updateNote", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 7 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "target_type", "note" ], "properties": { "target_type": { "type": "string", "example": "asin", "enum": [ "asin", "supplier", "purchase_order", "warehouse", "price_list" ] }, "note": { "type": "string", "example": "pays late" } }, "type": "object" } } } }, "responses": { "200": { "description": "The note", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Note" } }, "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": [] } ] } }, "/api/v1/price-list-analyzer": { "post": { "tags": [ "Price List Analyzer" ], "summary": "Start a price list analysis, from a file or from already-mapped JSON items", "description": "Starts Price List Analyzer processing from either an xls/xlsx/csv file, or a JSON `items` array whose fields are already mapped. Exactly one of `file` or `items` must be provided. \n\n**File mode**: if the file columns are not explicitly mapped via the `mapping` parameter, AI is used to automatically detect the mapping (same as the Seller Assistant dashboard). At minimum, the identifier (UPC/EAN/ASIN) and cost of goods columns must be mapped, either explicitly or by AI, otherwise a validation error is returned.\n\n**JSON items mode**: send `items` as an array of objects, each already mapped with `identifier` (required) and `cog` (required); `title`, `supplier_sku`, `price_type` and `supplier_case_quantity` are optional. `cog` is the price of one unit unless `price_type` is `case`, in which case it is the price of a whole case and `supplier_case_quantity` is required. Requires an Amazon seller account connected for the target marketplace, since identifiers are resolved to ASINs via SP-API.", "operationId": "uploadPriceList", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "The price list file (xlsx, xls or csv). Required unless `items` is provided.", "type": [ "string", "null" ], "format": "binary" }, "items": { "description": "JSON-encoded array of already-mapped items (see PriceListAnalyzerJsonItem). Required unless `file` is provided. Cannot be combined with `file`.", "type": [ "string", "null" ], "example": "[{\"identifier\":\"012345678905\",\"cog\":41.00,\"title\":\"Sample Product\",\"supplier_sku\":\"SUP-123\",\"price_type\":\"case\",\"supplier_case_quantity\":12},{\"identifier\":\"612345678903\",\"cog\":14.5},{\"identifier\":\"B00U26V4VQ\",\"cog\":21.75,\"title\":\"Another Product\",\"supplier_sku\":\"SUP-456\"}]" }, "domain": { "description": "Amazon marketplace domain. Defaults to amazon.com.", "type": "string", "example": "amazon.com" }, "marketplaceId": { "description": "Amazon marketplace id. Takes priority over `domain` if both are set.", "type": "string", "example": "ATVPDKIKX0DER" }, "description": { "description": "Optional description for the price list", "type": [ "string", "null" ], "example": "Supplier catalog Q1" }, "mapping": { "description": "File mode only. JSON-encoded object describing which file columns to use. Required fields: `identifier_column`, `cog_column`. Optional: `sheet` (sheet index, default: first sheet), `header_row_index` (default 0), `title_column`, `supplier_sku_column`, `supplier_cq_column`. When omitted, AI is used to detect the mapping automatically. Ignored when `items` is provided.", "type": [ "string", "null" ], "example": "{\"identifier_column\":0,\"cog_column\":2}" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListAnalyzerUploadResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "description": "The upload breaks a business rule. The code `pla_limit_reached` means that the file or the items have more identifiers than are left on the plan in this period. Then `identifiers` and `left` give the two numbers.", "content": { "application/json": { "schema": { "required": [ "code", "message", "traceId" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "pla_limit_reached" }, "message": { "description": "Error message", "type": "string", "example": "The price list has 1,200 identifiers, but only 1,000 are left in your plan this period." }, "identifiers": { "description": "Only with `pla_limit_reached`: the identifiers in the upload.", "type": "integer", "example": 1200 }, "left": { "description": "Only with `pla_limit_reached`: the identifiers that are left on the plan.", "type": "integer", "example": 1000 }, "traceId": { "description": "Id of the error, to find it in the logs.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/price-list-analyzer/{id}/status": { "get": { "tags": [ "Price List Analyzer" ], "summary": "Get price list processing status", "operationId": "getPriceListStatus", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 123 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListAnalyzerStatusResponse" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/price-list-analyzer/{id}/items": { "get": { "tags": [ "Price List Analyzer" ], "summary": "Get price list results (paginated)", "description": "Returns the analyzed items of a price list. Supports pagination (10, 50 or 100 per page, default 50), free-text search, sorting, and the same advanced filter parameters used by the Seller Assistant dashboard (e.g. `brand`, `cog`, `warning`, `restrictions`, `tags`, etc., passed as additional query parameters).", "operationId": "getPriceListItems", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 123 } }, { "name": "page", "in": "query", "description": "Page number. Default 1.", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "perPage", "in": "query", "description": "Items per page. Allowed values: 10, 50, 100. Default 50.", "required": false, "schema": { "type": "integer", "example": 50, "enum": [ 10, 50, 100 ] } }, { "name": "search", "in": "query", "description": "Free-text search across title, ASIN, identifier, brand, category, UPC, EAN, GTIN", "required": false }, { "name": "sortKey", "in": "query", "description": "Field to sort by, e.g. profit_fba, cog, roi_fba", "required": false }, { "name": "sortOrder", "in": "query", "description": "Sort direction: asc or desc", "required": false } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "pagination": { "properties": { "currentPage": { "type": "integer", "example": 1 }, "perPage": { "type": "integer", "example": 50 }, "total": { "type": "integer", "example": 240 }, "lastPage": { "type": "integer", "example": 5 } }, "type": "object" }, "meta": { "description": "Present on trial when the trial hides rows of the list.", "properties": { "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/price-list-analyzer/items/{itemId}": { "put": { "tags": [ "Price List Analyzer" ], "summary": "Update calculations for a single price list item", "description": "Update the cost of goods (cog) or any expense field for a single price list item. Calculations (profit, ROI, margin, etc.) are recomputed automatically.", "operationId": "updatePriceListItem", "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer", "example": 456 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "cog": { "type": [ "number", "null" ], "format": "float", "example": 12.5 }, "package_quantity": { "type": [ "integer", "null" ], "example": 1 }, "ref_fee": { "type": [ "number", "null" ], "format": "float", "example": 3.5 }, "fba_fee": { "type": [ "number", "null" ], "format": "float", "example": 5.25 }, "fba_hazmat_fee": { "type": [ "number", "null" ], "format": "float" }, "fbm_hazmat_fee": { "type": [ "number", "null" ], "format": "float" }, "fba_oversize_fee": { "type": [ "number", "null" ], "format": "float" }, "fbm_oversize_fee": { "type": [ "number", "null" ], "format": "float" }, "third_pl": { "type": [ "number", "null" ], "format": "float" }, "inbound_shipment_per_pound": { "type": [ "number", "null" ], "format": "float" }, "inbound_shipment_per_pound_fbm": { "type": [ "number", "null" ], "format": "float" }, "inbound_shipment_per_item": { "type": [ "number", "null" ], "format": "float" }, "inbound_shipment_per_item_fbm": { "type": [ "number", "null" ], "format": "float" }, "prep_cost": { "type": [ "number", "null" ], "format": "float" }, "prep_cost_fbm": { "type": [ "number", "null" ], "format": "float" }, "fragile_cost": { "type": [ "number", "null" ], "format": "float" }, "fragile_cost_fbm": { "type": [ "number", "null" ], "format": "float" }, "misc_fee_rate": { "type": [ "number", "null" ], "format": "float" }, "misc_fee": { "type": [ "number", "null" ], "format": "float" }, "supplier_sku": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "custom_selling_price": { "description": "A selling price for this item. The item then uses selling_price_type 5 (Custom). Send null to go back to the price type that the item used before.", "type": [ "number", "null" ], "format": "float", "example": 24.99 } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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": [] } ] } }, "/api/v1/price-list-analyzer/{id}/expenses": { "put": { "tags": [ "Price List Analyzer" ], "summary": "Update expenses configuration for a price list", "description": "Update the expenses configuration (VAT, shipping, prep costs, etc.) applied to the whole price list. All items are recalculated in the background if the configuration changed.", "operationId": "updatePriceListExpenses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 123 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "configs" ], "properties": { "configs": { "description": "Expenses configuration object, same shape as returned by the price list status/items endpoints.", "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "updating": { "description": "Whether the price list is being recalculated", "type": "boolean", "example": true } }, "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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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`, `ASIN_NOT_FOUND` (Amazon does not recognize the ASIN). 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": "seller_account_id", "in": "query", "description": "Active seller account of this team in the marketplace region. Required when multiple sellers are connected.", "required": false, "schema": { "type": "string" } }, { "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": [] } ] } }, "/api/v1/sa/inventory/products/history": { "get": { "tags": [ "Product History (Beta)" ], "summary": "List product history", "description": "Lists the changes of the products of the team, the newest first. The history keeps only the last 30 days. Older changes are deleted. Filter by `internal_product_id` to get the history of one product.", "operationId": "getTeamHistory", "parameters": [ { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" }, { "name": "filter[action][in]", "in": "query", "description": "The actions to keep, separated by commas. Use filter[action][eq] for one action. The actions are: created, updated, deleted, supplier_offer_created, supplier_offer_updated, supplier_offer_deleted, default_supplier_changed, external_product_created, external_product_updated, external_product_deleted, feedback_changed, note_changed, tag_added, tag_deleted. A different action answers 400.", "required": false, "schema": { "type": "string", "example": "tag_added,note_changed" } }, { "name": "filter[user_id][eq]", "in": "query", "description": "The user who made the change.", "required": false, "schema": { "type": "integer" } }, { "name": "filter[internal_product_id][eq]", "in": "query", "description": "Gives the history of one product.", "required": false, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "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", "example": 135 }, "user": { "description": "Who made the change. `filter[user_id][eq]` takes this id. A deleted user has a null name. A change with no user is null.", "properties": { "id": { "type": "integer", "example": 135 }, "name": { "type": [ "string", "null" ], "example": "AlexT" } }, "type": [ "object", "null" ] }, "action": { "type": "string", "example": "supplier_offer_updated" }, "entity_type": { "description": "What the change touched: `internal_product`, `supplier_offer` or `external_product`. It is null for the tags, the notes and the feedback.", "type": [ "string", "null" ], "example": "supplier_offer" }, "entity_id": { "description": "The id of the touched row. It is null for the product itself.", "type": [ "integer", "null" ], "example": 251 }, "changes": { "description": "An action that changes a row (`updated`, `*_updated`, `default_supplier_changed`) gives `{\"old\": {...}, \"new\": {...}}` with the fields before and after. Every other action gives the fields of the row, for example `{\"cog\": 55, \"supplier_id\": 53}` for `supplier_offer_created` or `{\"tag_id\": 4, \"tag_name\": \"Toys\"}` for `tag_added`.", "type": [ "object", "null" ], "example": { "old": { "cog": 30 }, "new": { "cog": 5 } } }, "source": { "description": "Where the change came from, for example `api-inventory`, `cabinet-inventory` or `price-list-analyzer`.", "type": "string", "example": "api-inventory" }, "source_attributes": { "description": "More data about the source. Null when there is none.", "type": [ "object", "null" ] }, "metadata": { "description": "More data about the change. Null when there is none.", "type": [ "object", "null" ] }, "created_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "meta": { "properties": { "pagination": { "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "type": "object" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "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": [] } ] } }, "/api/v1/sa/inventory/products/filter-options": { "get": { "tags": [ "Inventory Products (Beta)" ], "summary": "List filter values", "description": "Gives the names that the filters of the product list take: the brands of the products, the marketplaces of the matches and the suppliers of the offers. `GET /api/v1/tags` gives the tags.", "operationId": "listInventoryProductFilterOptions", "responses": { "200": { "description": "The values of every filter", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "brand": { "type": "array", "items": { "type": "string", "example": "Apple" } }, "marketplace": { "type": "array", "items": { "type": "string", "example": "amazon.com" } }, "seller": { "type": "array", "items": { "type": "string", "example": "Acme Wholesalers" } } }, "type": "object" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/inventory/products": { "get": { "tags": [ "Inventory Products (Beta)" ], "summary": "List products", "description": "Filters use `filter[field][operator]=value`. Several filters narrow each other.\n\n| Field | Operators | Example |\n|---|---|---|\n| `id` | eq, in | `filter[id][in]=P-5XK1S0NQNO,P-IQGFRCLHKT` |\n| `asin`, `upc`, `ean`, `title`, `note` | eq, like, nlike, null | `filter[title][like]=catan` |\n| `brand`, `marketplace`, `default_supplier`, `other_supplier`, `tag` | eq, in, ne, nin, null | `filter[brand][in]=Catan` |\n| `default_cog`, `other_cog`, `total_stock` | eq, ne, gte, lte, between | `filter[total_stock][between]=10,50` |\n| `preference` (`like`, `dislike`), `listing_status` (`active`, `inactive`, `error`, `no_listing`) | eq, in, ne, nin | `filter[listing_status][eq]=active` |\n\nThe name filters take the name, not the id. `GET /api/v1/sa/inventory/products/filter-options` gives the brands, the marketplaces and the suppliers of the team. `GET /api/v1/tags` gives the tags. The `note` filter reads the notes of the product ASINs. `/api/v1/notes` with `target_type=asin` reads and writes them. The `target_id` is `/` of a match. The user sets the `preference` value in the Seller Assistant app. The API does not show or change it. An unknown field or operator answers 400.", "operationId": "listInternalProducts", "parameters": [ { "name": "filter[brand][eq]", "in": "query", "description": "One value of the field.", "required": false, "schema": { "type": "string", "example": "Nike" } }, { "name": "filter[title][like]", "in": "query", "description": "A part of the value.", "required": false, "schema": { "type": "string", "example": "case" } }, { "name": "filter[default_supplier][in]", "in": "query", "description": "Several values, separated by commas. The name of the supplier, not its id.", "required": false, "schema": { "type": "string", "example": "Suppl,Another supplier" } }, { "name": "filter[total_stock][gte]", "in": "query", "description": "A number. The operator `lte` reads the other end.", "required": false, "schema": { "type": "integer", "example": 10 } }, { "name": "filter[default_cog][between]", "in": "query", "description": "Two values, the low one and the high one.", "required": false, "schema": { "type": "string", "example": "5,50" } }, { "name": "filter[note][null]", "in": "query", "description": "Rows where the field is empty, or, with `false`, rows where it is not. Empty means a null **or** an empty string: a person who did not fill a field does not tell the two apart.", "required": false, "schema": { "type": "boolean", "example": true } }, { "name": "filter[id][in]", "in": "query", "description": "The ids of the products, separated by commas.", "required": false, "schema": { "type": "string", "example": "P-5XK1S0NQNO,P-T4FGBOVWHJ" } }, { "name": "filter[asin][eq]", "in": "query", "description": "The whole ASIN. `like` reads a part of it, and `upc` and `ean` work the same way.", "required": false, "schema": { "type": "string", "example": "B0DGHMNQ5Z" } }, { "name": "filter[upc][eq]", "in": "query", "description": "The whole UPC. `like` reads a part of it.", "required": false, "schema": { "type": "string", "example": "029877030712" } }, { "name": "filter[ean][eq]", "in": "query", "description": "The whole EAN. `like` reads a part of it.", "required": false, "schema": { "type": "string", "example": "0029877030712" } }, { "name": "filter[marketplace][in]", "in": "query", "description": "The domains of the marketplaces, separated by commas.", "required": false, "schema": { "type": "string", "example": "amazon.com,amazon.de" } }, { "name": "filter[other_supplier][in]", "in": "query", "description": "Keeps the products a supplier offers, whether or not it is the default one.", "required": false, "schema": { "type": "string", "example": "Platest" } }, { "name": "filter[tag][in]", "in": "query", "description": "The names of the tags, separated by commas. `GET /api/v1/tags` answers them.", "required": false, "schema": { "type": "string", "example": "Wholesale,Manual Revenue" } }, { "name": "filter[other_cog][gte]", "in": "query", "description": "The cost of an offer that is not the default one.", "required": false, "schema": { "type": "number", "example": 5 } }, { "name": "filter[preference][eq]", "in": "query", "description": "The feedback of the team on the product. The user sets it in the Seller Assistant app.", "required": false, "schema": { "type": "string", "example": "like", "enum": [ "like", "dislike" ] } }, { "name": "filter[listing_status][in]", "in": "query", "description": "The state of the listings of the product. `no_listing` keeps the products that have none.", "required": false, "schema": { "type": "string", "example": "active,error" } }, { "$ref": "#/components/parameters/ApiV1Search" }, { "name": "sort", "in": "query", "description": "The column to order by: title, brand, asin, cog, created_at, updated_at. A minus sign in front of the name orders from the highest down. Without a sort the order is `-updated_at`. Another name answers 400.", "required": false, "schema": { "type": "string", "example": "-created_at" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the products", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InternalProduct" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "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": [] } ] }, "post": { "tags": [ "Inventory Products (Beta)" ], "summary": "Create products", "description": "The body is one product or an array of them.", "operationId": "createInternalProduct", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InternalProductForm" }, { "title": "Several rows in one call", "type": "array", "items": { "$ref": "#/components/schemas/InternalProductForm" }, "maxItems": 100 } ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/InternalProduct" } }, "type": "object" } } } }, "200": { "description": "One result for each element. An array answers this shape.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InternalProduct" } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "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": [] } ] }, "delete": { "tags": [ "Inventory Products (Beta)" ], "summary": "Archive products", "description": "Name the products with `ids`. The answer keeps the order of `ids`, so each error matches the id that you sent.", "operationId": "deleteInternalProducts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "example": "P-5XK1S0NQNO" } } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "properties": { "succeeded": { "type": "integer", "example": 2 }, "failed": { "type": "integer", "example": 1 } }, "type": "object" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "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": [] } ] } }, "/api/v1/sa/inventory/products/{productId}": { "get": { "tags": [ "Inventory Products (Beta)" ], "summary": "Get a 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": { "properties": { "data": { "$ref": "#/components/schemas/InternalProduct" } }, "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": [] } ] }, "delete": { "tags": [ "Inventory Products (Beta)" ], "summary": "Archive a product", "description": "Archives the product and hides it from lists and searches. Costs, offers, history and background data collection remain. Adding the same ASIN restores it. The answer carries no body.", "operationId": "deleteInternalProduct", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "responses": { "204": { "description": "The product is archived. The answer carries no body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "patch": { "tags": [ "Inventory Products (Beta)" ], "summary": "Update a product", "description": "Update product.", "operationId": "updateInternalProduct", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "requestBody": { "description": "The fields to change. `default_supplier_id` sets the default supplier of the product: the filter `default_cog` then reads the cost of the offer of that supplier.", "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalProductForm" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/InternalProduct" } }, "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": [] } ] } }, "/api/v1/sa/inventory/products/{productId}/matches": { "put": { "tags": [ "Inventory Products (Beta)" ], "summary": "Set product matches", "description": "Sets the matches of the product to the matches of the body. A match that the body does not name is removed. A product has one Amazon ASIN: to change it, send the new ASIN without the old one. An ASIN of another product of the team answers 422.", "operationId": "writeProductMatches", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "matches" ], "properties": { "matches": { "type": "array", "items": { "$ref": "#/components/schemas/ProductMatchItem" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductMatch" } } }, "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": [] } ] }, "delete": { "tags": [ "Inventory Products (Beta)" ], "summary": "Remove product matches", "description": "Removes the matches of the body. The answer is the matches that stay. A match that the product does not have is skipped, so a repeated call gives the same answer. To set all matches, use the PUT.", "operationId": "deleteProductMatches", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "matches" ], "properties": { "matches": { "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": "The matches that stay", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductMatch" } } }, "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": [] } ] } }, "/api/v1/sa/inventory/listings": { "get": { "tags": [ "Listings (Beta)" ], "summary": "List listings", "description": "These are the listings of SA Inventory. The SP-API proxy of Amazon stays at `/api/v1/listings/items`.", "operationId": "listListings", "parameters": [ { "name": "filter[status][eq]", "in": "query", "description": "Keeps the listings of one status: draft, pending, active, error or inactive.", "required": false, "schema": { "type": "string", "example": "draft" } }, { "name": "filter[channel][eq]", "in": "query", "description": "Keeps the listings of one sales channel.", "required": false, "schema": { "type": "string", "enum": [ "amazon", "walmart", "shopify", "ebay" ] } }, { "name": "filter[batch_id][eq]", "in": "query", "description": "Keeps the listings that one create call made.", "required": false, "schema": { "type": "string" } }, { "name": "filter[marketplace_id][eq]", "in": "query", "description": "The marketplace of the channel, as the answer writes it.", "required": false, "schema": { "type": "string", "example": "ATVPDKIKX0DER" } }, { "$ref": "#/components/parameters/ApiV1Search" }, { "name": "sort", "in": "query", "description": "The column to order by: created_at, listed_at, price, sku, status. A minus sign in front of the name orders from the highest down. Without a sort the order is `-created_at`. Another name answers 400.", "required": false, "schema": { "type": "string", "example": "-created_at" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the listings", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Listing" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "post": { "tags": [ "Listings (Beta)" ], "summary": "Create listing drafts", "description": "The write takes one object or an array of them, so there is no bulk endpoint. One object answers 201 with the listing, and an array answers 200 with one result for each item, in the order they arrived.", "operationId": "createListings", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ListingForm" }, { "title": "Several rows in one call", "type": "array", "items": { "$ref": "#/components/schemas/ListingForm" }, "maxItems": 100 } ] } } } }, "responses": { "201": { "description": "One listing", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Listing" } }, "type": "object" } } } }, "200": { "description": "One result for each item", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Listings (Beta)" ], "summary": "Delete listings", "description": "The call names the rows with `ids`. The answer keeps the order of the input, so the caller can match an error to the id it sent. The path with an id removes one row and answers 204.", "operationId": "deleteListings", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "integer", "example": 7 }, "maxItems": 200 } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/inventory/listings/{id}": { "get": { "tags": [ "Listings (Beta)" ], "summary": "Get a listing", "description": "Gives one listing of the team.", "operationId": "getListing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 91 } } ], "responses": { "200": { "description": "The listing", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Listing" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Listings (Beta)" ], "summary": "Delete a listing draft", "description": "A listing that already went to the channel cannot be deleted here.", "operationId": "deleteListing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 91 } } ], "responses": { "204": { "description": "The listing is gone" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/inventory/purchase-orders": { "get": { "tags": [ "Purchase Orders (Beta)" ], "summary": "List purchase orders", "description": "Lists the purchase orders of the team.", "operationId": "listPurchaseOrders", "parameters": [ { "name": "filter[status][eq]", "in": "query", "description": "Keeps the orders of one status: draft, sent, completed or cancelled.", "required": false, "schema": { "type": "string", "example": "draft" } }, { "name": "filter[supplier_id][eq]", "in": "query", "description": "Keeps the orders of one supplier.", "required": false, "schema": { "type": "integer", "example": 5 } }, { "name": "filter[days][eq]", "in": "query", "description": "Keeps the orders the team created over the last days.", "required": false, "schema": { "type": "integer", "example": 30, "minimum": 1 } }, { "name": "include", "in": "query", "description": "`include=items` adds the items of every order of the page, and it reads them only when you ask. It adds the first 100 items of every order, by id. The count of the items is always there as `items_count`, and `/purchase-orders/{id}/items` serves them all as a page of its own.", "required": false, "schema": { "type": "string", "example": "items" } }, { "$ref": "#/components/parameters/ApiV1Search" }, { "name": "sort", "in": "query", "description": "The column to order by: created_at, order_date, po_id, status, total_price, items_count, supplier_name, profit_roi. A minus sign in front of the name orders from the highest down. Without a sort the order is `-created_at`. Another name answers 400.", "required": false, "schema": { "type": "string", "example": "-created_at" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the purchase orders", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "post": { "tags": [ "Purchase Orders (Beta)" ], "summary": "Create purchase orders", "description": "A new order is always a draft, and the items arrive through the items endpoint. The plan must carry the purchase orders, and the team must have one left of its quota for every order of the call: without either the call answers 422. The body is one order or an array of them.", "operationId": "createPurchaseOrder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PurchaseOrderCreateForm" }, { "title": "Several orders in one call", "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderCreateForm" }, "maxItems": 100 } ] } } } }, "responses": { "201": { "description": "The purchase order", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PurchaseOrder" } }, "type": "object" } } } }, "200": { "description": "One result for each element. An array answers this shape.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "422": { "$ref": "#/components/responses/BusinessLogicError", "description": "The plan refuses the purchase orders of the call. The code `feature_not_available` says the plan gives none, and `plan_limit_reached` says the call would pass the limit. An array is checked as a whole." }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound", "description": "One object named a supplier that the team does not have. For an array, the error of that element is in `errors`." }, "409": { "$ref": "#/components/responses/Conflict", "description": "Another create of purchase orders of the team is running. The call waited for it and gave up; a retry can go through." }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Purchase Orders (Beta)" ], "summary": "Delete purchase orders", "description": "The call names the orders with `ids`. The answer keeps the order of the input, so the caller can match an error to the id it sent.", "operationId": "deletePurchaseOrders", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "integer", "example": 42 }, "maxItems": 100 } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/inventory/purchase-orders/{id}": { "get": { "tags": [ "Purchase Orders (Beta)" ], "summary": "Get a purchase order", "description": "Gives one purchase order of the team. `GET /api/v1/sa/inventory/purchase-order-items` with `filter[purchase_order_id][eq]` gives all its items.", "operationId": "getPurchaseOrder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 42 } }, { "name": "include", "in": "query", "description": "`include=items` adds the first 100 items of the order, by id. `items_count` reports the real number. An order with more items needs `/purchase-orders/{id}/items`, which serves them all as a page and takes a search and a sort.", "required": false, "schema": { "type": "string", "example": "items" } } ], "responses": { "200": { "description": "The purchase order", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PurchaseOrder" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Purchase Orders (Beta)" ], "summary": "Delete a purchase order", "description": "The path names the row, and the answer carries no body. `DELETE /api/v1/sa/inventory/purchase-orders` removes several in one call and answers a result for each id.", "operationId": "deletePurchaseOrder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 31 } } ], "responses": { "204": { "description": "The purchase order is gone. The answer carries no body." }, "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": [] } ] }, "patch": { "tags": [ "Purchase Orders (Beta)" ], "summary": "Update a purchase order", "description": "The warehouse cannot change while a shipment is linked to the order, and the call answers 422 then. A change of the order level costs spreads them over the items again.", "operationId": "updatePurchaseOrder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 42 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderForm" } } } }, "responses": { "200": { "description": "The purchase order", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PurchaseOrder" } }, "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": [] } ] } }, "/api/v1/sa/inventory/purchase-order-items": { "get": { "tags": [ "Purchase Orders (Beta)" ], "summary": "List order items", "description": "Lists the items of all purchase orders of the team. Filter by `purchase_order_id` to get the items of one order.", "operationId": "searchPurchaseOrderItems", "parameters": [ { "name": "filter[purchase_order_id][eq]", "in": "query", "description": "Keeps the items of one order.", "required": false, "schema": { "type": "integer", "example": 42 } }, { "$ref": "#/components/parameters/ApiV1Search" }, { "name": "sort", "in": "query", "description": "The column to order by: created_at, title, asin, sku, unit_cost, unit_count, total_cost, profit_fba. A minus sign in front of the name orders from the highest down. Without a sort the order is `-created_at`. Another name answers 400.", "required": false, "schema": { "type": "string", "example": "-created_at" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the items", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderItem" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Purchase Orders (Beta)" ], "summary": "Delete order items", "description": "The call names the items with `ids`. The ids can belong to several orders. The totals of every order they touch are calculated again.", "operationId": "deletePurchaseOrderItems", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "integer", "example": 4471 }, "maxItems": 200 } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/inventory/purchase-orders/{id}/items": { "post": { "tags": [ "Purchase Orders (Beta)" ], "summary": "Add order items", "description": "The body is one item, an array of items, or an object with `items`. The answer is the order, because the totals and the item count change with every item added. An item with an ASIN goes to the profit calculation. An item that names `internal_product_id` reads the title, the picture and the ASIN from that product, and a field the body sends stays as the body sends it.", "operationId": "addPurchaseOrderItems", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 42 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PurchaseOrderItemForm" }, { "title": "Several lines in one call", "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderItemForm" }, "maxItems": 500 }, { "title": "The lines inside items", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderItemForm" }, "maxItems": 500 } }, "type": "object" } ] } } } }, "responses": { "201": { "description": "The purchase order, with the new totals", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PurchaseOrder" } }, "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": [] } ] } }, "/api/v1/sa/inventory/purchase-order-items/{id}": { "delete": { "tags": [ "Purchase Orders (Beta)" ], "summary": "Delete an order item", "description": "The path names the row, and the answer carries no body. `DELETE /api/v1/sa/inventory/purchase-order-items` removes several in one call and answers a result for each id.", "operationId": "deletePurchaseOrderItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 3390 } } ], "responses": { "204": { "description": "The item is gone. The answer carries no body." }, "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": [] } ] }, "patch": { "tags": [ "Purchase Orders (Beta)" ], "summary": "Update an order item", "description": "A change of the cost or the count moves the totals of the order, and the offer of the supplier follows the new cost.", "operationId": "updatePurchaseOrderItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 4471 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "unit_cost": { "type": "number", "example": 9.5, "maximum": 99999.99, "minimum": 0 }, "unit_count": { "type": "integer", "example": 12, "minimum": 1 }, "sku": { "type": [ "string", "null" ], "maxLength": 255 } }, "type": "object" } } } }, "responses": { "200": { "description": "The item", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PurchaseOrderItem" } }, "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": [] } ] } }, "/api/v1/sa/inventory/skus": { "get": { "tags": [ "SKUs (Beta)" ], "summary": "List SKUs", "description": "A SKU has no create endpoint: SKUs arrive from the channel synchronisation.", "operationId": "listSkus", "parameters": [ { "name": "filter[listing_status][eq]", "in": "query", "description": "Keeps the SKUs of one listing status.", "required": false, "schema": { "type": "string", "enum": [ "active", "inactive", "draft" ] } }, { "name": "filter[channel][eq]", "in": "query", "description": "Keeps the SKUs of one sales channel.", "required": false, "schema": { "type": "string", "enum": [ "amazon", "walmart", "shopify", "ebay" ] } }, { "name": "filter[marketplace_id][eq]", "in": "query", "description": "Keeps the SKUs of one marketplace.", "required": false, "schema": { "type": "string", "example": "ATVPDKIKX0DER" } }, { "name": "filter[cost_source][eq]", "in": "query", "description": "Keeps the SKUs whose cost comes from one source: `po_linked` (a linked order item), `po_wac` (the weighted average of completed orders), `override` (a cost set by hand) or `none`.", "required": false, "schema": { "type": "string", "enum": [ "po_linked", "po_wac", "override", "none" ] } }, { "$ref": "#/components/parameters/ApiV1Search" }, { "name": "sort", "in": "query", "description": "The column to order by: sku, asin, landed_cost, created_at. A minus sign in front of the name orders from the highest down. Without a sort the order is `sku`. Another name answers 400.", "required": false, "schema": { "type": "string", "example": "-created_at" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the SKUs", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Sku" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "SKUs (Beta)" ], "summary": "Delete SKUs", "description": "The call names the SKUs with `ids`. The answer keeps the order of the input, so the caller can match an error to the id it sent. It is not a 204: a 204 would hide which ids failed.", "operationId": "deleteSkus", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "integer", "example": 812 }, "maxItems": 200 } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/inventory/skus/{id}": { "get": { "tags": [ "SKUs (Beta)" ], "summary": "Get a SKU", "description": "Add `include=cost_breakdown` to get how each cost is calculated.", "operationId": "getSku", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 812 } }, { "name": "include", "in": "query", "description": "`cost_breakdown` adds how each cost is calculated.", "required": false, "schema": { "type": "string", "example": "cost_breakdown" } } ], "responses": { "200": { "description": "The SKU", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Sku" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "SKUs (Beta)" ], "summary": "Delete a SKU", "description": "The path names the SKU, and the answer carries no body. `DELETE /api/v1/sa/inventory/skus` removes several in one call and answers a result for each id.", "operationId": "deleteSku", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 812 } } ], "responses": { "204": { "description": "The SKU is gone. The answer carries no body." }, "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": [] } ] }, "patch": { "tags": [ "SKUs (Beta)" ], "summary": "Update a SKU", "description": "The call changes only the fields the body carries, and it leaves the others as they are. The link to a purchase order line is a field, not an action: `purchase_order_item_id` links the SKU, and `null` unlinks it and keeps the costs the SKU already holds. The line must belong to the team, and one line holds one SKU, so a line another SKU already holds answers 409. `cost_overrides` holds the costs a person sets by hand, and they win over the ones the purchase order gives. A cost inside `cost_overrides` and the same cost at the top level are not the same field: `prep_cost` at the top level is the cost of the SKU, and `cost_overrides.prep_cost` overrides it.", "operationId": "updateSku", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 812 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "prep_cost": { "description": "Prep cost of one listing (pack).", "type": [ "number", "null" ], "example": 0.85 }, "purchase_order_item_id": { "description": "The purchase order line the costs come from. `null` unlinks the SKU.", "type": [ "integer", "null" ], "example": 4471 }, "cost_overrides": { "description": "The costs a person sets by hand. Each one wins over the cost the purchase order gives. Each cost is for one listing (pack), not for one unit: for a 2-pack, the cost of 2 units.", "properties": { "unit_cost": { "description": "Product cost of one listing (pack). For a 2-pack, the cost of 2 units.", "type": [ "number", "null" ] }, "prep_cost": { "description": "Prep cost of one listing (pack).", "type": [ "number", "null" ] }, "allocated_po_expenses": { "description": "Share of the purchase order expenses carried by one listing (pack).", "type": [ "number", "null" ] }, "fba_inbound_cost": { "description": "Cost to send one listing (pack) to an Amazon warehouse.", "type": [ "number", "null" ] }, "fbm_postage_cost": { "description": "The postage the seller pays for one listing (pack) in an FBM order. For an FBM SKU, the Repricer uses it for the profit and the cost-based price floors, and a change re-prices the SKU. `null` removes it: the postage is then not known, not zero.", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "The SKU", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Sku" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/inventory/supplier-offers": { "get": { "tags": [ "Supplier Offers (Beta)" ], "summary": "List supplier offers", "description": "Filter by `internal_product_id` to get the offers of one product, or by `supplier_id` to get the offers of one supplier.", "operationId": "listSupplierOffers", "parameters": [ { "name": "filter[internal_product_id][eq]", "in": "query", "description": "Keeps the offers of one product.", "required": false, "schema": { "type": "string", "example": "P-5XK1S0NQNO" } }, { "name": "filter[supplier_id][eq]", "in": "query", "description": "Keeps the offers of one supplier.", "required": false, "schema": { "type": "integer", "example": 10 } }, { "name": "sort", "in": "query", "description": "The column to order by: cog, sku, supplier_product_title, supplier_product_code, created_at, updated_at. A minus sign sorts down. Default: `-created_at`.", "required": false, "schema": { "type": "string", "example": "-created_at" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the offers", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierOffer" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "post": { "tags": [ "Supplier Offers (Beta)" ], "summary": "Create supplier offers", "description": "The body is one offer or an array of up to 100 offers. A product has one offer of each supplier: a second create for the same `internal_product_id` and `supplier_id` updates that offer.", "operationId": "createSupplierOffers", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SupplierOfferCreate" }, { "title": "Several rows in one call", "type": "array", "items": { "$ref": "#/components/schemas/SupplierOfferCreate" }, "maxItems": 100 } ] } } } }, "responses": { "201": { "description": "One object: the new offer", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/SupplierOffer" } }, "type": "object" } } } }, "200": { "description": "An array: one result for each element", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SupplierOffer" }, { "type": "null" } ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound", "description": "One object named a product or a supplier the team does not have. An array answers the element in `errors`." }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/inventory/supplier-offers/{id}": { "get": { "tags": [ "Supplier Offers (Beta)" ], "summary": "Get a supplier offer", "description": "Gives one supplier offer of the team.", "operationId": "getSupplierOffer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 352 } } ], "responses": { "200": { "description": "The offer", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/SupplierOffer" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Supplier Offers (Beta)" ], "summary": "Delete a supplier offer", "description": "Deletes the offer. When the supplier of the offer is the default supplier of the product, the product takes the supplier of its newest other offer, or no default supplier.", "operationId": "deleteSupplierOffer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 352 } } ], "responses": { "204": { "description": "The offer is deleted. The answer has no body." }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "patch": { "tags": [ "Supplier Offers (Beta)" ], "summary": "Update a supplier offer", "description": "Send only the fields to change. The product and the supplier of the offer do not change.", "operationId": "updateSupplierOffer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 352 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierOfferFields" } } } }, "responses": { "200": { "description": "The offer", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/SupplierOffer" } }, "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": [] } ] } }, "/api/v1/sa/inventory/suppliers": { "get": { "tags": [ "Suppliers (Beta)" ], "summary": "List suppliers", "description": "Lists the suppliers of the team.", "operationId": "listSuppliers", "parameters": [ { "$ref": "#/components/parameters/ApiV1Search" }, { "name": "sort", "in": "query", "description": "The column to order by: name, status, website, mov, currency, type, lead_time_min, lead_time_max, warehouse_name, user_name, created_at, updated_at. A minus sign in front of the name orders from the highest down. Without a sort the order is `-created_at`. Another name answers 400.", "required": false, "schema": { "type": "string", "example": "-created_at" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "description": "List of suppliers", "type": "array", "items": { "$ref": "#/components/schemas/Supplier" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "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": [] } ] }, "post": { "tags": [ "Suppliers (Beta)" ], "summary": "Create suppliers", "description": "The body is one supplier or an array of them. The website is unique inside the team.", "operationId": "createSupplier", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateSupplierForm" }, { "title": "Several rows in one call", "type": "array", "items": { "$ref": "#/components/schemas/CreateSupplierForm" }, "maxItems": 100 } ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Supplier" } }, "type": "object" } } } }, "200": { "description": "One result for each element. An array answers this shape.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Supplier" } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "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": [] } ] }, "delete": { "tags": [ "Suppliers (Beta)" ], "summary": "Delete suppliers", "description": "The call names the rows with `ids`. The answer keeps the order of the input, so the caller can match an error to the id it sent. The path with an id removes one row and answers 204.", "operationId": "deleteSuppliers", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "integer", "example": 7 }, "maxItems": 100 } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/inventory/suppliers/{supplierId}": { "get": { "tags": [ "Suppliers (Beta)" ], "summary": "Get a supplier", "description": "Gives one supplier of the team.", "operationId": "getSupplier", "parameters": [ { "name": "supplierId", "in": "path", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Supplier" } }, "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": [] } ] }, "delete": { "tags": [ "Suppliers (Beta)" ], "summary": "Delete a supplier", "description": "Deletes the supplier and all its offers. A product with this default supplier takes the supplier of its newest other offer, or no default supplier. The purchase orders of the supplier stay.", "operationId": "deleteSupplier", "parameters": [ { "name": "supplierId", "in": "path", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "204": { "description": "The supplier is gone. The answer carries no body." }, "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": [] } ] }, "patch": { "tags": [ "Suppliers (Beta)" ], "summary": "Update a supplier", "description": "Changes the fields of the body. The other fields keep their values.", "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": { "properties": { "data": { "$ref": "#/components/schemas/Supplier" } }, "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": [] } ] } }, "/api/v1/sa/inventory/warehouses": { "get": { "tags": [ "Warehouses (Beta)" ], "summary": "List warehouses", "description": "The list holds the warehouses of the team and the shared ones. A shared warehouse is read only.", "operationId": "listWarehouses", "parameters": [ { "$ref": "#/components/parameters/ApiV1Search" }, { "name": "sort", "in": "query", "description": "The column to order by: created_at, name, location, status. A minus sign in front of the name orders from the highest down. Without a sort the order is `-created_at`. Another name answers 400. The primary warehouse comes first whatever the column.", "required": false, "schema": { "type": "string", "example": "-created_at" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the warehouses", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "post": { "tags": [ "Warehouses (Beta)" ], "summary": "Create warehouses", "description": "The body is one warehouse or an array of them. The website is unique inside the team. `is_primary: true` moves the primary flag: one team has one primary warehouse.", "operationId": "createWarehouse", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/WarehouseForm" }, { "required": [ "name", "website" ] } ] }, { "title": "Several warehouses in one call", "type": "array", "items": { "$ref": "#/components/schemas/WarehouseForm" }, "maxItems": 100 } ] } } } }, "responses": { "201": { "description": "The warehouse the call wrote. One object answers this shape.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Warehouse" } }, "type": "object" } } } }, "200": { "description": "One result for each element. An array answers this shape.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "422": { "$ref": "#/components/responses/BusinessLogicError", "description": "The plan refuses the warehouses of the call. The code `feature_not_available` says the plan gives none, and `plan_limit_reached` says the call would pass the limit. An array is checked as a whole." }, "403": { "$ref": "#/components/responses/AccessDenied" }, "409": { "$ref": "#/components/responses/Conflict", "description": "Another create of warehouses of the team is running. The call waited for it and gave up; a retry can go through." }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Warehouses (Beta)" ], "summary": "Delete warehouses", "description": "The call names the warehouses with `ids`. The answer keeps the order of the input, so the caller can match an error to the id it sent.", "operationId": "deleteWarehouses", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "integer", "example": 3 }, "maxItems": 100 } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/inventory/warehouses/{id}": { "get": { "tags": [ "Warehouses (Beta)" ], "summary": "Get a warehouse", "description": "Gives one warehouse of the team.", "operationId": "getWarehouse", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 3 } } ], "responses": { "200": { "description": "The warehouse", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Warehouse" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Warehouses (Beta)" ], "summary": "Delete a warehouse", "description": "The path names the row, and the answer carries no body. `DELETE /api/v1/sa/inventory/warehouses` removes several in one call and answers a result for each id.", "operationId": "deleteWarehouse", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 7 } } ], "responses": { "204": { "description": "The warehouse is gone. The answer carries no body." }, "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": [] } ] }, "patch": { "tags": [ "Warehouses (Beta)" ], "summary": "Update a warehouse", "description": "A shared warehouse belongs to no team, so the team cannot change it and the call answers 404.", "operationId": "updateWarehouse", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 3 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarehouseForm" } } } }, "responses": { "200": { "description": "The warehouse", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Warehouse" } }, "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": [] } ] } }, "/api/v1/sa/inventory/warehouse-providers": { "get": { "tags": [ "Warehouses (Beta)" ], "summary": "List prep providers", "description": "Lists the prep providers that a warehouse can sync with. Connect a provider in the Seller Assistant app.", "operationId": "listWarehouseProviders", "responses": { "200": { "description": "The providers", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseProvider" } } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/repricer/history": { "get": { "tags": [ "Repricer (Beta)" ], "summary": "List repricing history", "description": "Lists the repricing runs of the team, the newest first.\n\nThe history keeps the runs of the last 32 days only. Without `from_date`, `to_date` or `period`, the list gives the last 32 days. An older `from_date` starts at the 32-day limit.\n\nA run has the old and the final price, the status, the strategy, the limits, the market data and the mode in effect.\n\n**Statuses**\n- `PRICE_UPDATE_SUBMITTED`: the run sent the new price to Amazon.\n- `PRICE_ALREADY_OPTIMAL`: the price of the seller is the target price.\n- `PRICE_SKIPPED_OUT_OF_BOUNDS`: the target price is outside the limits, so the run sent no price.\n- `PRICE_UPDATE_SKIPPED_BY_ALLOW_FLAG`: the price is correct, but a setting stops the update.\n- `DRY_RUN_PRICE_UPDATE_EMULATED`: a test system simulated the run, so it sent no price to Amazon.\n- `SKIPPED`: the run stopped on an expected condition. `error_code` gives the reason, for example `MISSING_COST_DATA_FOR_ECONOMICS_RULE`.\n- `FAILED`: the run stopped on an error. `error_code` gives the reason.\n- `PRICE_UPDATE_CONFIRMED`: Amazon confirmed the price. The repricer does not write this status yet.\n\n**Error codes of a failed run**\n- `FAILED_TO_LOAD_REPRICER_PRODUCT`: the repricer could not load the settings of the product.\n- `NO_REPRICER_PRODUCT_FOUND`: the repricer has no such product for the team.\n- `FAILED_TO_RESOLVE_STRATEGY`: the repricer could not load the strategy.\n- `FAILED_TO_RESOLVE_AMAZON_SELLER_CONTEXT`: the repricer could not find the seller account for the marketplace.\n- `NO_AMAZON_SELLER_AUTHORIZATION_FOUND`: the Amazon account of the seller is not connected.\n- `FAILED_TO_FETCH_SELLER_PRICE_FROM_AMAZON`: Amazon did not give the price of the seller.\n- `REPRICER_PRODUCT_PAUSED`: the product is paused.\n- `NO_SELLER_LISTINGS_FOUND_ON_AMAZON`: Amazon has no listing of the seller for the product.\n- `INACTIVE_SELLER_LISTING`: the listing is inactive.\n- `NO_SELLER_PRICE_FOUND_ON_AMAZON_LISTINGS`: the listing has no usable price.\n- `FAILED_TO_FETCH_COMPETITIVE_PRICING_FROM_AMAZON`: Amazon did not give the market data.\n- `NO_LOWEST_PRICED_OFFERS_FOUND`: the market data has no lowest-priced offers.\n- `NO_COMPETITIVE_PRICE_FOUND`: the market data has no competitive price.\n- `CURRENCY_MISMATCH_BETWEEN_LISTING_AND_MARKET_DATA`: the listing and the market data have different currencies.\n- `FAILED_TO_CALCULATE_TARGET_PRICE`: the strategy could not calculate the target price.\n- `FAILED_TO_SUBMIT_PRICE_TO_AMAZON`: Amazon did not accept the price.", "operationId": "getRepricerProductHistory", "parameters": [ { "name": "asin", "in": "query", "description": "Filter by ASIN", "required": false, "schema": { "type": "string", "example": "B0019MQM64" } }, { "name": "marketplace_id", "in": "query", "description": "Filter by marketplace ID", "required": false, "schema": { "type": "string", "example": "ATVPDKIKX0DER" } }, { "name": "sku", "in": "query", "description": "Filter by SKU", "required": false, "schema": { "type": "string", "example": "Webstaurantstore 14-07-2025 B0019MQM64" } }, { "name": "from_date", "in": "query", "description": "The first day of the history (inclusive). The history keeps 32 days, so an older date starts at the 32-day limit. With from_date or to_date, period has no effect.", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-01-01" } }, { "name": "to_date", "in": "query", "description": "The last day of the history (inclusive, the whole day). With from_date or to_date, period has no effect.", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-07-01" } }, { "name": "period", "in": "query", "description": "A window that ends at the time of the call: 24h, 7d or 30d. from_date and to_date have priority. Without a date and without period, the window is the last 32 days.", "required": false, "schema": { "type": "string", "example": "7d", "enum": [ "24h", "7d", "30d" ] } }, { "name": "status", "in": "query", "description": "Filter by final status.", "required": false, "schema": { "type": "string", "example": "FAILED", "enum": [ "FAILED", "SKIPPED", "PRICE_SKIPPED_OUT_OF_BOUNDS", "PRICE_ALREADY_OPTIMAL", "PRICE_UPDATE_SKIPPED_BY_ALLOW_FLAG", "PRICE_UPDATE_SUBMITTED", "PRICE_UPDATE_CONFIRMED", "DRY_RUN_PRICE_UPDATE_EMULATED" ] } }, { "name": "search", "in": "query", "description": "The start of an ASIN or of a SKU (prefix match, not case sensitive). The wildcards % and _ match themselves.", "required": false, "schema": { "type": "string", "example": "B0019", "maxLength": 100 } }, { "name": "mode", "in": "query", "description": "The mode of the run. `all` gives every mode. `live` also gives the simulated runs.", "required": false, "schema": { "type": "string", "example": "live", "enum": [ "all", "off", "live" ] } }, { "name": "sort", "in": "query", "description": "The column to order by: created_at, status, asin, sku, marketplace_id, old_price, final_price, mode. A minus sign in front of the name orders from the highest down. Without a sort the order is `-created_at`. Another name answers 400.", "required": false, "schema": { "type": "string", "example": "-created_at" } }, { "name": "error_code", "in": "query", "description": "Filter by failure reason code (used with status=FAILED)", "required": false, "schema": { "type": "string", "example": "FAILED_TO_CALCULATE_TARGET_PRICE" } }, { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Number of items per page (default 50, max 200)", "required": false, "schema": { "type": "integer", "example": 50, "maximum": 200, "minimum": 1 } } ], "responses": { "200": { "description": "Successful response. See HistorySearchResponse schema for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistorySearchResponse" } } } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/repricer/history/stats": { "get": { "tags": [ "Repricer (Beta)" ], "summary": "Get history statistics", "description": "Gives the statistics of the repricing runs of the team: the number of runs by type and status, the success rate and the average price change. The history keeps 32 days. A start date before that starts at the 32-day limit.", "operationId": "getRepricerHistoryStats", "parameters": [ { "name": "from_date", "in": "query", "description": "The first day (inclusive). Send it with to_date. A day older than 32 days starts at the 32-day limit.", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-01-01" } }, { "name": "to_date", "in": "query", "description": "The last day (inclusive). Send it with from_date.", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-07-01" } }, { "name": "period", "in": "query", "description": "A calendar window: last_day (today), last_week (this week) or last_month (this month). Without a period the window is this week. from_date and to_date together take the place of the period.", "required": false, "schema": { "type": "string", "example": "last_week" } } ], "responses": { "200": { "description": "Successful response. See HistoryStats schema for details.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/HistoryStats" } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/repricer/info": { "get": { "tags": [ "Repricer (Beta)" ], "summary": "Get repricer overview", "description": "Gives what the repricer does for the team now: the system mode, the default settings, the settings of the team, the settings in effect, the marketplaces the team can reprice and the limits of the plan.\n\nThe mode in effect for a product is the most restrictive of the system mode and the product mode. A product with no mode takes the team mode.\n\n`PATCH /api/v1/sa/repricer/settings` changes the settings of the team.", "operationId": "getRepricerInfo", "responses": { "200": { "description": "Successful response. See RepricerInfo schema for details on each property.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RepricerInfo" } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "500": { "$ref": "#/components/responses/InternalError" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/repricer/settings": { "get": { "tags": [ "Repricer (Beta)" ], "summary": "Get repricer settings", "description": "Gives the settings that the team wrote. A team with no settings gets 404. Then the default settings are in effect, and `GET /api/v1/sa/repricer/info` shows them.\n\n`PATCH /api/v1/sa/repricer/settings` changes the settings.", "operationId": "getRepricerSettings", "responses": { "200": { "description": "Successful response. See RepricerSettings schema for property details.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RepricerSettings" } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "500": { "$ref": "#/components/responses/InternalError" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Repricer (Beta)" ], "summary": "Reset repricer settings", "description": "Deletes the settings of the team. The default settings are then in effect. After this call, `GET /api/v1/sa/repricer/settings` gives 404 until the next `PATCH`. The answer has no body.", "operationId": "resetRepricerSettings", "responses": { "204": { "description": "The settings of the team are gone, and the repricer reads the default settings. The answer carries no body." }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "500": { "$ref": "#/components/responses/InternalError" } }, "security": [ { "api_key": [] } ] }, "patch": { "tags": [ "Repricer (Beta)" ], "summary": "Update repricer settings", "description": "Changes the fields of the body. The other fields keep their values. A team with no settings gets them with this call. The answer is the settings of the team.", "operationId": "updateRepricerSettings", "requestBody": { "description": "Fields for global repricer settings. Only provided fields will be updated. See UpdateRepricerSettings schema for details.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRepricerSettings" } } } }, "responses": { "200": { "description": "Successful response. See RepricerSettings schema for updated values.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RepricerSettings" } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "500": { "$ref": "#/components/responses/InternalError" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/repricer/products": { "get": { "tags": [ "Repricer (Beta)" ], "summary": "List repricer products", "description": "Lists the products of the team that the repricer manages. A product with no `mode` takes the mode of the team.", "operationId": "listRepricerProducts", "parameters": [ { "name": "page", "in": "query", "description": "Page number (default 1)", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Items per page (default 25, max 200)", "required": false, "schema": { "type": "integer", "example": 50 } }, { "name": "reprice_priority", "in": "query", "description": "Keeps the products of one priority.", "required": false, "schema": { "type": "string", "enum": [ "fast", "regular", "paused" ] } }, { "name": "mode", "in": "query", "description": "Keeps the products of one mode.", "required": false, "schema": { "type": "string", "enum": [ "off", "live" ] } }, { "name": "sort", "in": "query", "description": "The column to order by: created_at, asin, sku, marketplace_id, mode, reprice_priority. A minus sign in front of the name orders from the highest down. Without a sort the order is `-created_at`. Another name answers 400.", "required": false, "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "Successful response. See RepricerProductListResponse schema for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepricerProductListResponse" } } } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "500": { "$ref": "#/components/responses/InternalError" } }, "security": [ { "api_key": [] } ] }, "post": { "tags": [ "Repricer (Beta)" ], "summary": "Create repricer products", "description": "Adds products to the repricer. The body is one product, or an array of up to 100 products with no wrapper. A product is the ASIN, the marketplace and the SKU of a listing of the team. The repricer has one product for each ASIN, marketplace and SKU, so a second create of the same key fails.\n\nA create also fails when the plan of the team has no free slot (`GET /api/v1/sa/repricer/info` gives the limits), when the marketplace is not connected, when the limits are not valid (for example `min_price` above `max_price`), or when the strategy is not of the team.", "operationId": "createRepricerProduct", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateRepricerProductForm" }, { "title": "Several products in one call", "type": "array", "items": { "$ref": "#/components/schemas/CreateRepricerProductForm" }, "maxItems": 100 } ] } } } }, "responses": { "201": { "description": "Product created successfully. See RepricerProduct schema for details.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RepricerProduct" } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "500": { "$ref": "#/components/responses/InternalError" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Repricer (Beta)" ], "summary": "Delete repricer products", "description": "The only delete of the repricer products. One call removes one row or a hundred. The body names the rows in one of two ways: `products` names each one by `asin`, `marketplace_id` and `sku`, or `ids` carries the ids the list answers. The answer reports every row, so it is not a 204.", "operationId": "deleteRepricerProducts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "description": "The ids of `GET /api/v1/sa/repricer/products`. They are not the ids of the inventory SKUs.", "type": "array", "items": { "type": "integer", "example": 1 }, "maxItems": 100 } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each row", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "properties": { "succeeded": { "type": "integer", "example": 2 }, "failed": { "type": "integer", "example": 1 } }, "type": "object" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] }, "patch": { "tags": [ "Repricer (Beta)" ], "summary": "Update repricer products", "description": "The only update of the repricer products. One call changes one row or a hundred. The body names the rows with `ids`, the ids the list answers, up to 100 of them. The fields beside the ids reach every named row, and at least one field must be there. `asin`, `marketplace_id` and `sku` are not taken: the ids name the rows already. The answer keeps the order of the rows.", "operationId": "updateRepricerProducts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "allOf": [ { "$ref": "#/components/schemas/UpdateRepricerProductForm" }, { "properties": { "ids": { "description": "The ids of `GET /api/v1/sa/repricer/products`. They are not the ids of the inventory SKUs.", "type": "array", "items": { "type": "integer", "example": 1 }, "maxItems": 100 } }, "type": "object" } ] } } } }, "responses": { "200": { "description": "One result for each row", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "properties": { "succeeded": { "type": "integer", "example": 2 }, "failed": { "type": "integer", "example": 1 } }, "type": "object" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/repricer/products/{id}": { "get": { "tags": [ "Repricer (Beta)" ], "summary": "Get a repricer product", "description": "Gives one repricer product of the team with its strategy, its limits and its mode.", "operationId": "getRepricerProductById", "parameters": [ { "name": "id", "in": "path", "description": "ID of the repricer product.", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful response. See RepricerProduct schema for details.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RepricerProduct" } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "500": { "$ref": "#/components/responses/InternalError" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Repricer (Beta)" ], "summary": "Delete a repricer product", "description": "The path names the row, and the answer carries no body. The product leaves the repricer; the SKU of the inventory stays. `DELETE /api/v1/sa/repricer/products` removes several in one call and answers a result for each id.", "operationId": "deleteRepricerProduct", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "204": { "description": "The row is gone. The answer carries no body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] }, "patch": { "tags": [ "Repricer (Beta)" ], "summary": "Update a repricer product", "description": "The path names the row, and the body carries the fields to change. `PATCH /api/v1/sa/repricer/products` changes several rows in one call and answers a result for each id.", "operationId": "updateRepricerProduct", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRepricerProductForm" } } } }, "responses": { "200": { "description": "The row, as the list answers it", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RepricerProduct" } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/repricer/products/{id}/reprice": { "post": { "tags": [ "Repricer (Beta)" ], "summary": "Reprice a product", "description": "Runs the repricer for one product now and answers the history row of the run.\n\nThe run reads the market data from Amazon, calculates the target price with the strategy and applies the limits. It sends the price to Amazon only when the mode in effect is `live` and the price changes. `GET /api/v1/sa/repricer/history` gives the statuses and the error codes.", "operationId": "repriceSingleProduct", "parameters": [ { "name": "id", "in": "path", "description": "ID of the repricer product", "required": true, "schema": { "type": "integer", "example": 7 } } ], "responses": { "200": { "description": "Reprice completed successfully. See RepricerProductHistoryItem schema for details.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RepricerProductHistoryItem" } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "500": { "$ref": "#/components/responses/InternalError" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/repricer/strategies": { "get": { "tags": [ "Repricer (Beta)" ], "summary": "List strategies", "description": "Lists the strategies of the team. A strategy holds the pricing rule, its parameters and the limits. `POST /api/v1/sa/repricer/strategies/{id}/assign` gives a strategy to products.", "operationId": "listRepricerStrategies", "parameters": [ { "name": "page", "in": "query", "description": "The page to read. It starts at 1.", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "per_page", "in": "query", "description": "The rows a page carries. Without it a page carries 50.", "required": false, "schema": { "type": "integer", "example": 50 } } ], "responses": { "200": { "description": "List of strategies", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RepricerStrategy" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] }, "post": { "tags": [ "Repricer (Beta)" ], "summary": "Create a strategy", "description": "Creates a strategy for the team.", "operationId": "createRepricerStrategy", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name" ], "allOf": [ { "$ref": "#/components/schemas/RepricerStrategyForm" } ] } } } }, "responses": { "201": { "description": "Strategy created", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RepricerStrategy" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Repricer (Beta)" ], "summary": "Delete strategies", "description": "The call names the rows with `ids`. The answer keeps the order of the input, so the caller can match an error to the id it sent. The path with an id removes one row and answers 204.", "operationId": "deleteRepricerStrategies", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "integer", "example": 7 }, "maxItems": 100 } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/repricer/strategies/{id}": { "get": { "tags": [ "Repricer (Beta)" ], "summary": "Get a strategy", "description": "Gives one strategy of the team.", "operationId": "getRepricerStrategyById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Strategy details", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RepricerStrategy" } }, "type": "object" } } } }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Repricer (Beta)" ], "summary": "Delete a strategy", "description": "Deletes the strategy. The products of the strategy lose it, and the repricer sets their mode to `off`.", "operationId": "deleteRepricerStrategyById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Strategy deleted" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] }, "patch": { "tags": [ "Repricer (Beta)" ], "summary": "Update a strategy", "description": "Changes the fields of the body. The other fields keep their values.", "operationId": "updateRepricerStrategyById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepricerStrategyForm" } } } }, "responses": { "200": { "description": "Strategy updated", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/RepricerStrategy" } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/repricer/strategies/{id}/assign": { "post": { "tags": [ "Repricer (Beta)" ], "summary": "Assign a strategy", "description": "Gives this strategy to the repricer products of the body, by their ids. The products then use the rule, the parameters and the limits of the strategy.", "operationId": "assignRepricerStrategy", "parameters": [ { "name": "id", "in": "path", "description": "Strategy ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "scope": { "description": "What the strategy goes on. `asin` writes it on the product, and every SKU of that product follows. `sku` writes an override on one row, and that override wins over the product. A `PATCH` of the row with `strategy_id: null` takes the override away. A call without a scope assigns by ASIN.", "type": "string", "example": "asin", "enum": [ "asin", "sku" ] }, "asins": { "description": "Required when scope is asin. One ASIN in one marketplace is one repricer product.", "type": "array", "items": { "required": [ "asin", "marketplace_id" ], "properties": { "asin": { "type": "string", "example": "B0019MQM64" }, "marketplace_id": { "type": "string", "example": "ATVPDKIKX0DER" } }, "type": "object" } }, "ids": { "description": "Required when scope is sku. The ids of `GET /api/v1/sa/repricer/products`. They are not the ids of `GET /api/v1/sa/inventory/skus`: the two lists hold the same SKU code under different ids, and an id of the inventory list leaves `updated` at 0.", "type": "array", "items": { "type": "integer" }, "example": [ 1, 2, 3 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Products assigned", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "updated": { "description": "How many rows the call reached. A row that already holds this strategy counts too, and a call that reaches no row answers 200 with 0.", "type": "integer", "example": 3 } }, "type": "object" } }, "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" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/seller-spy/sellers": { "get": { "tags": [ "Seller Spy (Beta)" ], "summary": "List tracked sellers", "description": "Gives the sellers that the team tracks. The seller that Seller Assistant added last comes first.", "operationId": "listSellerSpySellers", "parameters": [ { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the tracked sellers", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SellerSpySeller" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "post": { "tags": [ "Seller Spy (Beta)" ], "summary": "Track sellers", "description": "Starts to track the seller of a seller page or a storefront URL. The body is one object or an array of them. Each new seller counts against the plan limit of the tracked sellers, and the team can add at most this limit of sellers on one day. Seller Assistant reads the storefront in the background: `is_processing` is true until the first read ends.", "operationId": "trackSellerSpySellers", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SellerSpyTrackForm" }, { "title": "Several sellers in one call", "type": "array", "items": { "$ref": "#/components/schemas/SellerSpyTrackForm" }, "maxItems": 100 } ] } } } }, "responses": { "201": { "description": "The tracked seller. One object answers this shape.", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/SellerSpySeller" } }, "type": "object" } } } }, "200": { "description": "One result for each element. An array answers this shape. A refused element is null in `data`, and `errors` gives the reason at the same index.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SellerSpySeller" }, { "type": "null" } ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest", "description": "The body is wrong, or the URL names no seller of a supported marketplace." }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "409": { "$ref": "#/components/responses/Conflict", "description": "The team already tracks the seller, or another request of the team adds a seller now. Send the second request again." }, "422": { "$ref": "#/components/responses/BusinessLogicError", "description": "The code `tracked_sellers_limit_reached` says the team tracks as many sellers as the plan allows. The answer gives `limit` and `used`, and on trial also `trial_code`, `trial_message` and `subscribe_url`. The code `tracked_sellers_daily_limit_reached` says the team added the plan limit of sellers today. The code `business_logic_error` says the URL names Amazon itself." }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Seller Spy (Beta)" ], "summary": "Untrack sellers", "description": "The call names the tracked sellers with `ids`. The answer keeps the order of the input, so the caller can match an error to the id it sent.", "operationId": "untrackSellerSpySellers", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "integer", "example": 12 }, "maxItems": 100 } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/seller-spy/sellers/{id}": { "get": { "tags": [ "Seller Spy (Beta)" ], "summary": "Get a tracked seller", "description": "Gives one tracked seller with the insights of its storefront. The first read of a seller starts its AI summary, and `insights.ai_summary` is null until the summary is ready.", "operationId": "getSellerSpySeller", "parameters": [ { "name": "id", "in": "path", "description": "The id of the tracked seller.", "required": true, "schema": { "type": "integer", "example": 12 } } ], "responses": { "200": { "description": "The seller and its insights", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/SellerSpySellerDetails" } }, "type": "object" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Seller Spy (Beta)" ], "summary": "Untrack a seller", "description": "Stops the tracking of the seller for the team, and the answer carries no body. Other teams that track the seller keep it. `DELETE /api/v1/sa/seller-spy/sellers` untracks several sellers in one call and answers a result for each id.", "operationId": "untrackSellerSpySeller", "parameters": [ { "name": "id", "in": "path", "description": "The id of the tracked seller.", "required": true, "schema": { "type": "integer", "example": 12 } } ], "responses": { "204": { "description": "The team does not track the seller now. The answer carries no body." }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/seller-spy/sellers/{id}/products": { "get": { "tags": [ "Seller Spy (Beta)" ], "summary": "List seller products", "description": "Gives the products of the latest storefront snapshot of the seller.", "operationId": "listSellerSpyProducts", "parameters": [ { "name": "id", "in": "path", "description": "The id of the tracked seller.", "required": true, "schema": { "type": "integer", "example": 12 } }, { "name": "search", "in": "query", "description": "Matches a part of the ASIN, the title, the brand or the category. At least 3 characters.", "required": false, "schema": { "type": "string", "maxLength": 255, "minLength": 3 } }, { "name": "filter[brand][eq]", "in": "query", "description": "Keeps the products of one brand. The insights give the values in `brand_options`.", "required": false, "schema": { "type": "string" } }, { "name": "filter[category][eq]", "in": "query", "description": "Keeps the products of one category. The insights give the values in `category_options`.", "required": false, "schema": { "type": "string" } }, { "name": "filter[you_sell][eq]", "in": "query", "description": "True keeps the products that the team sells. False keeps the products that the team does not sell.", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the products", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SellerSpyProduct" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "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" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/seller-spy/sellers/{id}/changes": { "get": { "tags": [ "Seller Spy (Beta)" ], "summary": "List seller changes", "description": "Gives the products that the seller added to the storefront or removed from it. The list compares each stored snapshot of the storefront with the snapshot before it, so the oldest stored snapshot shows no change. For a seller with a very large history, the list covers a shorter recent period.", "operationId": "listSellerSpyChanges", "parameters": [ { "name": "id", "in": "path", "description": "The id of the tracked seller.", "required": true, "schema": { "type": "integer", "example": 12 } }, { "name": "search", "in": "query", "description": "Matches a part of the ASIN, the title, the brand or the category. At least 3 characters.", "required": false, "schema": { "type": "string", "maxLength": 255, "minLength": 3 } }, { "name": "filter[brand][eq]", "in": "query", "description": "Keeps the products of one brand.", "required": false, "schema": { "type": "string" } }, { "name": "filter[category][eq]", "in": "query", "description": "Keeps the products of one category.", "required": false, "schema": { "type": "string" } }, { "name": "filter[you_sell][eq]", "in": "query", "description": "True keeps the products that the team sells. False keeps the products that the team does not sell.", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the changes, with the oldest first", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SellerSpyProduct" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "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" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/seller-spy/sellers/{id}/brands": { "get": { "tags": [ "Seller Spy (Beta)" ], "summary": "List seller brands", "description": "Gives the brands of the storefront of the seller, with the most products first.", "operationId": "listSellerSpyBrands", "parameters": [ { "name": "id", "in": "path", "description": "The id of the tracked seller.", "required": true, "schema": { "type": "integer", "example": 12 } }, { "name": "search", "in": "query", "description": "Matches a part of the brand name. At least 3 characters.", "required": false, "schema": { "type": "string", "maxLength": 255, "minLength": 3 } }, { "name": "filter[is_new][eq]", "in": "query", "description": "True keeps the brands that the seller added in the last 30 days. The filter takes true only.", "required": false, "schema": { "type": "boolean", "enum": [ true ] } }, { "name": "filter[you_carry][eq]", "in": "query", "description": "True keeps the brands that the catalog of the team has. False keeps the other brands.", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the brands", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SellerSpyBrand" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "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" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/seller-spy/overview": { "get": { "tags": [ "Seller Spy (Beta)" ], "summary": "Get the overview", "description": "Gives the counts of all tracked sellers of the team for the last 30 days, the most active sellers and the plan limit of the tracked sellers.", "operationId": "getSellerSpyOverview", "responses": { "200": { "description": "The overview", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/SellerSpyOverview" } }, "type": "object" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/seller-spy/opportunities": { "get": { "tags": [ "Seller Spy (Beta)" ], "summary": "List brand opportunities", "description": "Gives at most 20 brands that the tracked sellers carry and the catalog of the team does not have. The brands of the most sellers come first, then the new brands, then the brands with the most products. The list is empty while Seller Assistant computes it.", "operationId": "listSellerSpyOpportunities", "responses": { "200": { "description": "The brands", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SellerSpyBrandSignal" } } }, "type": "object" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sa/seller-spy/activity": { "get": { "tags": [ "Seller Spy (Beta)" ], "summary": "Get the activity", "description": "Gives the changes of the tracked sellers by day for the last 30 days: at most 50 rows, the newest day first. `hot_brands` gives at most 20 brands that the most tracked sellers carry, the team catalog included or not. The lists are empty while Seller Assistant computes them.", "operationId": "getSellerSpyActivity", "responses": { "200": { "description": "The activity and the hot brands", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "activity": { "type": "array", "items": { "$ref": "#/components/schemas/SellerSpyActivity" } }, "hot_brands": { "type": "array", "items": { "$ref": "#/components/schemas/SellerSpyBrandSignal" } } }, "type": "object" } }, "type": "object" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/tags": { "get": { "tags": [ "Tags (Beta)" ], "summary": "List tags", "description": "A tag belongs to the team and exists once for every tool. The list orders the tags by name unless `sort` says otherwise. The sortable columns are `name`, `id` and `color`.", "operationId": "listTags", "parameters": [ { "name": "sort", "in": "query", "description": "The column to order by: id, name, color. A minus sign in front of the name orders from the highest down. Without a sort the order is `name`. Another name answers 400.", "required": false, "schema": { "type": "string", "example": "name" } }, { "$ref": "#/components/parameters/ApiV1Page" }, { "$ref": "#/components/parameters/ApiV1PerPage" } ], "responses": { "200": { "description": "One page of the tags", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "meta": { "properties": { "pagination": { "$ref": "#/components/schemas/ApiV1Pagination" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "post": { "tags": [ "Tags (Beta)" ], "summary": "Create tags", "description": "A tag name is unique inside the team. The body is one tag or an array of them.", "operationId": "createTag", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TagForm" }, { "title": "Several rows in one call", "type": "array", "items": { "$ref": "#/components/schemas/TagForm" }, "maxItems": 100 } ] } } } }, "responses": { "201": { "description": "The tag", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Tag" } }, "type": "object" } } } }, "200": { "description": "One result for each element. An array answers this shape.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "Tags (Beta)" ], "summary": "Delete tags", "description": "The call names the rows with `ids`. The answer keeps the order of the input, so the caller can match an error to the id it sent. The path with an id removes one row and answers 204.", "operationId": "deleteTags", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "integer", "example": 7 }, "maxItems": 200 } }, "type": "object" } } } }, "responses": { "200": { "description": "One result for each id", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": [ "object", "null" ] } }, "meta": { "$ref": "#/components/schemas/ApiV1BatchMeta" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiV1BatchError" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/tags/{id}": { "delete": { "tags": [ "Tags (Beta)" ], "summary": "Delete a tag", "description": "Removes the tag from all its products, then deletes the tag.", "operationId": "deleteTag", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 3 } } ], "responses": { "204": { "description": "The tag is gone" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "api_key": [] } ] }, "patch": { "tags": [ "Tags (Beta)" ], "summary": "Update a tag", "description": "The call names what it changes. A field it leaves out keeps the value the tag holds. A body that names neither answers 400.", "operationId": "updateTag", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 3 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "description": "A new name, a new colour, or both. A body with neither answers 400.", "properties": { "name": { "description": "One team cannot hold the same name twice.", "type": "string", "example": "winners", "maxLength": 255 }, "color": { "description": "An index of the palette, not a CSS colour.", "type": "integer", "example": 2, "minimum": 0 } }, "type": "object" } } } }, "responses": { "200": { "description": "The tag", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Tag" } }, "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": [] } ] } }, "/api/v1/tags/{id}/products": { "put": { "tags": [ "Tags (Beta)" ], "summary": "Tag products", "description": "Puts the tag on the products of the body. With `remove: true` it takes the tag off. The other products of the tag do not change. A repeated call changes nothing: `changed` counts only the links that the call added or removed.", "operationId": "assignTag", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "example": 3 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "required": [ "asin", "marketplace_id" ], "properties": { "asin": { "type": "string", "example": "B08N5WRWNW" }, "marketplace_id": { "type": "string", "example": "ATVPDKIKX0DER" } }, "type": "object" }, "maxItems": 500 }, "remove": { "description": "True takes the tag off the pairs.", "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "200": { "description": "The count of the links the call changed", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "changed": { "description": "The links this call really added or removed. A product that already carries the tag adds nothing, so a second identical call answers 0.", "type": "integer", "example": 2 }, "removed": { "type": "boolean", "example": false } }, "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": [] } ] } }, "/api/v1/users/me": { "get": { "tags": [ "Account (Beta)" ], "summary": "Get current user", "description": "Get current user info including name, email and tokens left.\n\n`GET /api/v1/me` answers the same data and the rest of the account with it: the team, the plan, the marketplaces and every quota. The answer of this endpoint carries `Deprecation: true` and a `Link` header that names the successor. No `Sunset` header goes out: nobody has set the date on which this endpoint stops.", "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" } } } } }, "deprecated": true, "security": [ { "api_key": [] }, { "oauth2": [ "read_write" ] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] }, "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": [] } ] }, "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": [] } ] }, "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": [] } ] } }, "/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": [] } ] } }, "/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": [] } ] } }, "/api/v1/sp-api/products/pricing/v0/competitivePrice": { "get": { "tags": [ "SP-API Product Pricing" ], "summary": "Get competitive pricing", "description": "Retrieve competitive pricing for up to 20 ASINs or SKUs in a single request. MarketplaceId, itemType and (asins or skus) are required. CustomerType may be Consumer or Business. 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": "getCompetitivePrice", "parameters": [ { "name": "asins", "in": "query", "description": "Comma-separated list of up to 20 Amazon Standard Identification Numbers (ASINs). Provide either asins or skus, but not both. Each ASIN identifies a unique product in the Amazon catalog.", "required": false, "schema": { "type": "string", "example": "B01N5IB20Q,B07PGL2ZSL" }, "example": "B005INDYXY,B0019MQM64,B005INDRKO,B004NEWCL4,B00RWQT0VU,B0056HJ9Q8,B09QFD3MRM,B09T5JC5Z1" }, { "name": "skus", "in": "query", "description": "Comma-separated list of up to 20 seller SKUs (Stock Keeping Units). Provide either asins or skus, but not both. SKUs are your internal product identifiers. When using SKUs, the system will look up their corresponding ASINs in the marketplace.", "required": false, "schema": { "type": "string", "example": "SKU001,SKU002" }, "example": "SKU001,SKU002,INTERNAL-SKU-123" }, { "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": "itemType", "in": "query", "description": "Type of identifiers supplied (required). Must match the identifiers you're providing:\n**Asin** - Use when providing Amazon Standard Identification Numbers (ASINs). ASINs are globally unique product identifiers assigned by Amazon.\n**Sku** - Use when providing your seller SKUs (Stock Keeping Units). Your SKUs will be looked up and converted to ASINs to retrieve pricing.", "required": true, "schema": { "type": "string", "example": "Asin", "enum": [ "Asin", "Sku" ] }, "example": "Asin" }, { "name": "customerType", "in": "query", "description": "Customer type for pricing context (required). Determines whose perspective pricing is retrieved from:\n**Consumer** - Prices for regular retail customers buying from Amazon. This is the default and most common choice. Shows standard marketplace pricing available to consumers.\n**Business** - Prices for business customers buying through Amazon Business. May include different pricing tiers and bulk discounts.", "required": true, "schema": { "type": "string", "example": "Consumer", "enum": [ "Consumer", "Business" ] }, "example": "Consumer" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompetitivePricingResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalError" } }, "security": [ { "api_key": [] } ] } }, "/api/v1/sp-api/batches/products/pricing/2022-05-01/items/competitiveSummary": { "post": { "tags": [ "SP-API Product Pricing" ], "summary": "Get competitive summary for ASINs", "description": "Retrieve competitive summary for up to 20 ASINs in a single batch request. ASIN and MarketplaceId are required. ItemCondition may be New or Used. 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": "getCompetitiveSummary", "requestBody": { "description": "Array of requests with ASIN, marketplace, and data options", "required": true, "content": { "application/json": { "schema": { "properties": { "requests": { "description": "Array of competitive summary requests", "type": "array", "items": { "required": [ "asin", "marketplaceId" ], "properties": { "asin": { "type": "string", "example": "B00ZIAODGE" }, "marketplaceId": { "type": "string", "example": "ATVPDKIKX0DER" }, "includedData": { "type": "array", "items": { "type": "string", "enum": [ "featuredBuyingOptions", "referencePrices", "lowestPricedOffers" ] }, "example": [ "featuredBuyingOptions", "referencePrices", "lowestPricedOffers" ] }, "lowestPricedOffersInputs": { "type": [ "array", "null" ], "items": { "properties": { "itemCondition": { "type": "string", "example": "New" }, "offerType": { "type": "string", "example": "Consumer" } }, "type": "object" } }, "method": { "type": "string", "example": "GET", "enum": [ "GET" ] }, "uri": { "type": "string", "example": "/products/pricing/2022-05-01/items/competitiveSummary" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompetitiveSummaryResponse" } } } }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/AccessDenied" }, "422": { "$ref": "#/components/responses/BusinessLogicError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalError" } }, "security": [ { "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" }, "Document": { "description": "A file that hangs on a purchase order or on a supplier. The file path is not here: a caller reads the file through the download link.", "properties": { "id": { "description": "The id of the document.", "type": "integer", "example": 5 }, "type": { "type": "string", "example": "invoice", "enum": [ "invoice", "confirmation", "credit_memo", "packing_slip", "contract", "authorization_letter", "credit_agreement", "other" ] }, "status": { "type": "string", "example": "parsed", "enum": [ "uploaded", "classifying", "processing", "parsed", "empty", "failed" ] }, "original_name": { "type": "string", "example": "invoice-2026-09.pdf" }, "mime_type": { "type": [ "string", "null" ], "example": "application/pdf" }, "file_size": { "description": "In bytes.", "type": [ "integer", "null" ], "example": 240128 }, "reference_number": { "type": [ "string", "null" ], "example": "INV-4471" }, "notes": { "type": [ "string", "null" ] }, "targets": { "description": "What the document hangs on.", "type": "array", "items": { "properties": { "type": { "type": "string", "enum": [ "purchase_order", "supplier" ] }, "id": { "description": "The id of the purchase order.", "type": "integer", "example": 42 } }, "type": "object" } }, "ai_classified_type": { "description": "What the classifier read. It differs from `type` when a person corrected it.", "type": [ "string", "null" ] }, "ai_confidence": { "type": [ "number", "null" ], "example": 0.94 }, "has_parsed_data": { "type": "boolean", "example": true }, "applied_at": { "type": [ "string", "null" ], "format": "date-time" }, "dismissed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "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" }, "IpAlertSellerProduct": { "description": "A product of the storefront of a tracked seller that is high-risk for IP-Alert. The rule is the rule of `is_high_risk` of GET /api/v1/ip-alerts/products/{asin}: the ASIN or the brand has a warning in the marketplace, or the brand owner asked to add the brand to the high-risk list. The warnings themselves are on GET /api/v1/ip-alerts/products/{asin}.", "properties": { "asin": { "description": "IP-Alert warnings on the public API v1 (DEV-1760).\n\n`isHighRisk` on GET /api/v1/products/{asin} gives the flag only. These calls\ngive the warnings behind the flag, as the High-Risk Product note of the\nextension shows them. The data source is the same.\n\nAll IP-Alert calls live under /api/v1/ip-alerts/: the product, the brand\nand the seller are the ways to ask. The seller call reads the storefront\nof a seller that the team tracks in Seller Spy.\n\nEach call counts as one request of the API request limit, and a trial has\nthe 500 requests of the whole trial. The IP-Alert checks of the extension\ndo not count these calls.", "type": "string", "example": "B08N5WRWNW" }, "title": { "description": "Null until Seller Assistant has the catalog data of the ASIN.", "type": [ "string", "null" ], "example": "Acme Glass Cups with Lids, 4 Pack, 20 oz" }, "brand": { "description": "Null until Seller Assistant has the catalog data of the ASIN. Without a brand, only the warnings of the ASIN count.", "type": [ "string", "null" ], "example": "Acme" }, "asin_warnings": { "description": "The warnings of the ASIN in the marketplace.", "type": "integer", "example": 2 }, "brand_warnings": { "description": "The warnings of the brand in the marketplace, on all of its ASINs. It includes the warnings of this ASIN.", "type": "integer", "example": 14 }, "brand_owner_request": { "description": "True when the brand owner asked Seller Assistant to add the brand to the high-risk list.", "type": "boolean", "example": false }, "warning_types": { "description": "The Seller Assistant types of the warnings of the ASIN and of the brand, each one time.", "type": "array", "items": { "type": "string" }, "example": [ "Suspected Intellectual Property Violation" ] }, "amazon_categories": { "description": "The Amazon categories of the same warnings, each one time.", "type": "array", "items": { "type": "string" }, "example": [ "Automated Brand Protection" ] }, "latest_warning_date": { "description": "The date of the newest warning of the ASIN or of the brand. Null when the brand owner request is the only signal.", "type": [ "string", "null" ], "format": "date", "example": "2026-01-20" } }, "type": "object" }, "IpAlertWarning": { "required": [ "date", "type", "amazon_category", "asin", "brand", "on_this_asin", "reason", "enforcement_code" ], "properties": { "date": { "description": "The date of the warning.", "type": [ "string", "null" ], "format": "date", "example": "2026-01-20" }, "type": { "description": "The warning type of Seller Assistant: Suspected Intellectual Property Violation, Received Intellectual Property Complaint, Product Authenticity Customer Complaint, Product Condition Customer Complaint, Food and Product Safety Issue, Listing Policy Violation, Restricted Product Policy Violation, Customer Product Reviews Policy Violation or Other Policy Violation. Null when Seller Assistant has no type for the Amazon category yet.", "type": [ "string", "null" ], "example": "Suspected Intellectual Property Violation" }, "amazon_category": { "description": "The category of Amazon, for example Automated Brand Protection or Intellectual Property.", "type": [ "string", "null" ], "example": "Automated Brand Protection" }, "asin": { "description": "The ASIN that got the warning.", "type": [ "string", "null" ], "example": "B00U26V4VQ" }, "brand": { "description": "The brand that got the warning.", "type": [ "string", "null" ], "example": "CATAN" }, "on_this_asin": { "description": "True when the warning is on the ASIN of the call. False when it is on another ASIN of the brand. Null on a brand lookup, because that call names no ASIN.", "type": [ "boolean", "null" ], "example": true }, "reason": { "description": "The reason of Amazon.", "type": [ "string", "null" ], "example": "Suspected Intellectual Property Trademark Reason" }, "enforcement_code": { "description": "The enforcement code of Amazon.", "type": [ "string", "null" ], "example": "ABP: Abp. Trademark Text Asin Suppression Self Reinstate" } }, "type": "object" }, "IpAlertReport": { "required": [ "asin", "brand", "marketplace_id", "is_high_risk", "asin_warnings", "brand_warnings", "brand_owner_request" ], "properties": { "asin": { "description": "The ASIN of the call. Null on a brand lookup.", "type": [ "string", "null" ], "example": "B00U26V4VQ" }, "brand": { "description": "The brand that the call reads. Null when Seller Assistant does not know the brand of the ASIN. Then `brand_warnings` is empty. Send `brand` to read the warnings of the brand.", "type": [ "string", "null" ], "example": "CATAN" }, "marketplace_id": { "type": "string", "example": "ATVPDKIKX0DER" }, "is_high_risk": { "description": "True when a list has a warning or the brand owner asked to add the brand. The rule of `isHighRisk` of GET /api/v1/products/{asin} is the same.", "type": "boolean", "example": true }, "asin_warnings": { "description": "The 10 newest warnings of the ASIN, the newest first. Empty on a brand lookup.", "type": "array", "items": { "$ref": "#/components/schemas/IpAlertWarning" } }, "brand_warnings": { "description": "The 10 newest warnings of the brand on all of its ASINs, the newest first. A warning on the ASIN of the call can also be in `asin_warnings`.", "type": "array", "items": { "$ref": "#/components/schemas/IpAlertWarning" } }, "brand_owner_request": { "description": "The brand owner asked Seller Assistant to add the brand to the high-risk list. Null when there is no such request.", "required": [ "brand", "added_at" ], "properties": { "brand": { "type": "string", "example": "CATAN" }, "added_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2025-03-14T09:30:00Z" } }, "type": [ "object", "null" ] } }, "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" }, "Quota": { "description": "What one tool allows, and what is left of it.", "properties": { "limit": { "description": "The caller, the team, the plan and the limits.\n\n`GET /v1/me` answers the whole account in one call: who the token belongs\nto, which team it acts for, what the team pays for, which Amazon\nmarketplaces it connected, what is left of every quota, and which tools are\nup.\n\n`GET /v1/users/me` stays, and answers a part of the same data in the older\nshape. AccountContextService holds the data, so this answer and the one of\nthe MCP server agree.", "type": "integer", "example": 1000 }, "count": { "type": "integer", "example": 445 }, "left": { "type": "integer", "example": 555 }, "refill_at": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object" }, "FeatureFlag": { "description": "Whether a tool is up, and whether it accepts a write.", "properties": { "enabled": { "type": "boolean", "example": true }, "writable": { "type": "boolean", "example": true } }, "type": "object" }, "Note": { "properties": { "id": { "description": "Notes on the public API v1.\n\nOne resource over the two stores the application has. ApiNoteGateway reads\n`target_type` and sends the call to `entity_notes` or to `product_notes`.", "type": "integer", "example": 7 }, "target_type": { "type": "string", "example": "asin", "enum": [ "asin", "supplier", "purchase_order", "warehouse", "price_list" ] }, "target_id": { "description": "For the type `asin` the id is `/`.", "type": "string", "example": "ATVPDKIKX0DER/B08N5WRWNW" }, "note": { "type": "string", "example": "check the box count" }, "user_id": { "description": "Who wrote the note.", "type": [ "integer", "null" ], "example": 42 }, "user_name": { "description": "The name of that person. The list carries it, and a write answers without it.", "type": [ "string", "null" ], "example": "John Doe" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object" }, "NoteForm": { "required": [ "target_type", "target_id", "note" ], "properties": { "target_type": { "type": "string", "example": "asin", "enum": [ "asin", "supplier", "purchase_order", "warehouse", "price_list" ] }, "target_id": { "description": "For the type asin the id carries the marketplace too, in the form marketplace_id/asin.", "type": "string", "example": "ATVPDKIKX0DER/B08N5WRWNW", "maxLength": 100 }, "note": { "type": "string", "example": "check the box count", "maxLength": 10000 } }, "type": "object" }, "PriceListAnalyzerUploadResponse": { "required": [ "id", "status" ], "properties": { "id": { "description": "The created price list id", "type": "integer", "example": 123 }, "status": { "description": "Initial status of the price list", "type": "string", "example": "Created" } }, "type": "object" }, "PriceListAnalyzerJsonItem": { "required": [ "identifier", "cog" ], "properties": { "identifier": { "description": "UPC, EAN or ASIN identifier", "type": "string", "example": "012345678905" }, "cog": { "description": "Cost of goods", "type": "number", "format": "float", "example": 9.99 }, "title": { "description": "Product title", "type": [ "string", "null" ], "example": "Sample Product" }, "supplier_sku": { "type": [ "string", "null" ], "example": "SUP-123" }, "price_type": { "description": "Whether cog is priced per unit or per case. Defaults to each.", "type": [ "string", "null" ], "example": "each", "enum": [ "each", "case" ] }, "supplier_case_quantity": { "description": "Units per case. Required when price_type is case.", "type": [ "number", "null" ], "example": 12 } }, "type": "object" }, "PriceListAnalyzerStatusResponse": { "required": [ "id", "status", "processed_count", "total_count", "started_at" ], "properties": { "id": { "type": "integer", "example": 123 }, "status": { "type": "string", "example": "Processing" }, "processed_count": { "description": "Number of identifiers processed so far", "type": "integer", "example": 42 }, "total_count": { "description": "Total number of identifiers to process", "type": "integer", "example": 100 }, "started_at": { "type": "string", "format": "date-time", "example": "2025-12-22T10:00:00+00:00" } }, "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. Null when the estimate is not available.", "type": [ "integer", "null" ], "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 }, "hazmatStatus": { "description": "Cached classification: 0 standard, 1 hazardous, 2 review pending.", "type": [ "integer", "null" ], "enum": [ 0, 1, 2 ] }, "hazmatPending": { "description": "A classification refresh is pending.", "type": "boolean" }, "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", "amazonFeesAvailable", "fbaFee", "variableClosingFee", "referralFee", "referralFeeRate", "storageFee" ], "properties": { "currency": { "$ref": "#/components/schemas/Currency", "description": "Currency information for the prices" }, "amazonFeesAvailable": { "description": "True when Amazon returned the FBA fee and the referral fee. When false, one or more of `fbaFee`, `variableClosingFee`, `referralFee` and `referralFeeRate` are null because the data is not available. Send the request again later.", "type": "boolean", "example": true }, "fbaFee": { "description": "FBA fee in the standard unit of the currency. Null when Amazon returned no FBA fee", "type": [ "string", "null" ], "format": "decimal", "example": "6.62" }, "variableClosingFee": { "description": "Variable closing fee in the standard unit of the currency. Null when Amazon returned no closing fee", "type": [ "string", "null" ], "format": "decimal", "example": "0.00" }, "referralFee": { "description": "Referral fee in the standard unit of the currency. Null when Amazon returned no referral fee", "type": [ "string", "null" ], "format": "decimal", "example": "6.60" }, "referralFeeRate": { "description": "Referral fee rate (e.g., 0.15 means 15%). Null when Amazon returned no referral fee", "type": [ "number", "null" ], "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. Without `priceType`, `caseQuantity` and `packageQuantity`, the calculation takes `cog` as the cost of one listing, as before. With any of them, `cog` is the price of one item (`priceType` `each`) or of one case (`priceType` `case`), and the calculation multiplies the cost of one item by the package quantity.", "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 }, "seasonMode": { "description": "Storage fee season. `auto` uses the season for the current date, `peak` uses the October-December rate, and `off_peak` uses the January-September rate.", "type": "string", "example": "off_peak", "default": "auto", "enum": [ "auto", "peak", "off_peak" ] }, "priceType": { "description": "The unit of `cog`: the price of one item (`each`) or of one case (`case`). Defaults to `each`.", "type": [ "string", "null" ], "example": "case", "enum": [ "each", "case" ] }, "caseQuantity": { "description": "The items in one case. Required when `priceType` is `case`. The cost of one item is `cog` / `caseQuantity`.", "type": [ "integer", "null" ], "example": 12, "maximum": 99999, "minimum": 1 }, "packageQuantity": { "description": "The items in one Amazon listing (package quantity, PQ): 2 for a 2-pack. If you leave it out, the PQ comes from your Products DB, else from the Amazon catalog, else it is 1. See `cogSteps.packageQuantitySource`.", "type": [ "integer", "null" ], "example": 2, "maximum": 99999, "minimum": 1 } }, "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" }, "cogSteps": { "description": "How the cost of one listing comes from `cog`: `listingCost` = `unitCost` x `packageQuantity`.", "required": [ "enteredCost", "priceType", "unitCost", "packageQuantity", "packageQuantitySource", "listingCost" ], "properties": { "enteredCost": { "description": "The `cog` of the request.", "type": "string", "format": "decimal", "example": "12.00" }, "priceType": { "description": "The unit of `enteredCost`.", "type": "string", "example": "case", "enum": [ "each", "case" ] }, "caseQuantity": { "description": "The items in one case. Null for `each`.", "type": [ "integer", "null" ], "example": 12 }, "unitCost": { "description": "The cost of one item, with 4 decimals.", "type": "string", "format": "decimal", "example": "1.0000" }, "packageQuantity": { "description": "The package quantity (PQ) that the calculation used.", "type": "integer", "example": 2 }, "packageQuantitySource": { "description": "Where the PQ came from. `not_applied`: the request has no `priceType`, `caseQuantity` or `packageQuantity`, so the calculation used PQ 1 as before. `productsDbPackageQuantity` and `amazonPackageQuantity` then show the PQ of the product.", "type": "string", "example": "products_db", "enum": [ "request", "products_db", "amazon", "default", "not_applied" ] }, "productsDbPackageQuantity": { "description": "The PQ in your Products DB. Null when the product is not in it.", "type": [ "integer", "null" ], "example": 2 }, "amazonPackageQuantity": { "description": "The PQ in the Amazon catalog. Null when Amazon does not give it.", "type": [ "integer", "null" ], "example": 2 }, "listingCost": { "description": "The cost of one listing. `calculations.fba.cog` and `calculations.fbm.cog` show the same value.", "type": "string", "format": "decimal", "example": "2.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, ASIN_NOT_FOUND", "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": "A product of the inventory of the team.", "properties": { "id": { "type": "string", "example": "P-5XK1S0NQNO" }, "title": { "type": [ "string", "null" ], "example": "Catan Board Game" }, "brand": { "type": [ "string", "null" ], "example": "Catan" }, "image_url": { "type": [ "string", "null" ], "example": "https://m.media-amazon.com/images/I/51N-u8AsmdL.jpg" }, "package_quantity": { "description": "The units in one pack that Amazon sells (Amazon Pack Qty).", "type": [ "integer", "null" ], "example": 2 }, "default_supplier_id": { "type": [ "integer", "null" ], "example": 10 }, "total_stock": { "description": "Read only. The sum of the stock of the active linked SKUs. Null when the product has no active linked SKU. A body that sends it gets 400.", "type": [ "integer", "null" ], "example": 12 }, "tags": { "description": "The ids of the tags.", "type": "array", "items": { "type": "integer" }, "example": [ 3 ] }, "matches": { "description": "The identifiers of the product on the platforms.", "type": "array", "items": { "$ref": "#/components/schemas/ProductMatchItem" } }, "created_at": { "type": "string", "format": "date-time", "example": "2026-05-16T15:09:58Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-05-16T15:09:58Z" } }, "type": "object" }, "ProductMatch": { "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", "example": "P-5XK1S0NQNO", "maxLength": 20 }, "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": [] }, "source": { "description": "Where the identifier came from", "type": [ "string", "null" ], "example": "Product DB" }, "created_at": { "description": "Creation timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T10:00:00Z" }, "updated_at": { "description": "Last update timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T12:30:00Z" } }, "type": "object" }, "ProductMatchItem": { "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" }, "InternalProductForm": { "description": "The fields of one product. The create takes one of these, or an array of them.", "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" }, "package_quantity": { "description": "The units in one pack that Amazon sells (Amazon Pack Qty).", "type": [ "integer", "null" ], "example": 2, "maximum": 99999, "minimum": 1 }, "default_supplier_id": { "type": [ "integer", "null" ], "example": 1 }, "matches": { "description": "The identifiers of the product on the platforms it sells on.", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ProductMatchItem" } } }, "type": "object" }, "ListingForm": { "description": "One listing draft. The body of the create is one of them or an array of them, with no wrapper around it.", "required": [ "channel", "marketplace_id", "seller_id", "sku", "price", "currency" ], "properties": { "channel": { "description": "Listings on the public API v1.\n\nThis controller does not call the channel. It reads, creates the local draft\nrow and deletes a row the channel never saw. Publishing to Amazon, and the\ndelete of a published listing, need the channel and come in a later step.", "type": "string", "enum": [ "amazon", "walmart", "shopify", "ebay" ] }, "marketplace_id": { "type": "string", "example": "ATVPDKIKX0DER", "maxLength": 50 }, "seller_id": { "type": "string", "example": "A1B2C3D4E5", "maxLength": 100 }, "sku": { "type": "string", "example": "WS-2026-B0019MQM64", "maxLength": 40 }, "identifier": { "type": [ "string", "null" ], "example": "B0019MQM64", "maxLength": 50 }, "price": { "type": "number", "example": 24.99, "minimum": 0 }, "currency": { "type": "string", "example": "USD", "maxLength": 10 }, "condition": { "type": [ "string", "null" ], "enum": [ "new", "used_like_new", "used", "refurbished" ] }, "fulfillment_type": { "type": [ "string", "null" ], "enum": [ "fba", "fbm", "wfs", "seller" ] }, "channel_data": { "description": "Data of the channel that the draft keeps as it came.", "type": [ "object", "null" ] } }, "type": "object" }, "Listing": { "description": "The live state of one SKU on one channel.", "properties": { "id": { "type": "integer", "example": 91 }, "team_id": { "type": "integer", "example": 123 }, "sku_id": { "type": [ "integer", "null" ], "example": 812 }, "channel": { "type": "string", "example": "amazon", "enum": [ "amazon", "walmart", "shopify", "ebay" ] }, "marketplace_id": { "type": [ "string", "null" ], "example": "ATVPDKIKX0DER" }, "seller_id": { "type": [ "string", "null" ] }, "sku": { "type": "string", "example": "WS-2026-B0019MQM64" }, "identifier": { "type": [ "string", "null" ], "example": "B0019MQM64" }, "price": { "type": [ "number", "null" ], "example": 24.99 }, "currency": { "type": [ "string", "null" ], "example": "USD" }, "condition": { "type": [ "string", "null" ], "example": "new" }, "fulfillment_type": { "type": [ "string", "null" ], "example": "fba" }, "status": { "type": "string", "example": "draft" }, "error_message": { "type": [ "string", "null" ] }, "channel_data": { "type": [ "object", "null" ] }, "listed_at": { "type": [ "string", "null" ], "format": "date-time" }, "batch_id": { "description": "The batch the draft was made in.", "type": [ "string", "null" ] }, "sku_record": { "description": "The SKU the listing sells, and the product behind it. The list and the read of one listing carry it; a draft the call has just written does not.", "properties": { "id": { "type": "integer", "example": 2395 }, "sku": { "type": [ "string", "null" ], "example": "SA-5XLB-G2YZ" }, "asin": { "type": [ "string", "null" ], "example": "B0012RR7SS" }, "fnsku": { "type": [ "string", "null" ], "example": "X0055JLULF" }, "internal_product_id": { "type": [ "string", "null" ], "example": "P-XE83ALLW04" }, "product_title": { "type": [ "string", "null" ] }, "product_image_url": { "type": [ "string", "null" ] }, "internal_product": { "properties": { "id": { "type": "string", "example": "P-XE83ALLW04" }, "title": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object" }, "PurchaseOrder": { "description": "What the team bought from one supplier. A purchase order has no team of its own: the supplier carries it.", "properties": { "id": { "description": "The id of the purchase order.", "type": "integer", "example": 42 }, "po_id": { "description": "The name a person gave the order.", "type": [ "string", "null" ], "example": "PO-2026-018" }, "status": { "type": [ "string", "null" ], "example": "draft" }, "supplier_id": { "type": "integer", "example": 5 }, "marketplace_id": { "type": [ "string", "null" ], "example": "ATVPDKIKX0DER" }, "prep_center_id": { "description": "The warehouse the goods go to.", "type": [ "integer", "null" ], "example": 3 }, "user_id": { "type": [ "integer", "null" ] }, "order_date": { "type": [ "string", "null" ], "format": "date", "example": "2026-09-14" }, "currency": { "description": "The currency of the supplier.", "type": [ "string", "null" ], "example": "USD" }, "items_count": { "type": "integer", "example": 12 }, "subtotal": { "description": "The sum of the items. Null means not known, which is not the same as zero.", "type": [ "number", "null" ], "format": "float", "example": 1240 }, "shipping_cost": { "type": [ "number", "null" ], "format": "float" }, "taxes": { "type": [ "number", "null" ], "format": "float" }, "misc_expenses": { "type": [ "number", "null" ], "format": "float" }, "total_price": { "type": [ "number", "null" ], "format": "float", "example": 1380.5 }, "estimated_revenue": { "type": [ "number", "null" ], "format": "float" }, "estimated_profit": { "type": [ "number", "null" ], "format": "float" }, "supplier": { "description": "The supplier of the order. Every answer of the v1 carries it.", "properties": { "id": { "description": "The id of the document.", "type": "integer", "example": 5 }, "name": { "type": "string", "example": "Acme Wholesale" }, "currency": { "type": [ "string", "null" ], "example": "USD" } }, "type": "object" }, "items": { "description": "The items of the order. It is present only with `include=items`, and it carries the first 100 items, by id. `items_count` reports the real number, and `/purchase-orders/{id}/items` serves them all as a page.", "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderItem" } }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object" }, "PurchaseOrderCreateForm": { "description": "A new order is a draft of one supplier. The create reads the supplier alone; the other fields of the order go with the PATCH.", "required": [ "supplier_id" ], "properties": { "supplier_id": { "type": "integer", "example": 5, "minimum": 1 } }, "type": "object" }, "PurchaseOrderForm": { "description": "The update sends only the fields it changes. The supplier and the marketplace of an order do not change.", "properties": { "po_id": { "type": "string", "example": "PO-2026-018", "maxLength": 80 }, "status": { "type": "string", "example": "draft", "enum": [ "draft", "sent", "completed", "cancelled" ] }, "prep_center_id": { "description": "The warehouse. It cannot change while a shipment is linked to the order.", "type": [ "integer", "null" ], "example": 3 }, "order_date": { "type": [ "string", "null" ], "format": "date", "example": "2026-09-14" }, "shipping_cost": { "type": [ "number", "null" ], "maximum": 99999.99, "minimum": 0 }, "taxes": { "type": [ "number", "null" ], "maximum": 99999.99, "minimum": 0 }, "misc_expenses": { "description": "A negative value is a credit or a discount from the supplier. It lowers the total and the cost of each unit.", "type": [ "number", "null" ], "maximum": 99999.99, "minimum": -99999.99 }, "user_id": { "description": "The member of the team who owns the order. A user of another team answers 400.", "type": "integer", "example": 12 } }, "type": "object" }, "PurchaseOrderItemForm": { "description": "One line to add. A line names the product by internal_product_id, or by the identifiers the order can match.", "properties": { "internal_product_id": { "description": "The inventory product the line points at. The call answers 404 when the product is not of the team.", "type": [ "string", "null" ], "example": "P-5XK1S0NQNO", "maxLength": 255 }, "asin": { "type": [ "string", "null" ], "example": "B0019MQM64", "maxLength": 255 }, "upc": { "type": [ "string", "null" ], "maxLength": 5000 }, "ean": { "type": [ "string", "null" ], "maxLength": 5000 }, "identifier": { "description": "The key the order matches a line by first. A line whose identifier the order holds adds to that line.", "type": [ "string", "null" ], "maxLength": 255 }, "sku": { "type": [ "string", "null" ], "maxLength": 255 }, "supplier_sku": { "description": "The code of the product at the supplier.", "type": [ "string", "null" ], "maxLength": 255 }, "title": { "type": [ "string", "null" ], "maxLength": 255 }, "brand": { "type": [ "string", "null" ], "maxLength": 255 }, "image_url": { "type": [ "string", "null" ], "maxLength": 255 }, "unit_cost": { "type": [ "number", "null" ], "example": 9.5, "maximum": 99999.99, "minimum": 0 }, "unit_count": { "description": "A line with no count takes 1.", "type": [ "integer", "null" ], "example": 12, "minimum": 1 } }, "type": "object" }, "PurchaseOrderItem": { "description": "One line of a purchase order.", "properties": { "id": { "type": "integer", "example": 4471 }, "purchase_order_id": { "type": "integer", "example": 42 }, "internal_product_id": { "description": "The inventory product the line points at. It is the same id the matches and the history of a product use.", "type": [ "string", "null" ], "example": "P-5XK1S0NQNO" }, "title": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "asin": { "type": [ "string", "null" ], "example": "B0019MQM64" }, "upc": { "type": [ "string", "null" ] }, "ean": { "type": [ "string", "null" ] }, "sku": { "type": [ "string", "null" ] }, "identifier": { "type": [ "string", "null" ] }, "unit_cost": { "description": "Null means not known, which is not the same as zero.", "type": [ "number", "null" ], "format": "float", "example": 9.5 }, "unit_count": { "type": "integer", "example": 12 }, "total_cost": { "type": [ "number", "null" ], "format": "float", "example": 114 }, "selling_price": { "type": [ "number", "null" ], "format": "float" }, "profit_fba": { "type": [ "number", "null" ], "format": "float" }, "profit_marketplace_id": { "type": [ "string", "null" ] }, "profit_calculated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object" }, "Sku": { "description": "What the team sells on one channel: the identity, the costs and the stock.", "properties": { "id": { "description": "SKUs on the public API v1.\n\nThere is no create endpoint. A SKU comes from the channel sync, so the API\nreads, updates the costs, and deletes.", "type": "integer", "example": 812 }, "team_id": { "type": "integer", "example": 123 }, "channel": { "type": "string", "example": "amazon" }, "marketplace_id": { "type": [ "string", "null" ], "example": "ATVPDKIKX0DER" }, "seller_id": { "type": [ "string", "null" ], "example": "A1B2C3D4E5" }, "sku": { "type": "string", "example": "WS-2026-B0019MQM64" }, "asin": { "type": [ "string", "null" ], "example": "B0019MQM64" }, "fnsku": { "type": [ "string", "null" ] }, "internal_product_id": { "type": [ "string", "null" ], "example": "P-5XK1S0NQNO" }, "purchase_order_item_id": { "description": "The purchase order line the costs come from.", "type": [ "integer", "null" ], "example": 4471 }, "status": { "type": "string", "example": "active" }, "condition": { "type": "string", "example": "new" }, "fulfillment_channel": { "description": "Who ships the orders of the SKU: Amazon (FBA) or the seller (FBM). `null` means that the channel is not known. The Repricer then uses the FBA formula.", "type": [ "string", "null" ], "example": "FBA", "enum": [ "FBA", "FBM" ] }, "unit_cost": { "description": "Product cost of one listing (pack), not of one unit. For a 2-pack, the cost of 2 units.", "type": [ "number", "null" ], "example": 9.5 }, "allocated_po_expenses": { "description": "Share of the purchase order expenses carried by one listing (pack).", "type": [ "number", "null" ] }, "prep_cost": { "description": "Prep cost of one listing (pack).", "type": [ "number", "null" ] }, "fba_inbound_cost": { "description": "Cost to send one listing (pack) to an Amazon warehouse.", "type": [ "number", "null" ] }, "landed_cost": { "description": "Every cost of one listing (pack), added up.", "type": [ "number", "null" ] }, "cost_overrides": { "description": "The costs a person set by hand. They win over the ones the purchase order gives.", "type": [ "object", "null" ] }, "cost_source": { "description": "Where the costs come from.", "type": "string", "enum": [ "po_linked", "po_wac", "override", "none" ] }, "stock_quantity": { "type": [ "integer", "null" ] }, "stock_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "sold_in_unconnected_marketplace": { "description": "The SKU sells in a marketplace the seller has not connected, so its data stays behind until the seller connects it.", "type": "boolean", "example": false }, "linked_purchase_order": { "description": "The purchase order the cost comes from. The key is there only when an order item gives the cost.", "properties": { "id": { "type": [ "integer", "null" ], "example": 42 }, "name": { "type": [ "string", "null" ], "example": "PO-2026-018" } }, "type": [ "object", "null" ] }, "internal_product": { "description": "The inventory product of the SKU. When the product is gone, the object keeps the title and the image the SKU recorded, with `deleted: true`.", "properties": { "title": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "deleted": { "type": "boolean", "example": true } }, "type": [ "object", "null" ] }, "listing": { "oneOf": [ { "$ref": "#/components/schemas/Listing", "description": "The listing of the SKU. The key is there only when the call reads the listing." }, { "type": "null" } ], "description": "The listing of the SKU. The key is there only when the call reads the listing." } }, "type": "object" }, "SupplierOffer": { "description": "What one supplier charges for one product. A product has one offer of each supplier.", "properties": { "id": { "type": "integer", "example": 352 }, "internal_product_id": { "description": "The id of the inventory product.", "type": "string", "example": "P-5XK1S0NQNO" }, "supplier_id": { "type": "integer", "example": 10 }, "sku": { "description": "The SKU of the supplier.", "type": [ "string", "null" ], "example": "SUP-123" }, "cog": { "description": "The cost of goods, in the unit that `price_type` names.", "type": [ "number", "null" ], "example": 12.34 }, "price_type": { "description": "`each`: `cog` is the price of one unit. `case`: `cog` is the price of one case.", "type": [ "string", "null" ], "example": "case", "enum": [ "each", "case" ] }, "case_quantity": { "description": "The sellable units in one case. It is required when `price_type` is `case`.", "type": [ "integer", "null" ], "example": 12 }, "cog_per_unit": { "description": "Read only. The cost of one unit: `cog`, or `cog` ÷ `case_quantity` for a case, rounded to 2 decimals.", "type": [ "number", "null" ], "example": 1.03 }, "product_link": { "description": "The page of the product on the site of the supplier.", "type": [ "string", "null" ], "example": "https://supplier.com/item/123" }, "supplier_product_title": { "type": [ "string", "null" ], "example": "Catan Board Game" }, "supplier_product_code": { "description": "A barcode or another code of the supplier.", "type": [ "string", "null" ], "example": "029877030712" }, "supplier_product_code_type": { "type": [ "string", "null" ], "example": "upc" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-05-16T15:09:58Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-05-16T15:09:58Z" } }, "type": "object" }, "SupplierOfferFields": { "properties": { "sku": { "type": [ "string", "null" ], "example": "SUP-123" }, "cog": { "type": [ "number", "null" ], "example": 12.34 }, "price_type": { "type": [ "string", "null" ], "example": "case", "enum": [ "each", "case" ] }, "case_quantity": { "description": "Required when `price_type` is `case`.", "type": [ "integer", "null" ], "example": 12 }, "product_link": { "type": [ "string", "null" ], "example": "https://supplier.com/item/123" }, "supplier_product_title": { "type": [ "string", "null" ], "example": "Catan Board Game" }, "supplier_product_code": { "type": [ "string", "null" ], "example": "029877030712" }, "supplier_product_code_type": { "type": [ "string", "null" ], "example": "upc" } }, "type": "object" }, "SupplierOfferCreate": { "required": [ "internal_product_id", "supplier_id" ], "properties": { "internal_product_id": { "type": "string", "example": "P-5XK1S0NQNO" }, "supplier_id": { "type": "integer", "example": 10 }, "sku": { "type": [ "string", "null" ], "example": "SUP-123" }, "cog": { "type": [ "number", "null" ], "example": 12.34 }, "price_type": { "type": [ "string", "null" ], "example": "case", "enum": [ "each", "case" ] }, "case_quantity": { "description": "Required when `price_type` is `case`.", "type": [ "integer", "null" ], "example": 12 }, "product_link": { "type": [ "string", "null" ], "example": "https://supplier.com/item/123" }, "supplier_product_title": { "type": [ "string", "null" ], "example": "Catan Board Game" }, "supplier_product_code": { "type": [ "string", "null" ], "example": "029877030712" }, "supplier_product_code_type": { "type": [ "string", "null" ], "example": "upc" } }, "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: New, Contacted, Approved, Rejected, Negotiation, No response, Active, On hold", "type": [ "string", "null" ], "example": "New" }, "type": { "description": "Supplier type: Distributor, Manufacturer, Brand, Wholesaler", "type": [ "string", "null" ], "example": "Distributor" }, "payment_method": { "description": "Payment methods: Credit card, ACH, Wire transfer", "type": "array", "items": { "type": "string" }, "example": [ "Credit card", "ACH" ] }, "payment_terms": { "description": "Payment terms: Net 15, Net 30, Net 45, Net 60, COD, Prepaid", "type": [ "string", "null" ], "example": "Net 30" }, "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" }, "mov": { "description": "Minimum order value", "type": [ "number", "null" ], "example": 5000.75 }, "free_shipping_ov": { "description": "Order value that makes the shipping free", "type": [ "number", "null" ], "example": 150 }, "sold_by_case": { "description": "The supplier sells by the case", "type": "boolean", "example": false }, "lead_time_min": { "description": "Minimum lead time in days", "type": [ "integer", "null" ], "example": 3 }, "lead_time_max": { "description": "Maximum lead time in days", "type": [ "integer", "null" ], "example": 10 }, "created_at": { "description": "Creation timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T10:00:00Z" }, "updated_at": { "description": "Last update timestamp", "type": "string", "format": "date-time", "example": "2025-12-22T12:30:00Z" } }, "type": "object" }, "CreateSupplierForm": { "description": "Payload to create a supplier. The name and the website are the two the call cannot leave out, and the website must be one no other supplier of the team holds.", "required": [ "name", "website" ], "properties": { "name": { "type": "string", "example": "Acme Wholesalers" }, "website": { "type": "string", "example": "acme.com", "maxLength": 255 }, "payment_terms": { "description": "The label the read answers.", "type": [ "string", "null" ], "example": "Net 30", "enum": [ "Not selected", "Net 15", "Net 30", "Net 45", "Net 60", "COD", "Prepaid" ] }, "contacts": { "type": [ "string", "null" ], "example": "contact@acme.com" }, "status": { "description": "The label the read answers.", "type": "string", "example": "New", "enum": [ "New", "Contacted", "No response", "Negotiation", "Approved", "Active", "On hold", "Rejected" ] }, "warehouse_id": { "type": [ "integer", "null" ], "example": null }, "responsible_user_id": { "type": [ "integer", "null" ], "example": 4 }, "type": { "description": "The label the read answers.", "type": [ "string", "null" ], "example": "Distributor", "enum": [ "Not selected", "Distributor", "Manufacturer", "Brand", "Wholesaler" ] }, "address": { "type": [ "string", "null" ], "example": "123 Main St" }, "currency": { "type": [ "string", "null" ], "example": "USD" }, "phone": { "type": [ "string", "null" ], "example": "+1234567890" }, "country": { "description": "The country of the supplier. The call does not store it: it picks the currency when `currency` is left out. The name of the country reads best, for example `Germany`; an unknown one gives USD.", "type": [ "string", "null" ], "example": "Germany", "maxLength": 100 }, "source": { "description": "The screen or the tool the create came from, for the analytics. The call does not store it.", "type": [ "string", "null" ], "example": "api" } }, "type": "object" }, "UpdateSupplierForm": { "description": "Payload to update supplier fields", "properties": { "name": { "type": "string", "example": "Updated Name", "maxLength": 255 }, "website": { "description": "The website must be one no other supplier of the team holds.", "type": "string", "example": "updated.com", "maxLength": 255 }, "payment_terms": { "description": "The label the read answers.", "type": [ "string", "null" ], "example": "Net 45", "enum": [ "Not selected", "Net 15", "Net 30", "Net 45", "Net 60", "COD", "Prepaid" ] }, "contacts": { "type": [ "string", "null" ], "example": "new@contact.com" }, "status": { "description": "The label the read answers.", "type": "string", "example": "Contacted", "enum": [ "New", "Contacted", "No response", "Negotiation", "Approved", "Active", "On hold", "Rejected" ] }, "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": { "description": "The label the read answers.", "type": [ "string", "null" ], "example": "Manufacturer", "enum": [ "Not selected", "Distributor", "Manufacturer", "Brand", "Wholesaler" ] }, "payment_method": { "description": "The labels the read answers.", "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "Credit card", "ACH", "Wire transfer" ] }, "example": [ "Credit card", "ACH" ] } }, "type": "object" }, "WarehouseForm": { "description": "The create needs `name` and `website`. The update sends only the fields it changes.", "properties": { "name": { "description": "The name of the warehouse.", "type": "string", "example": "East Coast Prep", "maxLength": 255 }, "website": { "description": "Unique inside the team.", "type": "string", "example": "eastcoastprep.com", "maxLength": 255 }, "location": { "type": [ "string", "null" ] }, "contacts": { "type": [ "string", "null" ] }, "config": { "type": [ "object", "null" ] }, "status": { "type": "string", "example": "active" }, "is_primary": { "type": "boolean", "example": false } }, "type": "object" }, "Warehouse": { "description": "Where goods go before Amazon. A shared warehouse belongs to no team, and the team can read it but not change it.", "properties": { "id": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "East Coast Prep" }, "website": { "type": [ "string", "null" ], "example": "eastcoastprep.com" }, "location": { "type": [ "string", "null" ] }, "contacts": { "type": [ "string", "null" ] }, "config": { "type": [ "object", "null" ] }, "status": { "type": [ "string", "null" ], "example": "active" }, "is_primary": { "description": "One team has one primary warehouse.", "type": "boolean", "example": false }, "is_shared": { "description": "A shared warehouse is read only for the team.", "type": "boolean", "example": false }, "provider": { "description": "The prep provider the warehouse syncs with.", "type": [ "string", "null" ] }, "is_synced": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object" }, "WarehouseProvider": { "description": "A prep provider that a warehouse can sync with. Connect a provider in the Seller Assistant app.", "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Prep Provider" }, "slug": { "type": "string", "example": "prep-provider" }, "provider": { "description": "The key of the integration.", "type": "string", "example": "prepbusiness" }, "country": { "type": [ "string", "null" ], "example": "US" }, "description": { "type": [ "string", "null" ] }, "logo_url": { "description": "The address of the logo, or null when the provider has none.", "type": [ "string", "null" ] }, "website": { "type": [ "string", "null" ] }, "settings_url": { "description": "The page of the provider where the team finds its API key.", "type": "string" }, "is_active": { "type": "boolean", "example": true }, "is_connected": { "description": "Whether the team connected this provider.", "type": "boolean", "example": false } }, "type": "object" }, "RepricerProductHistoryItem": { "properties": { "id": { "description": "History record ID.", "type": "integer", "example": 101 }, "asin": { "description": "Product ASIN used in repricing run.", "type": [ "string", "null" ], "example": "B00TEST123" }, "marketplace_id": { "description": "Marketplace ID used in repricing run.", "type": [ "string", "null" ], "example": "ATVPDKIKX0DER" }, "sku": { "description": "Seller SKU used in repricing run.", "type": [ "string", "null" ], "example": "SKU-123" }, "reprice_priority": { "description": "Reprice priority at run time.", "type": "string", "example": "regular" }, "status": { "description": "Final repricing status.", "type": "string", "example": "PRICE_UPDATE_SUBMITTED", "enum": [ "FAILED", "SKIPPED", "PRICE_SKIPPED_OUT_OF_BOUNDS", "PRICE_ALREADY_OPTIMAL", "PRICE_UPDATE_SKIPPED_BY_ALLOW_FLAG", "PRICE_UPDATE_SUBMITTED", "PRICE_UPDATE_CONFIRMED", "DRY_RUN_PRICE_UPDATE_EMULATED" ] }, "error_code": { "description": "Detailed failure reason. Present when status=FAILED. Values: FAILED_TO_LOAD_REPRICER_PRODUCT, NO_REPRICER_PRODUCT_FOUND, FAILED_TO_RESOLVE_STRATEGY, FAILED_TO_RESOLVE_AMAZON_SELLER_CONTEXT, NO_AMAZON_SELLER_AUTHORIZATION_FOUND, FAILED_TO_FETCH_SELLER_PRICE_FROM_AMAZON, REPRICER_PRODUCT_PAUSED, NO_SELLER_LISTINGS_FOUND_ON_AMAZON, INACTIVE_SELLER_LISTING, NO_SELLER_PRICE_FOUND_ON_AMAZON_LISTINGS, FAILED_TO_FETCH_COMPETITIVE_PRICING_FROM_AMAZON, NO_LOWEST_PRICED_OFFERS_FOUND, NO_COMPETITIVE_PRICE_FOUND, CURRENCY_MISMATCH_BETWEEN_LISTING_AND_MARKET_DATA, FAILED_TO_CALCULATE_TARGET_PRICE, FAILED_TO_SUBMIT_PRICE_TO_AMAZON.", "type": [ "string", "null" ], "example": null }, "market_data": { "description": "Raw/normalized market data snapshot used in calculation.", "type": [ "object", "null" ], "example": { "lowest_buybox_price": { "price": "25.99", "currency": "USD" } } }, "settings_snapshot": { "description": "Settings snapshot containing default, team-effective and product-effective values used during repricing.", "type": [ "object", "null" ] }, "strategy": { "description": "Resolved strategy used in this run.", "type": [ "string", "null" ], "example": "follow_buybox" }, "strategy_params": { "description": "Resolved strategy parameters used in this run.", "type": [ "object", "null" ], "example": { "price_adjustment": "-0.01", "price_adjustment_type": "amount" } }, "limits": { "description": "Resolved price limits used in this run.", "type": [ "object", "null" ], "example": { "min_price": "5.00", "max_price": "80.00" } }, "old_price": { "description": "Seller price before repricing.", "type": [ "number", "null" ], "format": "float", "example": 24.99 }, "currency": { "description": "Currency code for old/final prices.", "type": [ "string", "null" ], "example": "USD" }, "price_before_limits": { "description": "Calculated target price before limits were applied.", "type": [ "number", "null" ], "format": "float", "example": 25.49 }, "should_update_before_limits": { "description": "Whether update was needed before limits check.", "type": [ "boolean", "null" ], "example": true }, "reason_before_limits": { "description": "Decision reason before limits check.", "type": [ "string", "null" ], "example": "PRICE_CHANGED" }, "final_price": { "description": "Final price after limits/application rules.", "type": [ "number", "null" ], "format": "float", "example": 25.99 }, "should_update_after_limits": { "description": "Whether update should be sent after all checks.", "type": [ "boolean", "null" ], "example": true }, "reason_after_limits": { "description": "Final decision reason after limits and flags.", "type": [ "string", "null" ], "example": "PRICE_UPDATE_SUBMITTED" }, "limits_applied": { "description": "List of limits that affected price decision.", "type": [ "array", "null" ], "items": { "type": "string" }, "example": [ "max_change_percent", "min_price" ] }, "mode": { "description": "Effective repricing mode for this run. `simulation` is a run of a test system: it sent no price.", "type": [ "string", "null" ], "example": "live", "enum": [ "off", "simulation", "live" ] }, "amazon_submit_price_status": { "description": "Amazon submission status, if submission attempt was made.", "type": [ "string", "null" ], "example": "ACCEPTED" }, "amazon_submit_price_submission_id": { "description": "Amazon submission identifier for tracking.", "type": [ "string", "null" ], "example": "1234567890" }, "amazon_submit_price_blocking_issues": { "description": "Blocking issues returned by Amazon for price submission.", "type": [ "array", "null" ], "items": { "type": "object" }, "example": [] }, "created_at": { "description": "History record creation timestamp.", "type": "string", "format": "date-time", "example": "2024-03-27T12:34:56Z" } }, "type": "object" }, "HistorySearchResponse": { "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RepricerProductHistoryItem" } }, "meta": { "properties": { "pagination": { "properties": { "page": { "description": "Current page number.", "type": "integer", "example": 1 }, "per_page": { "description": "Items per page.", "type": "integer", "example": 50 }, "total": { "description": "Total matching records.", "type": "integer", "example": 100 }, "last_page": { "description": "Last available page number.", "type": "integer", "example": 2 } }, "type": "object" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" }, "HistoryStats": { "required": [ "period", "products", "operations", "prices" ], "properties": { "period": { "properties": { "from": { "description": "Period start date.", "type": "string", "format": "date", "example": "2026-01-01" }, "to": { "description": "Period end date.", "type": "string", "format": "date", "example": "2026-07-01" } }, "type": "object" }, "products": { "properties": { "total": { "description": "Total repricer products in team scope.", "type": "integer", "example": 100 }, "by_priority": { "description": "Product counts grouped by reprice priority.", "type": "object", "example": { "regular": 80, "paused": 20 } }, "by_mode": { "description": "Product counts grouped by mode.", "type": "object", "example": { "off": 20, "live": 80 } } }, "type": "object" }, "operations": { "properties": { "total": { "description": "Total repricing operations in selected period.", "type": "integer", "example": 500 }, "by_type": { "description": "Operation counts grouped by priority/type.", "type": "object", "example": { "regular": 200, "paused": 300 } }, "by_status": { "description": "Operation counts grouped by final status.", "type": "object", "example": { "PRICE_SKIPPED_OUT_OF_BOUNDS": 50, "PRICE_ALREADY_OPTIMAL": 100, "PRICE_UPDATE_SUBMITTED": 300, "FAILED": 50 } }, "success_rate": { "description": "Operation success rate in percent.", "type": "string", "format": "decimal", "example": "96.00" } }, "type": "object" }, "prices": { "properties": { "avg_change": { "description": "Average signed price change.", "type": "string", "format": "decimal", "example": "1.25" }, "avg_rise": { "description": "Average increase among rising price operations.", "type": "string", "format": "decimal", "example": "1.50" }, "avg_drop": { "description": "Average decrease among dropping price operations.", "type": "string", "format": "decimal", "example": "0.75" }, "total_drop": { "description": "Total absolute decrease across dropping operations.", "type": "string", "format": "decimal", "example": "50.00" }, "total_rise": { "description": "Total absolute increase across rising operations.", "type": "string", "format": "decimal", "example": "75.00" } }, "type": "object" } }, "type": "object" }, "RepricerDefaultSettings": { "description": "One repricer mode. The strategy, its parameters and the limits live on the strategy and on the product, not here.", "properties": { "mode": { "description": "The repricer mode of this level. `live` sends prices to Amazon. `simulation` runs the whole pipeline and sends no price (a test system only). `off` is a paused team.", "type": "string", "example": "live", "enum": [ "off", "live", "simulation" ] } }, "type": "object" }, "RepricerInfo": { "description": "What the repricer does for this team right now. `/repricer/settings` holds what the team wrote; this answer adds the system, the plan and the Amazon connections to it.", "properties": { "mode": { "description": "The mode of the system. It is the ceiling of every team: a `simulation` system (a test system only) sends no price to Amazon.", "type": "string", "example": "live", "enum": [ "live", "simulation" ] }, "sales_data_enabled": { "description": "Whether the sales rollup runs. Without it the sales columns of the repricer table read 0.", "type": "boolean", "example": false }, "default_settings": { "$ref": "#/components/schemas/RepricerDefaultSettings", "description": "Default repricer settings from config. These are the baseline settings that apply if no custom settings are set for the team." }, "team_effective_settings": { "$ref": "#/components/schemas/RepricerDefaultSettings", "description": "Effective team settings after merging default settings with team overrides." }, "team_settings": { "$ref": "#/components/schemas/RepricerDefaultSettings", "description": "Custom repricer settings for the team. These settings override the default settings from config." }, "allowed_marketplaces": { "description": "Allowed marketplaces grouped by region. Each region contains marketplace IDs available for repricing for the current team.", "properties": { "na": { "description": "North America marketplace IDs available for repricing.", "type": "array", "items": { "type": "string", "example": "ATVPDKIKX0DER" } }, "eu": { "description": "Europe marketplace IDs available for repricing.", "type": "array", "items": { "type": "string", "example": "A1PA6795UKMFR9" } }, "fe": { "description": "Far East marketplace IDs available for repricing.", "type": "array", "items": { "type": "string", "example": "A1VC38T7YXB528" } } }, "type": "object" }, "auto_enroll_settings": { "description": "What happens to a SKU the team adds later. A team with no settings row answers null in every field.", "properties": { "mode": { "description": "Whether a new SKU starts repricing on its own.", "type": [ "string", "null" ], "example": "off", "enum": [ "off", "live" ] }, "reprice_priority": { "type": [ "string", "null" ], "example": "regular", "enum": [ "fast", "regular" ] }, "marketplace_ids": { "description": "The marketplaces the auto enrollment covers. An empty array means every marketplace of the team.", "type": "array", "items": { "type": "string", "example": "ATVPDKIKX0DER" } } }, "type": "object" }, "usage_limits": { "description": "Current usage limits for the team's subscription plan. Only a product that reprices live takes a slot, so a paused team (`off`) reads 0 used.", "properties": { "regular_repricer_products_limit": { "description": "Maximum number of regular repricer products allowed for the team.", "type": "integer", "example": 500 }, "regular_repricer_products_left": { "description": "Remaining regular repricer product slots for the team.", "type": "integer", "example": 450 }, "regular_repricer_products_used": { "description": "Number of regular repricer product slots already used.", "type": "integer", "example": 50 }, "regular_repricer_products_over": { "description": "How many products the team holds above its limit. A plan that gets smaller leaves the extra products here.", "type": "integer", "example": 0 } }, "type": "object" } }, "type": "object" }, "RepricerSettings": { "description": "What the team wrote. The strategy, its parameters and the limits live on the strategy and on the product, not here.", "required": [ "team_id", "mode" ], "properties": { "id": { "description": "Settings record ID.", "type": "integer", "example": 1 }, "team_id": { "description": "Owner team ID.", "type": "integer", "example": 123 }, "mode": { "description": "The repricer switch of the team. `off` pauses every product of the team. `on` lets the switch of each product decide.", "type": "string", "example": "on", "enum": [ "on", "off" ] }, "auto_enroll_mode": { "description": "Whether a SKU the team adds later starts repricing on its own.", "type": [ "string", "null" ], "example": "off", "enum": [ "off", "live" ] }, "auto_enroll_reprice_priority": { "type": [ "string", "null" ], "example": "regular", "enum": [ "fast", "regular" ] }, "auto_enroll_marketplace_ids": { "description": "The marketplaces the auto enrollment covers. An empty array means every marketplace of the team.", "type": "array", "items": { "type": "string", "example": "ATVPDKIKX0DER" } }, "created_by": { "description": "User ID that created the settings record.", "type": [ "integer", "null" ], "example": 7 }, "updated_by": { "description": "User ID that last updated the settings record.", "type": [ "integer", "null" ], "example": 42 }, "created_at": { "description": "Creation timestamp.", "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-23T12:00:00Z" }, "updated_at": { "description": "Last update timestamp.", "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-23T12:00:00Z" } }, "type": "object" }, "UpdateRepricerSettings": { "description": "The update sends only the fields it changes. A field that is not there keeps the value the team has.", "properties": { "mode": { "description": "The repricer switch of the team. `off` pauses every product of the team.", "type": [ "string", "null" ], "example": "on", "enum": [ "on", "off" ] }, "auto_enroll_mode": { "description": "Whether a SKU the team adds later starts repricing on its own.", "type": [ "string", "null" ], "example": "off", "enum": [ "off", "live" ] }, "auto_enroll_reprice_priority": { "type": [ "string", "null" ], "example": "regular", "enum": [ "fast", "regular" ] }, "auto_enroll_marketplace_ids": { "description": "The marketplaces the auto enrollment covers. An empty array means every marketplace of the team.", "type": [ "array", "null" ], "items": { "type": "string", "example": "ATVPDKIKX0DER" } } }, "type": "object" }, "RepricerProduct": { "required": [ "id", "team_id", "asin", "marketplace_id", "sku" ], "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "team_id": { "type": "integer", "readOnly": true, "example": 123 }, "asin": { "type": "string", "example": "B07PGL2ZSL" }, "marketplace_id": { "type": "string", "example": "ATVPDKIKX0DER" }, "sku": { "type": "string", "example": "Webstaurantstore 14-07-2025 B0019MQM64" }, "condition": { "type": [ "string", "null" ], "example": "new", "enum": [ "new", "used_like_new", "used", "refurbished" ] }, "strategy": { "oneOf": [ { "$ref": "#/components/schemas/RepricerStrategy", "description": "The strategy the row reprices with. The row carries its own, or it takes the one of the ASIN." }, { "type": "null" } ], "description": "The strategy the row reprices with. The row carries its own, or it takes the one of the ASIN." }, "strategy_id": { "description": "The strategy of the row itself. Null says the row takes the strategy of the ASIN, which `strategy` then shows. The update takes this field.", "type": [ "integer", "null" ], "example": 12 }, "limits": { "properties": { "max_price": { "type": [ "number", "null" ], "example": 45 }, "min_price": { "type": [ "number", "null" ], "example": 20 }, "max_change": { "type": [ "number", "null" ], "example": 46 }, "max_change_percent": { "type": [ "number", "null" ], "example": 5 }, "min_price_mode": { "type": [ "string", "null" ], "example": "manual", "enum": [ "manual", "break_even", "break_even_plus", "target_roi", "target_margin" ] }, "target_roi": { "type": [ "number", "null" ], "example": 20 }, "target_margin": { "type": [ "number", "null" ], "example": 15 }, "min_price_markup": { "type": [ "number", "null" ], "example": 2 }, "min_price_markup_type": { "type": [ "string", "null" ], "example": "amount", "enum": [ "amount", "percent" ] }, "missing_cost_fallback": { "type": [ "string", "null" ], "example": "manual", "enum": [ "error", "manual", "none" ] } }, "type": "object" }, "mode": { "description": "Repricing mode. The values are `off` and `live`. Simulation is a setting of the system, not of a product.", "type": [ "string", "null" ], "example": "off", "enum": [ "off", "live" ] }, "reprice_priority": { "description": "How often the product reprices. The write takes the same word.", "type": [ "string", "null" ], "example": "regular", "enum": [ "fast", "regular" ] }, "product_map_price": { "description": "The MAP of the supplier, on the ASIN. It belongs to the product, not to this row.", "type": [ "number", "null" ], "format": "float", "example": 24.99 }, "fulfillment_channel": { "description": "Who ships the orders of the SKU: Amazon (FBA) or the seller (FBM). The channel selects the profit formula. `null` means that the channel is not known, and the FBA formula applies.", "type": [ "string", "null" ], "example": "FBM", "enum": [ "FBA", "FBM" ] }, "my_shipping": { "description": "The shipping charge that our own offer asks from the buyer. `null` means that the repricer did not see our offer yet. The limits are item prices: for FBM with shipping, the buyer pays the item price plus this charge.", "type": [ "number", "null" ], "example": 5 }, "fbm_postage": { "description": "The postage the seller pays for one FBM unit (`cost_overrides.fbm_postage_cost` of the SKU). `null` means unknown, not zero: an FBM SKU then has no profit and no cost-based price floor.", "type": [ "number", "null" ], "example": 10 }, "profit": { "description": "The profit for one unit at the last repriced price. For FBM: item price + shipping − referral fee − closing fee − product cost − prep − postage. `null` when a cost is not known.", "type": [ "number", "null" ], "example": 22.38 }, "roi": { "description": "The profit as a percent of the cost of one unit.", "type": [ "number", "null" ], "example": 41.22 }, "margin": { "description": "The profit as a percent of what the buyer pays.", "type": [ "number", "null" ], "example": 24.81 }, "created_at": { "type": "string", "format": "date-time", "example": "2026-04-11T18:15:06Z" }, "created_by": { "type": [ "integer", "null" ], "example": 42 }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-04-11T18:15:06Z" }, "updated_by": { "type": [ "integer", "null" ], "example": 42 } }, "type": "object" }, "RepricerProductListResponse": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RepricerProduct" } }, "meta": { "properties": { "pagination": { "properties": { "page": { "type": "integer", "example": 1 }, "per_page": { "type": "integer", "example": 50 }, "total": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 } }, "type": "object" }, "trial_limit": { "$ref": "#/components/schemas/ApiV1TrialLimit" } }, "type": "object" } }, "type": "object" }, "CreateRepricerProductForm": { "required": [ "asin", "marketplace_id", "sku", "strategy_id" ], "properties": { "asin": { "description": "Product ASIN.", "type": "string", "example": "B0019MQM64" }, "marketplace_id": { "description": "Amazon marketplace ID for this product.", "type": "string", "example": "ATVPDKIKX0DER" }, "sku": { "description": "Seller SKU in the selected marketplace.", "type": "string", "example": "Webstaurantstore 14-07-2025 B0019MQM64" }, "strategy_id": { "description": "The strategy the product reprices with. `GET /api/v1/sa/repricer/strategies` lists the strategies of the team.", "type": "integer", "example": 12 }, "limits": { "description": "Per-product pricing limits that override team/default limits.", "properties": { "max_price": { "description": "Absolute maximum allowed final price. A number, or the string of it.", "type": [ "number", "null" ], "example": 45 }, "min_price": { "description": "Absolute minimum allowed final price. A number, or the string of it.", "type": [ "number", "null" ], "example": 20 }, "max_change": { "description": "Maximum absolute price change per reprice operation.", "type": [ "number", "null" ], "example": 46 }, "max_change_percent": { "description": "Maximum relative price change (percent) per reprice operation.", "type": [ "number", "null" ], "example": 5 }, "min_price_mode": { "description": "How the minimum price is found.", "type": [ "string", "null" ], "example": "manual", "enum": [ "manual", "break_even", "break_even_plus", "target_roi", "target_margin" ] }, "target_roi": { "description": "The ROI the minimum price aims at, in percent.", "type": [ "number", "null" ], "example": 20 }, "target_margin": { "description": "The margin the minimum price aims at, in percent.", "type": [ "number", "null" ], "example": 15 }, "min_price_markup": { "description": "What the break even price adds to reach the minimum price.", "type": [ "number", "null" ], "example": 2 }, "min_price_markup_type": { "type": [ "string", "null" ], "example": "amount", "enum": [ "amount", "percent" ] }, "missing_cost_fallback": { "description": "What happens when the cost of the SKU is not known.", "type": [ "string", "null" ], "example": "manual", "enum": [ "error", "manual", "none" ] } }, "type": [ "object", "null" ] }, "mode": { "description": "Repricing mode. An absent mode is off. The values are `off` and `live`. Simulation is a setting of the system, not of a product.", "type": "string", "example": "off", "enum": [ "off", "live" ] }, "reprice_priority": { "description": "How often the product reprices.", "type": [ "string", "null" ], "example": "regular", "enum": [ "fast", "regular" ] }, "condition": { "description": "The condition the offer sells in.", "type": [ "string", "null" ], "example": "new", "enum": [ "new", "used_like_new", "used", "refurbished" ] } }, "type": "object" }, "UpdateRepricerProductForm": { "description": "The update sends only the fields it changes. Every field is optional, and a field that is not there keeps the value the product has.", "properties": { "asin": { "description": "Product ASIN.", "type": "string", "example": "B0019MQM64" }, "marketplace_id": { "description": "Amazon marketplace ID for this product.", "type": "string", "example": "ATVPDKIKX0DER" }, "sku": { "description": "Seller SKU in the selected marketplace.", "type": "string", "example": "Webstaurantstore 14-07-2025 B0019MQM64" }, "strategy_id": { "description": "The strategy of this row. Null gives the row back to the strategy of the ASIN, which every row of that ASIN shares. The answer then shows that strategy under `strategy`, and `strategy_id` stays null.", "type": [ "integer", "null" ], "example": 12 }, "limits": { "description": "Per-product pricing limits that override team/default limits.", "properties": { "max_price": { "description": "Absolute maximum allowed final price. A number, or the string of it.", "type": [ "number", "null" ], "example": 45 }, "min_price": { "description": "Absolute minimum allowed final price. A number, or the string of it.", "type": [ "number", "null" ], "example": 20 }, "max_change": { "description": "Maximum absolute price change per reprice operation.", "type": [ "number", "null" ], "example": 46 }, "max_change_percent": { "description": "Maximum relative price change (percent) per reprice operation.", "type": [ "number", "null" ], "example": 5 }, "min_price_mode": { "description": "How the minimum price is found.", "type": [ "string", "null" ], "example": "manual", "enum": [ "manual", "break_even", "break_even_plus", "target_roi", "target_margin" ] }, "target_roi": { "description": "The ROI the minimum price aims at, in percent.", "type": [ "number", "null" ], "example": 20 }, "target_margin": { "description": "The margin the minimum price aims at, in percent.", "type": [ "number", "null" ], "example": 15 }, "min_price_markup": { "description": "What the break even price adds to reach the minimum price.", "type": [ "number", "null" ], "example": 2 }, "min_price_markup_type": { "type": [ "string", "null" ], "example": "amount", "enum": [ "amount", "percent" ] }, "missing_cost_fallback": { "description": "What happens when the cost of the SKU is not known.", "type": [ "string", "null" ], "example": "manual", "enum": [ "error", "manual", "none" ] } }, "type": [ "object", "null" ] }, "mode": { "description": "Repricing mode. An absent mode keeps the mode the product has. The values are `off` and `live`. Simulation is a setting of the system, not of a product.", "type": "string", "example": "live", "enum": [ "off", "live" ] }, "reprice_priority": { "description": "How often the product reprices.", "type": [ "string", "null" ], "example": "regular", "enum": [ "fast", "regular" ] }, "condition": { "description": "The condition the offer sells in.", "type": [ "string", "null" ], "example": "new", "enum": [ "new", "used_like_new", "used", "refurbished" ] } }, "type": "object" }, "RepricerStrategy": { "properties": { "id": { "type": "integer", "example": 1 }, "team_id": { "type": "integer", "example": 123 }, "name": { "type": "string", "example": "Aggressive Buy Box" }, "description": { "type": [ "string", "null" ], "example": "Beat buy box by 1 cent" }, "color": { "type": [ "string", "null" ], "example": "#FF5733" }, "action": { "type": [ "string", "null" ], "example": "follow_buybox", "enum": [ "follow_buybox", "follow_lowest", "follow_featured_offer", "adjust_price" ] }, "action_params": { "properties": { "price_adjustment": { "description": "Price offset. Negative = undercut, positive = premium. The write takes the number, or the string of it.", "type": "number", "format": "float", "example": -0.01 }, "price_adjustment_type": { "description": "Whether adjustment is a fixed dollar amount or percentage.", "type": "string", "example": "amount", "enum": [ "amount", "percent" ] }, "reference": { "description": "The offers the price follows. Only follow_lowest reads it.", "type": [ "string", "null" ], "example": "fba", "enum": [ "any", "fba", "fbm", "same_as_mine" ] }, "respect_map": { "description": "Keep the price at or above the MAP of the product. Only the follow strategies read it.", "type": [ "boolean", "null" ], "example": true }, "when_winning": { "description": "While we hold the Buy Box. hold keeps the price. follow_next follows the next Buy Box-eligible competitor with the same price_adjustment (-0.01 = one cent below, 0 = match). It never lowers the price, never goes above the max price or the competitive price threshold, and holds when neither exists. Only follow_buybox and follow_featured_offer read it. No key is hold; a new strategy gets follow_next. In a rule, no key uses the strategy value.", "type": [ "string", "null" ], "example": "follow_next", "enum": [ "hold", "follow_next" ] }, "win_back_buybox": { "description": "Recover a suppressed Buy Box before custom rules.", "type": "boolean", "default": true }, "buybox_recovery_step": { "description": "Step down in the listing currency. Minimum 0.01; at most two decimal places.", "type": "number", "default": 0.01 }, "when_unopposed": { "description": "With follow_next and no Buy Box-eligible competitor: hold (default) or max (go to the max price; holds when no max price is set).", "type": [ "string", "null" ], "example": "hold", "enum": [ "hold", "max" ] }, "when_below_min": { "description": "When the Buy Box, the lowest competitor or the featured offer is below the min price. min (default) stays at the min price. max goes to the max price (holds when no max price is set). hold keeps the current price. Only follow_buybox, follow_lowest and follow_featured_offer read it. In a rule, no key uses the strategy value.", "type": [ "string", "null" ], "example": "max", "enum": [ "min", "max", "hold" ] } }, "type": [ "object", "null" ] }, "limits": { "description": "Every number here answers as a number. The keys that name a thing stay words.", "properties": { "min_price_mode": { "type": [ "string", "null" ], "example": "target_roi", "enum": [ "break_even_plus", "target_roi", "target_margin" ] }, "target_roi": { "description": "The ROI the minimum price aims at, in percent.", "type": [ "number", "null" ], "example": 10 }, "target_margin": { "type": [ "number", "null" ], "example": 5 }, "min_price_markup": { "type": [ "number", "null" ], "example": 2 }, "missing_cost_fallback": { "type": [ "string", "null" ], "example": "none", "enum": [ "error", "none" ] }, "min_price": { "type": [ "number", "null" ], "example": 5 }, "max_price": { "type": [ "number", "null" ], "example": 100 }, "max_change": { "type": [ "number", "null" ], "example": null }, "max_change_percent": { "type": [ "number", "null" ], "example": 10 } }, "type": [ "object", "null" ] }, "rules": { "description": "The rules the strategy runs before its own action. The first rule that matches wins. A strategy with no rules answers null.", "type": [ "array", "null" ], "items": { "properties": { "name": { "type": "string", "example": "Amazon is selling" }, "condition": { "properties": { "type": { "type": "string", "example": "amazon_selling" }, "value": { "description": "The value the condition compares against. A number, a word or true.", "example": true } }, "type": "object" }, "action": { "description": "The action of the rule. `hold` keeps the price as it is. `set_max` moves the price to the max price.", "type": [ "string", "null" ], "example": "hold", "enum": [ "follow_buybox", "follow_lowest", "follow_featured_offer", "adjust_price", "hold", "set_max" ] }, "action_params": { "properties": { "price_adjustment": { "type": "number", "format": "float", "example": 5 }, "price_adjustment_type": { "type": "string", "example": "percent", "enum": [ "amount", "percent" ] }, "reference": { "description": "The offers the price follows. Only follow_lowest reads it.", "type": [ "string", "null" ], "example": "fba", "enum": [ "any", "fba", "fbm", "same_as_mine" ] }, "respect_map": { "description": "Keep the price at or above the MAP of the product. Only the follow strategies read it.", "type": [ "boolean", "null" ], "example": true }, "when_winning": { "description": "While we hold the Buy Box. hold keeps the price. follow_next follows the next Buy Box-eligible competitor with the same price_adjustment (-0.01 = one cent below, 0 = match). It never lowers the price, never goes above the max price or the competitive price threshold, and holds when neither exists. Only follow_buybox and follow_featured_offer read it. No key is hold; a new strategy gets follow_next. In a rule, no key uses the strategy value.", "type": [ "string", "null" ], "example": "follow_next", "enum": [ "hold", "follow_next" ] }, "when_unopposed": { "description": "With follow_next and no Buy Box-eligible competitor: hold (default) or max (go to the max price; holds when no max price is set).", "type": [ "string", "null" ], "example": "hold", "enum": [ "hold", "max" ] }, "when_below_min": { "description": "When the Buy Box, the lowest competitor or the featured offer is below the min price. min (default) stays at the min price. max goes to the max price (holds when no max price is set). hold keeps the current price. Only follow_buybox, follow_lowest and follow_featured_offer read it. In a rule, no key uses the strategy value.", "type": [ "string", "null" ], "example": "max", "enum": [ "min", "max", "hold" ] } }, "type": [ "object", "null" ] } }, "type": "object" } }, "rules_count": { "description": "How many rules the strategy holds.", "type": "integer", "example": 4 }, "is_default": { "type": "boolean", "example": false }, "product_count": { "description": "How many products use the strategy. The list of the strategies counts them. A strategy inside another answer does not, and answers null.", "type": [ "integer", "null" ], "example": 15 }, "created_by": { "type": [ "integer", "null" ], "example": 1 }, "updated_by": { "type": [ "integer", "null" ], "example": 1 }, "created_at": { "type": "string", "format": "date-time", "example": "2026-06-27T12:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-06-27T12:00:00Z" } }, "type": "object" }, "RepricerStrategyForm": { "description": "The fields of a strategy. The create names the ones it cannot leave out on its own body, and the update takes any subset of these.", "properties": { "name": { "description": "Strategy name.", "type": "string", "example": "Aggressive Buy Box" }, "description": { "description": "Strategy description.", "type": [ "string", "null" ], "example": "Beat the buy box by 1 cent" }, "color": { "description": "Hex color for UI badge.", "type": [ "string", "null" ], "example": "#FF5733" }, "action": { "description": "Repricing action name.", "type": [ "string", "null" ], "example": "follow_buybox", "enum": [ "follow_buybox", "follow_lowest", "follow_featured_offer", "adjust_price" ] }, "action_params": { "description": "Strategy-specific parameters.", "properties": { "price_adjustment": { "description": "Price offset. Negative = undercut, positive = premium. A number or the string of it.", "type": "number", "format": "float", "example": -0.01 }, "price_adjustment_type": { "description": "Whether adjustment is a fixed dollar amount or percentage.", "type": "string", "example": "amount", "enum": [ "amount", "percent" ] }, "reference": { "description": "The offers the price follows. Only follow_lowest reads it.", "type": [ "string", "null" ], "example": "fba", "enum": [ "any", "fba", "fbm", "same_as_mine" ] }, "respect_map": { "description": "Keep the price at or above the MAP of the product. Only the follow strategies read it.", "type": [ "boolean", "null" ], "example": true }, "when_winning": { "description": "While we hold the Buy Box. hold keeps the price. follow_next follows the next Buy Box-eligible competitor with the same price_adjustment (-0.01 = one cent below, 0 = match). It never lowers the price, never goes above the max price or the competitive price threshold, and holds when neither exists. Only follow_buybox and follow_featured_offer read it. No key is hold; a new strategy gets follow_next. In a rule, no key uses the strategy value.", "type": [ "string", "null" ], "example": "follow_next", "enum": [ "hold", "follow_next" ] }, "win_back_buybox": { "description": "Recover a suppressed Buy Box before custom rules.", "type": "boolean", "default": true }, "buybox_recovery_step": { "description": "Step down in the listing currency. Minimum 0.01; at most two decimal places.", "type": "number", "default": 0.01 }, "when_unopposed": { "description": "With follow_next and no Buy Box-eligible competitor: hold (default) or max (go to the max price; holds when no max price is set).", "type": [ "string", "null" ], "example": "hold", "enum": [ "hold", "max" ] }, "when_below_min": { "description": "When the Buy Box, the lowest competitor or the featured offer is below the min price. min (default) stays at the min price. max goes to the max price (holds when no max price is set). hold keeps the current price. Only follow_buybox, follow_lowest and follow_featured_offer read it. In a rule, no key uses the strategy value.", "type": [ "string", "null" ], "example": "max", "enum": [ "min", "max", "hold" ] } }, "type": [ "object", "null" ] }, "limits": { "description": "The protection the strategy applies by default. `min_price_mode` names how the floor is found, and the field it needs comes beside it.", "properties": { "min_price_mode": { "type": "string", "example": "target_roi", "enum": [ "break_even_plus", "target_roi", "target_margin" ] }, "target_roi": { "description": "Required when the mode is target_roi.", "type": [ "number", "null" ], "example": 10 }, "target_margin": { "description": "Required when the mode is target_margin.", "type": [ "number", "null" ], "example": 5 }, "min_price_markup": { "description": "Required when the mode is break_even_plus.", "type": [ "number", "null" ], "example": 2 }, "missing_cost_fallback": { "type": [ "string", "null" ], "example": "none", "enum": [ "error", "none" ] } }, "type": [ "object", "null" ] }, "is_default": { "description": "Set as team default strategy.", "type": "boolean", "example": false } }, "type": "object" }, "SellerSpySeller": { "description": "An Amazon seller that the team tracks. One seller has one marketplace.", "properties": { "id": { "description": "The id of the tracked seller in Seller Assistant.", "type": "integer", "example": 12 }, "seller_id": { "description": "The id of the seller on Amazon.", "type": "string", "example": "A1B2C3D4E5F6G7" }, "marketplace_id": { "type": "string", "example": "ATVPDKIKX0DER" }, "name": { "description": "Null until the first storefront read ends.", "type": [ "string", "null" ], "example": "Acme Goods" }, "seller_url": { "type": [ "string", "null" ], "format": "uri", "example": "https://www.amazon.com/sp?marketplaceID=ATVPDKIKX0DER&seller=A1B2C3D4E5F6G7" }, "storefront_url": { "type": [ "string", "null" ], "format": "uri", "example": "https://amazon.com/s?me=A1B2C3D4E5F6G7&marketplaceID=ATVPDKIKX0DER" }, "rating": { "description": "The percent of positive ratings.", "type": [ "integer", "null" ], "example": 97 }, "rating_count": { "type": [ "integer", "null" ], "example": 1250 }, "stars": { "type": [ "number", "null" ], "example": 4.8 }, "products_count": { "description": "The products of the latest storefront snapshot.", "type": "integer", "example": 340 }, "products_added_30d": { "type": "integer", "example": 12 }, "new_brands_30d": { "type": "integer", "example": 2 }, "is_processing": { "description": "True while Seller Assistant reads the storefront.", "type": "boolean", "example": false }, "seller_type": { "$ref": "#/components/schemas/SellerSpySellerType" }, "tracked_since": { "description": "The day on which the team started to track the seller.", "type": [ "string", "null" ], "format": "date", "example": "2026-04-22" }, "snapshot_at": { "description": "The time of the latest storefront snapshot.", "type": [ "string", "null" ], "format": "date-time", "example": "2026-10-23T07:00:32Z" } }, "type": "object" }, "SellerSpySellerType": { "description": "The type of the seller from the brand data of its storefront.", "properties": { "classified": { "description": "False until Seller Assistant has the brand data of the seller.", "type": "boolean", "example": true }, "is_amazon": { "type": "boolean", "example": false }, "brand_sells_itself": { "description": "True when the seller sells mostly its own brand.", "type": "boolean", "example": false }, "is_distributor": { "description": "True when the seller sells many brands.", "type": "boolean", "example": true } }, "type": "object" }, "SellerSpySellerDetails": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SellerSpySeller" }, { "properties": { "insights": { "$ref": "#/components/schemas/SellerSpyInsights" } }, "type": "object" } ] }, "SellerSpyInsights": { "description": "The facts about the storefront of the seller and its overlap with the catalog of the team.", "properties": { "products_count": { "type": "integer", "example": 340 }, "enriched_products_count": { "description": "The products with catalog data. The brand and category counts read these products only.", "type": "integer", "example": 320 }, "brands_count": { "type": "integer", "example": 45 }, "top_brands": { "description": "At most 8 brands with the most products.", "type": "array", "items": { "properties": { "brand": { "type": "string", "example": "Acme" }, "products_count": { "type": "integer", "example": 58 } }, "type": "object" } }, "top_categories": { "description": "At most 5 categories with the most products.", "type": "array", "items": { "properties": { "category": { "type": "string", "example": "Home & Kitchen" }, "products_count": { "type": "integer", "example": 120 } }, "type": "object" } }, "brand_options": { "description": "The values that `filter[brand][eq]` of the products accepts.", "type": "array", "items": { "type": "string" }, "example": [ "Acme", "Globex" ] }, "category_options": { "description": "The values that `filter[category][eq]` of the products accepts.", "type": "array", "items": { "type": "string" }, "example": [ "Home & Kitchen", "Toys & Games" ] }, "overlap": { "description": "The products of the storefront that the team sells on Amazon.", "properties": { "you_sell": { "type": "integer", "example": 6 }, "gap": { "description": "The products that the seller sells and the team does not.", "type": "integer", "example": 334 }, "your_total": { "description": "The active Amazon products of the team.", "type": "integer", "example": 210 } }, "type": [ "object", "null" ] }, "brand_overlap": { "description": "The brands of the storefront that the catalog of the team has.", "properties": { "you_carry": { "type": "integer", "example": 3 }, "gap": { "type": "integer", "example": 42 }, "your_total": { "type": "integer", "example": 37 } }, "type": [ "object", "null" ] }, "activity": { "properties": { "window_days": { "description": "The period of the activity in days. `products_added`, `products_removed` and `new_brands` cover this period.", "type": "integer", "example": 7 }, "products_added": { "type": "integer", "example": 12 }, "products_removed": { "type": "integer", "example": 5 }, "new_brands": { "type": "integer", "example": 2 } }, "type": [ "object", "null" ] }, "ai_summary": { "description": "Null until the summary job ends. The first read of a seller starts the job.", "type": [ "string", "null" ], "example": "A distributor of kitchen and home goods with 45 brands." }, "business_name": { "type": [ "string", "null" ], "example": "Acme Goods LLC" }, "address": { "type": [ "string", "null" ], "example": "100 Main St, Springfield, IL, 62701, US" }, "country": { "type": [ "string", "null" ], "example": "US" }, "has_fba": { "type": [ "boolean", "null" ], "example": true }, "ships_from_china": { "type": [ "boolean", "null" ], "example": false } }, "type": "object" }, "SellerSpyProduct": { "description": "A product of the storefront of a tracked seller.", "properties": { "asin": { "type": "string", "example": "B08N5WRWNW" }, "title": { "type": [ "string", "null" ], "example": "Acme Glass Cups with Lids, 4 Pack, 20 oz" }, "brand": { "type": [ "string", "null" ], "example": "Acme" }, "category": { "type": [ "string", "null" ], "example": "Home & Kitchen" }, "model": { "type": [ "string", "null" ], "example": "AC-GC-20" }, "image_url": { "type": [ "string", "null" ], "format": "uri", "example": "https://m.media-amazon.com/images/I/41OKzd2bkyL.jpg" }, "url": { "type": [ "string", "null" ], "format": "uri", "example": "https://www.amazon.com/dp/B08N5WRWNW" }, "status": { "description": "The change. Null in the storefront list.", "type": [ "string", "null" ], "example": "added", "enum": [ "added", "removed", null ] }, "date": { "description": "The day of the snapshot that showed the change. Null in the storefront list.", "type": [ "string", "null" ], "format": "date", "example": "2026-10-01" }, "you_sell": { "description": "True when the team sells the ASIN on Amazon in this marketplace.", "type": "boolean", "example": false }, "internal_product_id": { "description": "The id of the product of the team (`/api/v1/sa/inventory/products`) that has this ASIN. Null when the team has no such product.", "type": [ "string", "null" ], "example": "P-5XK1S0NQNO" }, "notes_count": { "description": "The notes of the team on this ASIN (`/api/v1/notes`, target `asin`).", "type": "integer", "example": 1 } }, "type": "object" }, "SellerSpyBrand": { "description": "A brand of the storefront of a tracked seller.", "properties": { "brand": { "type": "string", "example": "Acme" }, "products_count": { "type": "integer", "example": 14 }, "first_seen": { "description": "The day of the first stored snapshot that has the brand.", "type": [ "string", "null" ], "format": "date", "example": "2026-09-28" }, "is_new": { "description": "True when the seller added the brand in the last 30 days.", "type": "boolean", "example": true }, "you_carry": { "description": "True when the catalog of the team has the brand.", "type": "boolean", "example": false } }, "type": "object" }, "SellerSpyOverview": { "properties": { "tracked_sellers": { "properties": { "used": { "type": "integer", "example": 4 }, "limit": { "description": "The sellers that the plan lets the team track.", "type": "integer", "example": 10 } }, "type": "object" }, "has_amazon_connection": { "type": "boolean", "example": true }, "has_own_catalog": { "description": "True when the team has active Amazon products to compare with.", "type": "boolean", "example": true }, "active_sellers_30d": { "description": "The tracked sellers that added products or brands in the last 30 days.", "type": "integer", "example": 3 }, "new_brands_30d": { "type": "integer", "example": 15 }, "products_added_30d": { "type": "integer", "example": 240 }, "most_active": { "type": "array", "items": { "properties": { "id": { "description": "The id of the tracked seller.", "type": "integer", "example": 12 }, "name": { "type": [ "string", "null" ], "example": "Acme Goods" }, "products_added_30d": { "type": "integer", "example": 120 }, "new_brands_30d": { "type": "integer", "example": 6 } }, "type": "object" } } }, "type": "object" }, "SellerSpyBrandSignal": { "description": "A brand that the tracked sellers carry.", "properties": { "brand": { "type": "string", "example": "Acme" }, "marketplace_id": { "type": [ "string", "null" ], "example": "ATVPDKIKX0DER" }, "sellers_count": { "description": "The tracked sellers that carry the brand.", "type": "integer", "example": 2 }, "sellers": { "description": "The names of these sellers.", "type": "array", "items": { "type": "string" }, "example": [ "Acme Goods", "Globex Store" ] }, "products_count": { "type": "integer", "example": 35 }, "is_new": { "description": "True when a tracked seller added the brand in the last 30 days.", "type": "boolean", "example": true }, "you_carry": { "description": "True when the catalog of the team has the brand.", "type": "boolean", "example": false } }, "type": "object" }, "SellerSpyActivity": { "description": "The changes of one tracked seller on one day.", "properties": { "date": { "type": "string", "format": "date", "example": "2026-10-22" }, "seller": { "properties": { "id": { "description": "The id of the tracked seller.", "type": "integer", "example": 12 }, "name": { "type": [ "string", "null" ], "example": "Acme Goods" } }, "type": "object" }, "products_added": { "type": "integer", "example": 27 }, "products_removed": { "type": "integer", "example": 10 }, "new_brands": { "description": "The brands that the seller added on this day.", "type": "array", "items": { "type": "string" }, "example": [ "Globex" ] } }, "type": "object" }, "SellerSpyTrackForm": { "required": [ "url" ], "properties": { "url": { "description": "A seller page or a storefront URL of a supported marketplace.", "type": "string", "example": "https://www.amazon.com/s?me=A1B2C3D4E5F6G7&marketplaceID=ATVPDKIKX0DER", "maxLength": 2048 } }, "type": "object" }, "Tag": { "properties": { "id": { "description": "Tags on the public API v1.\n\nA tag belongs to the team and exists once for every tool. The assignment\nlands on an ASIN in one marketplace, because `tags_products` is keyed by\nasin and marketplace_id, not by the product id.", "type": "integer", "example": 3 }, "name": { "type": "string", "example": "winners" }, "color": { "description": "An index of the palette of the web app, not a CSS colour. The column never holds null. A repricer strategy keeps its colour as a hex string instead, so the two do not take the same value.", "type": "integer", "example": 2, "minimum": 0 } }, "type": "object" }, "TagForm": { "required": [ "name", "color" ], "properties": { "name": { "description": "One team cannot hold the same name twice.", "type": "string", "example": "winners", "maxLength": 255 }, "color": { "description": "An index of the palette, not a CSS colour. A string such as `#0d6e63` answers 400.", "type": "integer", "example": 2, "minimum": 0 } }, "type": "object" }, "CurrentUserInfoResponse": { "required": [ "id", "email", "name", "currentTeamRole", "currentTeamId", "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" }, "currentTeamRole": { "description": "Role of user in the current team", "type": "string", "example": "admin" }, "currentTeamId": { "description": "ID of the current team", "type": "number", "example": 1 }, "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" }, "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" }, "ApiV1Pagination": { "description": "The page the answer carries. Every list of the v1 answers it under `meta`.", "properties": { "page": { "description": "The schemas every endpoint of the public API v1 shares.\n\nThe envelope is the same on every endpoint, so it lives here once. An\nendpoint points at it with a `$ref`, and the generated collection stays\nsmall and consistent.\n\nThe parameters live in ApiV1Parameters, not here. swagger-php drops the\nclass level `OA\\Schema` attributes of a class that also carries a class\nlevel `OA\\Parameter`, so the two kinds need two classes.\n\nThis class holds no code. swagger-php reads the attributes, and nothing\ncalls it.", "type": "integer", "example": 1 }, "per_page": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 137 }, "last_page": { "type": "integer", "example": 6 } }, "type": "object" }, "ApiV1TrialLimit": { "description": "Present only on trial, when the trial hides rows of the list. The trial shows the first rows of a list, and the pagination counts only these rows.", "properties": { "max_rows": { "description": "The number of rows that the trial shows.", "type": "integer", "example": 25 }, "total": { "description": "The true number of rows in the list. It is null for a list that does not count its rows.", "type": [ "integer", "null" ], "example": 137 }, "code": { "type": "string", "example": "trial_list_limited" }, "message": { "type": "string", "example": "The trial shows only the first rows of a list. Subscribe to see all rows." }, "subscribe_url": { "type": "string", "format": "uri", "example": "https://app.sellerassistant.app/subscription" } }, "type": "object" }, "ApiV1BatchMeta": { "description": "The count of a write that took an array.", "properties": { "succeeded": { "type": "integer", "example": 2 }, "failed": { "type": "integer", "example": 1 } }, "type": "object" }, "ApiV1BatchError": { "description": "The reason one row of a batch failed. It is null for a row that went in.", "properties": { "code": { "type": "string", "example": "not_found" }, "message": { "type": "string", "example": "The product [P-1] was not found." } }, "type": [ "object", "null" ] }, "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", "example": "CLOSED", "enum": [ "WORKING", "CLOSED", "CANCELLED", "DELETED" ] }, "LabelPrepType": { "type": "string", "example": "SELLER_LABEL", "enum": [ "NO_LABEL", "SELLER_LABEL" ] }, "AreCasesRequired": { "type": [ "boolean", "null" ], "example": true }, "ConfirmedNeedByDate": { "type": [ "string", "null" ], "format": "date", "example": "2025-05-26" }, "BoxContentsSource": { "type": [ "string", "null" ], "example": "INTERACTIVE", "enum": [ "NONE", "FEED", "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", "example": "Labeling", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "PrepOwner": { "description": "Indicates who will prepare the item.", "type": "string", "example": "SELLER", "enum": [ "AMAZON", "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" ], "example": "eyJNYXJrZXJ...", "maxLength": 1024, "minLength": 1 } }, "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", "example": "ABCDEFGH1234567890ABCDEFGH1234567890", "maxLength": 38, "minLength": 38 }, "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", "example": "ACTIVE", "maxLength": 1024, "minLength": 1, "enum": [ "ACTIVE", "VOIDED", "SHIPPED", "ERRORED" ] } }, "type": "object" }, "Address": { "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ], "properties": { "addressLine1": { "description": "Street address information.", "type": "string", "example": "123 Main St", "maxLength": 180, "minLength": 1 }, "addressLine2": { "description": "Additional street address information.", "type": [ "string", "null" ], "example": "Suite 100", "maxLength": 60, "minLength": 1 }, "city": { "description": "The city.", "type": "string", "example": "Seattle", "maxLength": 30, "minLength": 1 }, "companyName": { "description": "The name of the business.", "type": [ "string", "null" ], "example": "Acme Inc", "maxLength": 50, "minLength": 1 }, "countryCode": { "description": "The country code in two-character ISO 3166-1 alpha-2 format.", "type": "string", "example": "US", "maxLength": 2, "minLength": 2 }, "email": { "description": "The email address.", "type": [ "string", "null" ], "example": "contact@example.com", "maxLength": 1024, "minLength": 1 }, "name": { "description": "The name of the individual who is the primary contact.", "type": "string", "example": "John Doe", "maxLength": 50, "minLength": 1 }, "phoneNumber": { "description": "The phone number.", "type": [ "string", "null" ], "example": "+12065551234", "maxLength": 20, "minLength": 1 }, "postalCode": { "description": "The postal code.", "type": "string", "example": "98109", "maxLength": 32, "minLength": 1 }, "stateOrProvinceCode": { "description": "The state or province code.", "type": [ "string", "null" ], "example": "WA", "maxLength": 64, "minLength": 1 } }, "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", "example": "ABCDEFGH1234567890ABCDEFGH1234567890", "maxLength": 38, "minLength": 38 }, "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", "example": "OFFERED", "maxLength": 1024, "minLength": 1, "enum": [ "OFFERED", "ACCEPTED", "EXPIRED" ] } }, "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", "example": "PLACE1234567890ABCDEFGH1234567890ABCD", "maxLength": 38, "minLength": 38 }, "status": { "description": "The status of a placement option.", "type": "string", "example": "OFFERED", "maxLength": 1024, "minLength": 1, "enum": [ "OFFERED", "ACCEPTED" ] } }, "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", "example": "SHIP1234567890ABCDEFGH1234567890ABCDEF", "maxLength": 38, "minLength": 38 }, "status": { "description": "The status of a shipment.", "type": "string", "example": "UNCONFIRMED", "maxLength": 1024, "minLength": 1, "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ] } }, "type": "object" } }, "sourceAddress": { "$ref": "#/components/schemas/Address" }, "status": { "description": "Current status of the inbound plan.", "type": "string", "example": "ACTIVE", "maxLength": 1024, "minLength": 1, "enum": [ "ACTIVE", "VOIDED", "SHIPPED", "ERRORED" ] } }, "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" ], "example": "eyJNYXJrZXJ...", "maxLength": 1024, "minLength": 1 } }, "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", "example": "PLACE1234567890ABCDEFGH1234567890ABCD", "maxLength": 38, "minLength": 38 }, "shipmentIds": { "description": "Shipment ids.", "type": "array", "items": { "type": "string" }, "example": [ "SHIP1234567890ABCDEFGH1234567890ABCDEF" ] }, "status": { "description": "The status of a placement option.", "type": "string", "example": "OFFERED", "maxLength": 1024, "minLength": 1, "enum": [ "OFFERED", "ACCEPTED", "EXPIRED" ] } }, "type": "object" }, "Incentive": { "required": [ "description", "target", "type", "value" ], "properties": { "description": { "description": "Description of the incentive.", "type": "string", "example": "10% discount on fulfillment fees", "maxLength": 1024, "minLength": 1 }, "target": { "description": "Target of the incentive.", "type": "string", "example": "Fulfillment Fee Discount", "maxLength": 1024, "minLength": 1, "enum": [ "Placement Services", "Fulfillment Fee Discount" ] }, "type": { "description": "Type of incentive.", "type": "string", "example": "DISCOUNT", "maxLength": 1024, "minLength": 1, "enum": [ "FEE", "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", "example": "USD", "maxLength": 3, "minLength": 3 } }, "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", "example": "USPS", "maxLength": 1024, "minLength": 1 }, "name": { "description": "The name of the carrier.", "type": "string", "example": "United States Postal Service", "maxLength": 1024, "minLength": 1 } }, "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", "example": "SHIP1234567890ABCDEFGH1234567890ABCDEF", "maxLength": 38, "minLength": 38 }, "shippingMode": { "description": "Mode of shipment transportation.", "type": "string", "example": "GROUND_SMALL_PARCEL", "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" ] }, "shippingSolution": { "description": "Shipping program for the option.", "type": "string", "example": "AMAZON_PARTNERED_CARRIER", "maxLength": 1024, "minLength": 1, "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ] }, "transportationOptionId": { "description": "Identifier of a transportation option.", "type": "string", "example": "TRANS1234567890ABCDEFGH1234567890ABCD", "maxLength": 38, "minLength": 38 } }, "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", "example": "SELLER", "enum": [ "AMAZON", "SELLER", "NONE" ] }, "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" ], "example": "SELLER", "enum": [ "AMAZON", "SELLER", "NONE" ] }, "prepType": { "description": "Type of preparation that should be done.", "type": [ "string", "null" ], "example": "ITEM_LABELING", "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" ] } }, "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" ], "example": "INTERACTIVE", "enum": [ "INTERACTIVE", "FEED", "NONE" ] }, "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", "example": "OFFERED", "enum": [ "OFFERED", "ACCEPTED", "EXPIRED" ] }, "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", "example": "AMAZON_PARTNERED_CARRIER", "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ] } }, "type": "object" }, "ShippingConfiguration": { "properties": { "shippingMode": { "description": "Mode of shipment transportation that this option will provide.", "type": [ "string", "null" ], "example": "GROUND_SMALL_PARCEL", "enum": [ "GROUND_SMALL_PARCEL", "FREIGHT_LTL", "FREIGHT_FTL_PALLET", "FREIGHT_FTL_NONPALLET", "OCEAN_LCL", "OCEAN_FCL", "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS" ] }, "shippingSolution": { "description": "Shipping program for the option.", "type": [ "string", "null" ], "example": "AMAZON_PARTNERED_CARRIER", "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_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", "example": "USD", "maxLength": 3, "minLength": 3 }, "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" ], "example": "new_new", "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" ] }, "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", "example": "ERROR", "enum": [ "ERROR", "WARNING", "INFO" ] }, "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", "example": "B2C", "enum": [ "B2C", "B2B" ] }, "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", "example": "ALL", "enum": [ "ALL", "B2B" ] }, "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", "example": 1, "minimum": 0 } }, "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", "example": "VARIATION", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ] } }, "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", "example": "INVALID", "enum": [ "ACCEPTED", "INVALID", "VALID" ] }, "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", "example": "replace", "enum": [ "add", "replace", "merge", "delete" ] }, "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" }, "CompetitivePricingError": { "properties": { "code": { "description": "An error code that identifies the type of error that occurred.", "type": "string", "example": "INVALID_REQUEST" }, "message": { "description": "A message that describes the error condition.", "type": "string", "example": "Either asins or skus parameter must be provided" }, "details": { "description": "Additional details that can help the caller understand or fix the issue.", "type": [ "array", "null" ], "items": { "type": "string" } } }, "type": "object" }, "CompetitivePricingProduct": { "properties": { "title": { "type": [ "string", "null" ] }, "identifiers": { "properties": { "marketplaceAsinIdentifier": { "properties": { "marketplaceId": { "type": "string", "example": "ATVPDKIKX0DER" }, "asin": { "type": "string", "example": "B005INDYXY" } }, "type": "object" }, "skuIdentifier": { "properties": { "marketplaceId": { "type": "string" }, "sellerId": { "type": "string" }, "sellerSKU": { "type": "string" } }, "type": [ "object", "null" ] } }, "type": "object" }, "attributeSets": { "type": [ "array", "null" ], "items": { "type": "object" } }, "relationships": { "type": [ "array", "null" ], "items": { "type": "object" } }, "competitivePricing": { "properties": { "competitivePrices": { "type": "array", "items": { "properties": { "competitivePriceId": { "type": "string", "example": "1" }, "price": { "properties": { "landedPrice": { "properties": { "currencyCode": { "type": "string", "example": "USD" }, "amount": { "type": "number", "format": "float", "example": 6.58 } }, "type": "object" }, "listingPrice": { "properties": { "currencyCode": { "type": "string", "example": "USD" }, "amount": { "type": "number", "format": "float", "example": 6.58 } }, "type": "object" }, "shipping": { "properties": { "currencyCode": { "type": "string", "example": "USD" }, "amount": { "type": "number", "format": "float", "example": 0 } }, "type": "object" }, "points": { "properties": { "pointsNumber": { "type": "integer" }, "pointsMonetaryValue": { "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" } }, "type": [ "object", "null" ] } }, "type": "object" }, "condition": { "type": "string", "example": "New" }, "subcondition": { "type": "string", "example": "New" }, "offerType": { "type": [ "string", "null" ], "example": "B2C" }, "quantityTier": { "type": [ "integer", "null" ] }, "quantityDiscountType": { "type": [ "string", "null" ], "example": "QUANTITY_DISCOUNT" }, "sellerId": { "type": [ "string", "null" ] }, "belongsToRequester": { "type": "boolean", "example": false } }, "type": "object" } }, "numberOfOfferListings": { "type": "array", "items": { "properties": { "count": { "type": "integer", "example": 25 }, "condition": { "type": "string", "example": "New" } }, "type": "object" } }, "tradeInValue": { "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": [ "object", "null" ] } }, "type": "object" }, "salesRankings": { "type": "array", "items": { "properties": { "productCategoryId": { "type": "string", "example": "kitchen_display_on_website" }, "rank": { "type": "integer", "example": 55037 } }, "type": "object" } }, "offers": { "type": [ "array", "null" ], "items": { "properties": { "offerType": { "type": "string", "example": "B2C" }, "buyingPrice": { "properties": { "landedPrice": { "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" }, "listingPrice": { "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" }, "shipping": { "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" }, "points": { "properties": { "pointsNumber": { "type": "integer" }, "pointsMonetaryValue": { "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "regularPrice": { "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" }, "businessPrice": { "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" }, "quantityDiscountPrices": { "type": "array", "items": { "properties": { "quantityTier": { "type": "integer" }, "quantityDiscountType": { "type": "string", "example": "QUANTITY_DISCOUNT" }, "listingPrice": { "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" } }, "fulfillmentChannel": { "type": "string" }, "itemCondition": { "type": "string" }, "itemSubCondition": { "type": "string" }, "sellerSku": { "type": "string" } }, "type": "object" } } }, "type": "object" }, "CompetitivePricingItem": { "required": [ "status" ], "properties": { "status": { "description": "Operation status", "type": "string", "example": "Success" }, "sellerSku": { "description": "The seller stock keeping unit (SKU) of the item.", "type": [ "string", "null" ] }, "asin": { "description": "The Amazon Standard Identification Number of the item.", "type": [ "string", "null" ], "example": "B005INDYXY" }, "product": { "oneOf": [ { "$ref": "#/components/schemas/CompetitivePricingProduct", "description": "Product metadata object for the item." }, { "type": "null" } ], "description": "Product metadata object for the item." }, "errors": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CompetitivePricingError" } } }, "type": "object" }, "CompetitivePricingResponse": { "properties": { "payload": { "description": "Array of competitive pricing items (max 20 entries).", "type": "array", "items": { "$ref": "#/components/schemas/CompetitivePricingItem" } } }, "type": "object" }, "CompetitiveSummaryError": { "properties": { "code": { "description": "An error code that identifies the type of error that occurred.", "type": "string", "example": "INVALID_REQUEST" }, "message": { "description": "A message that describes the error condition.", "type": "string", "example": "Invalid ASIN format" }, "details": { "description": "Additional details that can help the caller understand or fix the issue.", "type": [ "array", "null" ], "items": { "type": "string" } } }, "type": "object" }, "CompetitiveSummaryResponse": { "properties": { "responses": { "type": "array", "items": { "properties": { "status": { "properties": { "statusCode": { "type": "integer", "example": 200 }, "reasonPhrase": { "type": "string", "example": "Success" } }, "type": "object" }, "body": { "properties": { "asin": { "type": "string", "example": "B00ZIAODGE" }, "marketplaceId": { "type": "string", "example": "ATVPDKIKX0DER" }, "featuredBuyingOptions": { "type": [ "array", "null" ], "items": { "properties": { "buyingOptionType": { "type": "string", "example": "New" }, "segmentedFeaturedOffers": { "type": "array", "items": { "properties": { "sellerId": { "type": "string", "example": "A2R2RITDJNW1Q6" }, "condition": { "type": "string", "example": "New" }, "fulfillmentType": { "type": "string", "example": "AFN" }, "listingPrice": { "properties": { "currencyCode": { "type": "string", "example": "USD" }, "amount": { "type": "number", "format": "float", "example": 11.88 } }, "type": "object" }, "featuredOfferSegments": { "type": "array", "items": { "properties": { "customerMembership": { "type": "string", "example": "PRIME" }, "segmentDetails": { "properties": { "glanceViewWeightPercentage": { "type": "number", "format": "float", "example": 33.33 }, "sampleLocation": { "properties": { "postalCode": { "properties": { "countryCode": { "type": "string", "example": "US" }, "value": { "type": "string", "example": "23221" } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "subCondition": { "type": [ "string", "null" ] }, "shippingOptions": { "type": "array", "items": { "properties": { "shippingOptionType": { "type": "string", "example": "DEFAULT" }, "price": { "properties": { "currencyCode": { "type": "string", "example": "USD" }, "amount": { "type": "number", "format": "float", "example": 0 } }, "type": "object" } }, "type": "object" } }, "points": { "type": [ "string", "null" ] }, "primeDetails": { "type": [ "string", "null" ] } }, "type": "object" } } }, "type": "object" } }, "lowestPricedOffers": { "type": [ "array", "null" ], "items": { "properties": { "lowestPricedOffersInput": { "properties": { "itemCondition": { "type": "string", "example": "New" }, "offerType": { "type": "string", "example": "Consumer" } }, "type": "object" }, "offers": { "type": "array", "items": { "properties": { "sellerId": { "type": "string", "example": "A2R2RITDJNW1Q6" }, "condition": { "type": "string", "example": "New" }, "fulfillmentType": { "type": "string", "example": "AFN" }, "listingPrice": { "properties": { "currencyCode": { "type": "string", "example": "USD" }, "amount": { "type": "number", "format": "float", "example": 11.88 } }, "type": "object" }, "subCondition": { "type": "string", "example": "New" }, "shippingOptions": { "type": "array", "items": { "properties": { "shippingOptionType": { "type": "string", "example": "DEFAULT" }, "price": { "properties": { "currencyCode": { "type": "string", "example": "USD" }, "amount": { "type": "number", "format": "float", "example": 0 } }, "type": "object" } }, "type": "object" } }, "points": { "type": [ "string", "null" ] }, "primeDetails": { "properties": { "eligibility": { "type": "string", "example": "NATIONAL" } }, "type": [ "object", "null" ] } }, "type": "object" } } }, "type": "object" } }, "referencePrices": { "type": [ "array", "null" ], "items": { "properties": { "name": { "type": "string", "example": "CompetitivePrice" }, "price": { "properties": { "currencyCode": { "type": "string", "example": "USD" }, "amount": { "type": "number", "format": "float", "example": 13.98 } }, "type": "object" } }, "type": "object" } }, "errors": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CompetitiveSummaryError" } } }, "type": "object" } }, "type": "object" } } }, "type": "object" } }, "responses": { "BadRequest": { "description": "Bad request - validation failed or invalid parameters", "content": { "application/json": { "schema": { "required": [ "code", "message", "trace_id" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "validation_failed" }, "message": { "description": "Error message. It repeats the first entry of `errors`.", "type": "string", "example": "The selected domain is invalid." }, "trace_id": { "description": "Id of the error, to find it in the logs. Read this one.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" }, "traceId": { "description": "The same id in the older spelling. Only an endpoint that predates DEV-620 sends it, and only until its clients move to trace_id. The endpoints this ticket added or reworked send trace_id alone.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c", "deprecated": true }, "errors": { "description": "One entry for each field that failed, with every message of that field. Present when the validation refused the call.", "type": "object", "example": { "filter.supplier_id": [ "The filter [supplier_id] must be an integer of 1 or more." ] }, "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object" } } } }, "PaymentRequired": { "description": "Payment Required - subscription expired or payment method required", "content": { "application/json": { "schema": { "required": [ "code", "message", "trace_id" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "subscription_required" }, "message": { "description": "Error message", "type": "string", "example": "Subscription Required" }, "trace_id": { "description": "Id of the error, to find it in the logs. Read this one.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" }, "traceId": { "description": "The same id in the older spelling. Only an endpoint that predates DEV-620 sends it, and only until its clients move to trace_id. The endpoints this ticket added or reworked send trace_id alone.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c", "deprecated": true } }, "type": "object" } } } }, "AccessDenied": { "description": "Access denied - insufficient permissions, invalid API key, or the API request limit is used up (`public_api_key_limit`)", "content": { "application/json": { "schema": { "required": [ "code", "message", "trace_id" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "access_denied" }, "message": { "description": "Error message", "type": "string", "example": "API Token is invalid" }, "trial_code": { "description": "Present on trial when the trial cap of API requests is used up.", "type": "string", "example": "trial_limit_reached" }, "trial_message": { "description": "Present on trial. The message to show the user.", "type": "string", "example": "Trial limit reached. Subscribe for full plan limits." }, "subscribe_url": { "description": "Present on trial. The page where the user subscribes.", "type": "string", "format": "uri", "example": "https://app.sellerassistant.app/subscription" }, "trace_id": { "description": "Id of the error, to find it in the logs. Read this one.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" }, "traceId": { "description": "The same id in the older spelling. Only an endpoint that predates DEV-620 sends it, and only until its clients move to trace_id. The endpoints this ticket added or reworked send trace_id alone.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c", "deprecated": true } }, "type": "object" } } } }, "NotFound": { "description": "Resource not found", "content": { "application/json": { "schema": { "required": [ "code", "message", "trace_id" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "not_found" }, "message": { "description": "Error message", "type": "string", "example": "Resource not found" }, "trace_id": { "description": "Id of the error, to find it in the logs. Read this one.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" }, "traceId": { "description": "The same id in the older spelling. Only an endpoint that predates DEV-620 sends it, and only until its clients move to trace_id. The endpoints this ticket added or reworked send trace_id alone.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c", "deprecated": true } }, "type": "object" } } } }, "BusinessLogicError": { "description": "Business logic error - operation cannot be completed due to business rules", "content": { "application/json": { "schema": { "required": [ "code", "message", "trace_id" ], "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" }, "trace_id": { "description": "Id of the error, to find it in the logs. Read this one.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" }, "traceId": { "description": "The same id in the older spelling. Only an endpoint that predates DEV-620 sends it, and only until its clients move to trace_id. The endpoints this ticket added or reworked send trace_id alone.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c", "deprecated": true } }, "type": "object" } } } }, "ServiceUnavailable": { "description": "A service of ours did not answer. The call is right, and it can run again later.", "content": { "application/json": { "schema": { "required": [ "code", "message", "trace_id" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unavailable" }, "message": { "description": "What did not work, in one sentence. The names of the services and of the classes stay in the log.", "type": "string", "example": "The document could not be processed. Upload it again in a few minutes." }, "trace_id": { "description": "Id of the error, to find it in the logs. Read this one.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" } }, "type": "object" } } } }, "Conflict": { "description": "Conflict - the row is there, and another row already holds the place the call asks for", "content": { "application/json": { "schema": { "required": [ "code", "message", "trace_id" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "conflict" }, "message": { "description": "Error message. It names the row that holds the place.", "type": "string", "example": "PO item #4471 is already linked to SKU 'SA-NLL8-GL7X' (ID: 822). Unlink it first." }, "trace_id": { "description": "Id of the error, to find it in the logs. Read this one.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" }, "traceId": { "description": "The same id in the older spelling. Only an endpoint that predates DEV-620 sends it, and only until its clients move to trace_id. The endpoints this ticket added or reworked send trace_id alone.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c", "deprecated": true } }, "type": "object" } } } }, "TooManyRequests": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "required": [ "code", "message", "trace_id" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "too_many_requests" }, "message": { "description": "Error message", "type": "string", "example": "Too Many Requests" }, "trace_id": { "description": "Id of the error, to find it in the logs. Read this one.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" }, "traceId": { "description": "The same id in the older spelling. Only an endpoint that predates DEV-620 sends it, and only until its clients move to trace_id. The endpoints this ticket added or reworked send trace_id alone.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c", "deprecated": true } }, "type": "object" } } } }, "InternalError": { "description": "Internal server error", "content": { "application/json": { "schema": { "required": [ "code", "message", "trace_id" ], "properties": { "code": { "description": "API error code", "type": "string", "example": "unknown" }, "message": { "description": "Error message", "type": "string", "example": "An unknown error occurred" }, "trace_id": { "description": "Id of the error, to find it in the logs. Read this one.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c" }, "traceId": { "description": "The same id in the older spelling. Only an endpoint that predates DEV-620 sends it, and only until its clients move to trace_id. The endpoints this ticket added or reworked send trace_id alone.", "type": "string", "example": "7d7f121a-06a3-419b-8136-63dac0d5321c", "deprecated": true } }, "type": "object" } } } } }, "parameters": { "ApiV1Page": { "name": "page", "in": "query", "description": "The page to read. It starts at 1.", "required": false, "schema": { "type": "integer", "example": 1, "minimum": 1 } }, "ApiV1PerPage": { "name": "per_page", "in": "query", "description": "The rows a page carries. The maximum is 200.", "required": false, "schema": { "type": "integer", "example": 25, "maximum": 200, "minimum": 1 } }, "ApiV1Search": { "name": "search", "in": "query", "description": "A term the list looks for. Each list names the columns it reads.", "required": false, "schema": { "type": "string", "maxLength": 255 } }, "ApiV1Sort": { "name": "sort", "in": "query", "description": "The column to order by. A minus sign in front of the name orders from the highest down, as in `-created_at`.", "required": false, "schema": { "type": "string", "example": "-created_at" } } }, "securitySchemes": { "api_key": { "type": "apiKey", "description": "Generate an API key on the [API Keys](https://app.sellerassistant.app/settings/api-keys) page of your Seller Assistant account. Send the API key in the `X-Api-Key` header. Do not put the key in the URL: the server rejects the `api_key` and `api_token` query parameters. Seller Assistant shows the key one time only, when you create it.", "name": "X-Api-Key", "in": "header" }, "oauth2": { "type": "oauth2", "description": "OAuth 2.0 Authorization Code with PKCE — used by AI agents (Claude, ChatGPT) to access the API on behalf of a user.", "flows": { "authorizationCode": { "authorizationUrl": "https://app.sellerassistant.app/oauth/authorize", "tokenUrl": "https://app.sellerassistant.app/oauth/token", "refreshUrl": "https://app.sellerassistant.app/oauth/token", "scopes": { "read_write": "Access and manage your data (products, inventory, suppliers, listings, and more)" } } } } } }, "tags": [ { "name": "Inventory Products (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Product History (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Suppliers (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Supplier Offers (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Warehouses (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Purchase Orders (Beta)", "description": "Beta: this section can change without notice." }, { "name": "SKUs (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Listings (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Repricer (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Seller Spy (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Tags (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Notes (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Documents (Beta)", "description": "Beta: this section can change without notice." }, { "name": "Account (Beta)", "description": "Beta: this section can change without notice." }, { "name": "IP-Alert (Beta)", "description": "Beta: this section can change without notice. The IP-Alert warnings of an ASIN, of a brand or of the storefront of a seller, as the High-Risk Product note of the extension shows them. See [IP-Alert warning types](https://help.sellerassistant.app/en/articles/18320816-ip-alert-warning-types-in-seller-assistant). Ask by product, by brand or by a seller that the team tracks in Seller Spy." }, { "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": "Price List Analyzer", "description": "Price List Analyzer" }, { "name": "Products", "description": "Products" }, { "name": "Restrictions", "description": "Restrictions" }, { "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" }, { "name": "SP-API Product Pricing", "description": "SP-API Product Pricing" } ] }