{ "openapi": "3.2.0", "info": { "title": "ScanPower API Docs", "version": "3.0.0", "description": "Public APIs for accessing ScanPower data and functions" }, "servers": [ { "url": "https://localhost:3001/api", "description": "Local development server" }, { "url": "https://beta.scanpower.com/api", "description": "US east region" }, { "url": "https://west.scanpower.com/api", "description": "US west region" }, { "url": "https://uk.scanpower.com/api", "description": "EU west region" } ], "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "BasicAuth": { "type": "http", "scheme": "basic" } }, "schemas": { "ArchiveSuppliersResponse": { "type": "object", "properties": { "suppliers": { "type": "array", "items": { "type": "object", "properties": { "supplier_id": { "type": "string" }, "archived": { "type": [ "string", "null" ], "format": "date-time" } } } } }, "required": [ "suppliers" ] }, "ArchiveSuppliersSearchParams": { "type": "object", "properties": { "supplier_ids": { "type": "string", "description": "comma separated list of `supplier_id`s" } }, "required": [ "supplier_ids" ] }, "Attachment": { "type": "object", "properties": { "attachment_id": { "type": "string" }, "user_id": { "type": "string" }, "file_name": { "type": "string", "description": "The name of the attached file" }, "content_type": { "type": [ "string", "null" ], "description": "The name of the attached file" }, "file_uri": { "type": [ "string", "null" ], "description": "The MIME type of the attached file" }, "file_data": { "type": [ "string", "null" ], "description": "If the file is hosted externally, this will be a link to that file" }, "file_size": { "type": [ "number", "null" ], "description": "Small files may be stored here" }, "created": { "type": "string", "format": "date-time", "description": "The size of the attached file in bytes" }, "created_by": { "type": [ "string", "null" ] } }, "required": [ "attachment_id", "user_id", "file_name", "content_type", "file_uri", "file_data", "file_size", "created", "created_by" ] }, "AuthHeaders": { "type": "object", "properties": {} }, "AuthResponse": { "oneOf": [ { "type": "object", "properties": { "access_token": { "type": "string", "description": "The access token" }, "expires_in": { "type": "number", "description": "The lifetime in seconds of the access token" }, "scope": { "type": "string", "description": "Space separated list of paths that the access token is valid for" }, "state": { "type": "string", "description": "The exact value received from the client" }, "token_type": { "type": "string", "enum": [ "bearer" ], "description": "The type of the token (See [rfc6750](https://www.rfc-editor.org/rfc/rfc6750))" } } }, { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "number" }, "data": {}, "message": { "type": "string" } }, "required": [ "message" ] } } } }, { "type": "object", "properties": { "id": { "type": "string" }, "child": { "type": "string" }, "proxier": { "type": "string" }, "admin": { "type": "string" }, "iat": { "type": "number" }, "exp": { "type": "number" }, "rl": { "type": "string" } }, "required": [ "id" ] } ] }, "az_shipment_status": { "type": "string", "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ] }, "AzBoxItem": { "type": "object", "properties": { "box_item_id": { "type": "string" }, "user_id": { "type": "string" }, "box_id": { "type": "number" }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "external_id": { "type": "string" }, "sku": { "type": "string" }, "fnsku": { "type": [ "string", "null" ] }, "label_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ] }, "prep_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ] }, "manufacturing_lot_code": { "type": [ "string", "null" ] }, "prep_instructions": { "anyOf": [ {}, { "type": "null" } ] }, "quantity": { "type": "number" }, "packing_group_id": { "type": [ "string", "null" ] }, "plan_item_id": { "type": [ "number", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "box_item_id", "user_id", "box_id", "expires", "external_id", "sku", "fnsku", "label_owner", "prep_owner", "manufacturing_lot_code", "prep_instructions", "quantity", "packing_group_id", "plan_item_id", "created", "created_by", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by" ] }, "AzPallet": { "type": "object", "properties": { "pallet_id": { "type": "number" }, "user_id": { "type": "string" }, "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ] }, "inbound_plan_id": { "type": "string" }, "placement_option_id": { "type": [ "string", "null" ] }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": "number" }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "pallet_id", "user_id", "shipment_id", "plan_id", "index", "quantity", "stackability", "inbound_plan_id", "placement_option_id", "length", "width", "height", "unit_of_measurement", "weight", "unit_of_weight", "created", "created_by", "creation_source", "updated", "updated_by", "deleted", "deleted_by" ] }, "AzProcessingStatus": { "type": "string", "enum": [ "WAIT", "PREPARING", "QUEUEING", "SUBMITTED", "IN_PROGRESS", "CANCELLED", "DONE", "DONE_NO_DATA", "ERROR", "FATAL" ] }, "AzProductData": { "type": "object", "properties": {} }, "AzReport": { "type": "object", "properties": { "reportType": { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, "reportId": { "type": "string" }, "processingStatus": { "type": "string", "enum": [ "WAIT", "PREPARING", "QUEUEING", "SUBMITTED", "IN_PROGRESS", "CANCELLED", "DONE", "DONE_NO_DATA", "ERROR", "FATAL" ] }, "reportDocumentId": { "type": "string" } } }, "AzReportType": { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, "AzShipment": { "type": "object", "properties": { "shipment_id": { "type": "string" }, "user_id": { "type": "string" }, "plan_id": { "type": [ "string", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ], "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "synced": { "type": [ "string", "null" ], "format": "date-time" }, "inbound_plan_id": { "type": "string" }, "placement_option_id": { "type": [ "string", "null" ] }, "shipping_solution": { "type": [ "string", "null" ], "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ] }, "selected_transportation_option_id": { "type": [ "string", "null" ] }, "confirmed_transportation_option_id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "amazon_reference_id": { "type": [ "string", "null" ] }, "contact_information": { "anyOf": [ {}, { "type": "null" } ] }, "dates": { "anyOf": [ {}, { "type": "null" } ] }, "destination": { "anyOf": [ {}, { "type": "null" } ] }, "freight_information": { "anyOf": [ {}, { "type": "null" } ] }, "selected_delivery_window": { "anyOf": [ {}, { "type": "null" } ] }, "self_ship_appointment_details": { "anyOf": [ {}, { "type": "null" } ] }, "shipment_confirmation_id": { "type": [ "string", "null" ] }, "tracking_details": { "anyOf": [ {}, { "type": "null" } ] }, "update_shipment_tracking_details_operation": { "anyOf": [ {}, { "type": "null" } ] }, "update_shipment_tracking_details_operation_at": { "type": [ "string", "null" ], "format": "date-time" }, "boxes": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": "string", "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": "string", "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": "string", "description": "Template name of the box." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] } }, "boxes_update": { "anyOf": [ {}, { "type": "null" } ] }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] } }, "ship_date": { "type": [ "string", "null" ], "format": "date-time" }, "shipping_mode": { "type": [ "string", "null" ], "enum": [ "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS", "FREIGHT_FTL_NONPALLET", "FREIGHT_FTL_PALLET", "FREIGHT_LTL", "GROUND_SMALL_PARCEL", "OCEAN_FCL", "OCEAN_LCL" ] }, "dirty": { "type": [ "boolean", "null" ] }, "selected_delivery_window_option_id": { "type": [ "string", "null" ], "description": "Which delivery window the user has selected from the drop down, but not necessarily accepted yet" } }, "required": [ "shipment_id", "user_id", "plan_id", "marketplace_id", "ship_from_id", "status", "created", "created_by", "creation_source", "updated", "updated_by", "deleted", "deleted_by", "synced", "inbound_plan_id", "placement_option_id", "shipping_solution", "selected_transportation_option_id", "confirmed_transportation_option_id", "name", "amazon_reference_id", "contact_information", "dates", "destination", "freight_information", "selected_delivery_window", "self_ship_appointment_details", "shipment_confirmation_id", "tracking_details", "update_shipment_tracking_details_operation", "update_shipment_tracking_details_operation_at", "boxes", "boxes_update", "items", "ship_date", "shipping_mode", "dirty", "selected_delivery_window_option_id" ] }, "AzShipmentBoxes": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": "string", "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": "string", "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": "string", "description": "Template name of the box." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] } }, "AzShipmentItems": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] } }, "AzShipmentLog": { "type": "object", "properties": { "shipment_log_id": { "type": "string" }, "user_id": { "type": "string" }, "inbound_plan_id": { "type": "string" }, "shipment_id": { "type": "string" }, "status": { "type": [ "string", "null" ], "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ] }, "running_status": { "type": [ "string", "null" ], "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ] }, "name": { "type": [ "string", "null" ] }, "running_name": { "type": [ "string", "null" ] }, "ship_from_id": { "type": [ "string", "null" ] }, "running_ship_from_id": { "type": [ "string", "null" ] }, "via_sync": { "type": "boolean" }, "shipment_confirmation_id": { "type": [ "string", "null" ] }, "running_shipment_confirmation_id": { "type": [ "string", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": "string" } }, "required": [ "shipment_log_id", "user_id", "inbound_plan_id", "shipment_id", "status", "running_status", "name", "running_name", "ship_from_id", "running_ship_from_id", "via_sync", "shipment_confirmation_id", "running_shipment_confirmation_id", "created", "created_by" ] }, "box_content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ] }, "BulkUpdateLocationsBody": { "type": "object", "properties": { "location": { "type": "object", "properties": { "location_name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "location_type": { "type": [ "string", "null" ], "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ] }, "ship_from_id": { "type": [ "string", "null" ] } }, "nullable": false } }, "required": [ "location" ] }, "BulkUpdatePurchaseOrdersBody": { "type": "object", "properties": { "purchase_order": { "type": "object", "properties": { "purchase_order_name": { "type": [ "string", "null" ] }, "ship_from_id": { "type": [ "string", "null" ], "description": "The ID of the supplier." }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false, "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view", "nullable": false }, "expected_delivery_date": { "type": "string", "format": "date-time", "nullable": false, "description": "A transitional column marking this PO created in the WFS plan view" }, "purchase_order_status": { "type": [ "string", "null" ], "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "supplier": { "type": [ "string", "null" ] }, "archived": { "type": [ "boolean", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_name": { "type": "string", "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_id": { "type": [ "string", "null" ] } } } } }, "nullable": false } }, "required": [ "purchase_order" ] }, "BulkUpdatePurchaseOrdersPathParams": { "type": "object", "properties": { "purchase_order_id": { "type": "string", "description": "comma separated list of `purchase_order_id`s" } }, "required": [ "purchase_order_id" ] }, "BulkUpdatePurchaseOrdersResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "number" }, "data": {}, "message": { "type": "string" } }, "required": [ "message" ] } }, "purchase_orders": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "purchase_order_name": { "type": "string" }, "user_id": { "type": "string" }, "ship_from_id": { "type": "string", "description": "The ID of the supplier." }, "created": { "type": "string", "format": "date-time", "description": "The ID of the supplier." }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_status": { "type": "string", "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view" }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time", "description": "A transitional column marking this PO created in the WFS plan view" } }, "required": [ "purchase_order_id", "purchase_order_name", "user_id", "ship_from_id", "created", "created_by", "creation_source", "purchase_order_status", "purchase_order_date", "supplier_id", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by", "external_id", "notes", "attachment_id", "wfs", "expected_delivery_date" ] } } } }, "CancelBookingParams": { "type": "object", "properties": { "shipmentId": { "type": "string" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "shipmentId", "mode", "mp" ] }, "CancelBookingResponse": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ] }, "CancelInboundPlanErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "CancelInboundPlanResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "CancelInboundPlanSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "put_back": { "type": "boolean" } } }, "CancelShipmentParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "inboundOrderId": { "type": "string" }, "put_back": { "type": "boolean" } }, "required": [ "inboundOrderId" ] }, "CancelShipmentResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "status": { "type": "string", "enum": [ "OK", "CREATED", "ACCEPTED", "NO_CONTENT", "PARTIAL", "MOVED_PERMANENT", "FOUND", "SEE_OTHER", "NOT_MODIFIED", "TEMPORARY_REDIRECT", "BAD_REQUEST", "UNAUTHORIZED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "REQUEST_TIMEOUT", "CONFLICT", "REQUEST_ENTITY_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "UNPROCESSABLE_ENTITY", "TOO_MANY_REQUESTS", "FAIL", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "GATEWAY_TIMEOUT" ] }, "header": { "type": "object", "additionalProperties": {} }, "payload": { "type": "object", "additionalProperties": {} } } }, "catalogItems_2022_04_01_BrandRefinement": { "type": "object", "properties": { "numberOfResults": { "type": "number", "description": "The estimated number of results that would be returned if you refine your search by the specified `brandName`." }, "brandName": { "type": "string", "description": "The brand name that you can use to refine your search." } }, "required": [ "numberOfResults", "brandName" ] }, "catalogItems_2022_04_01_ClassificationRefinement": { "type": "object", "properties": { "numberOfResults": { "type": "number", "description": "The estimated number of results that would be returned if you refine your search by the specified `classificationId`." }, "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "The identifier of the classification that you can use to refine your search." } }, "required": [ "numberOfResults", "displayName", "classificationId" ] }, "catalogItems_2022_04_01_Dimension": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "catalogItems_2022_04_01_Dimensions": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } } }, "catalogItems_2022_04_01_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "catalogItems_2022_04_01_Item": { "type": "object", "properties": { "asin": { "type": "string" }, "attributes": {}, "classifications": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ] }, "description": "Classifications (browse nodes) that are associated with the item in the Amazon catalog." } }, "required": [ "marketplaceId" ] } }, "dimensions": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "item": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } }, "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "package": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } } } }, "required": [ "marketplaceId" ] } }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).identifier." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "identifierType": { "type": "string", "description": "Type of identifier, such as UPC, EAN, or ISBN." }, "identifier": { "type": "string", "description": "Identifier of the item." } }, "required": [ "identifierType", "identifier" ] }, "description": "Identifiers associated with the item in the Amazon catalog for the indicated `marketplaceId`." } }, "required": [ "marketplaceId", "identifiers" ] } }, "images": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "images": { "type": "array", "items": { "type": "object", "properties": { "variant": { "type": "string", "enum": [ "MAIN", "PT01", "PT02", "PT03", "PT04", "PT05", "PT06", "PT07", "PT08", "SWCH" ], "description": "Variant of the image, such as `MAIN` or `PT01`." }, "link": { "type": "string", "description": "URL for the image." }, "height": { "type": "number", "description": "Height of the image in pixels." }, "width": { "type": "number", "description": "Width of the image in pixels." } }, "required": [ "variant", "link", "height", "width" ] }, "description": "Images for an item in the Amazon catalog, grouped by `marketplaceId`." } }, "required": [ "marketplaceId", "images" ] } }, "productTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "productType": { "type": "string", "description": "Name of the product type that is associated with the Amazon catalog item." } } } }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are children of this item." }, "parentAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are parents of this item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "Names of the Amazon catalog item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family." } }, "description": "ASINs of the related items that are parents of this item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "Type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the item." } }, "required": [ "marketplaceId", "relationships" ] } }, "salesRanks": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classificationRanks": { "type": "array", "items": { "type": "object", "properties": { "classificationId": { "type": "string", "description": "Identifier of the classification that is associated with the sales rank." }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales category." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "classificationId", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification." }, "displayGroupRanks": { "type": "array", "items": { "type": "object", "properties": { "websiteDisplayGroup": { "type": "string", "description": "Name of the website display group that is associated with the sales rank" }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales rank." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "websiteDisplayGroup", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group." } }, "required": [ "marketplaceId" ] } }, "summaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "adultProduct": { "type": "boolean", "description": "When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature." }, "autographed": { "type": "boolean", "description": "When `true`, the Amazon catalog item is autographed." }, "brand": { "type": "string", "description": "Name of the brand that is associated with the Amazon catalog item." }, "browseClassification": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ], "description": "Name of the brand that is associated with the Amazon catalog item." }, "color": { "type": "string", "description": "The color that is associated with the Amazon catalog item." }, "contributors": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name of the role in the requested locale, such as `Author` or `Actor`." }, "value": { "type": "string", "description": "Role value for the Amazon catalog item, such as `author` or `actor`." } }, "required": [ "value" ] }, "value": { "type": "string", "description": "Name of the contributor, such as `Jane Austen`." } }, "required": [ "role", "value" ] }, "description": "Individual contributors to the creation of the item, such as the authors or actors." }, "itemClassification": { "type": "string", "enum": [ "BASE_PRODUCT", "OTHER", "PRODUCT_BUNDLE", "VARIATION_PARENT" ], "description": "Classification type that is associated with the Amazon catalog item." }, "itemName": { "type": "string", "description": "The name that is associated with the Amazon catalog item." }, "manufacturer": { "type": "string", "description": "The name of the manufacturer that is associated with the Amazon catalog item." }, "memorabilia": { "type": "boolean", "description": "When true, the item is classified as memorabilia." }, "modelNumber": { "type": "string", "description": "The model number that is associated with the Amazon catalog item." }, "packageQuantity": { "type": "number", "description": "The quantity of the Amazon catalog item within one package." }, "partNumber": { "type": "string", "description": "The part number that is associated with the Amazon catalog item." }, "releaseDate": { "type": "string", "description": "The earliest date on which the Amazon catalog item can be shipped to customers." }, "size": { "type": "string", "description": "The name of the size of the Amazon catalog item." }, "style": { "type": "string", "description": "The name of the style that is associated with the Amazon catalog item." }, "tradeInEligible": { "type": "boolean", "description": "When true, the Amazon catalog item is eligible for trade-in." }, "websiteDisplayGroup": { "type": "string", "description": "The identifier of the website display group that is associated with the Amazon catalog item." }, "websiteDisplayGroupName": { "type": "string", "description": "The display name of the website display group that is associated with the Amazon catalog item." } }, "required": [ "marketplaceId" ] } }, "vendorDetails": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "brandCode": { "type": "string", "description": "The brand code that is associated with an Amazon catalog item." }, "manufacturerCode": { "type": "string", "description": "The manufacturer code that is associated with an Amazon catalog item." }, "manufacturerCodeParent": { "type": "string", "description": "The parent vendor code of the manufacturer code." }, "productCategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The parent vendor code of the manufacturer code." }, "productGroup": { "type": "string", "description": "The product group that is associated with an Amazon catalog item." }, "productSubcategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The product group that is associated with an Amazon catalog item." }, "replenishmentCategory": { "type": "string", "enum": [ "ALLOCATED", "BASIC_REPLENISHMENT", "IN_SEASON", "LIMITED_REPLENISHMENT", "MANUFACTURER_OUT_OF_STOCK", "NEW_PRODUCT", "NON_REPLENISHABLE", "NON_STOCKUPABLE", "OBSOLETE", "PLANNED_REPLENISHMENT" ], "description": "The replenishment category that is associated with an Amazon catalog item." } }, "required": [ "marketplaceId" ] } } }, "required": [ "asin" ] }, "catalogItems_2022_04_01_ItemAsin": { "type": "string" }, "catalogItems_2022_04_01_ItemAttributes": {}, "catalogItems_2022_04_01_ItemBrowseClassification": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ] }, "catalogItems_2022_04_01_ItemBrowseClassifications": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ] }, "description": "Classifications (browse nodes) that are associated with the item in the Amazon catalog." } }, "required": [ "marketplaceId" ] } }, "catalogItems_2022_04_01_ItemBrowseClassificationsByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ] }, "description": "Classifications (browse nodes) that are associated with the item in the Amazon catalog." } }, "required": [ "marketplaceId" ] }, "catalogItems_2022_04_01_ItemClassificationSalesRank": { "type": "object", "properties": { "classificationId": { "type": "string", "description": "Identifier of the classification that is associated with the sales rank." }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales category." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "classificationId", "title", "rank" ] }, "catalogItems_2022_04_01_ItemContributor": { "type": "object", "properties": { "role": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name of the role in the requested locale, such as `Author` or `Actor`." }, "value": { "type": "string", "description": "Role value for the Amazon catalog item, such as `author` or `actor`." } }, "required": [ "value" ] }, "value": { "type": "string", "description": "Name of the contributor, such as `Jane Austen`." } }, "required": [ "role", "value" ] }, "catalogItems_2022_04_01_ItemContributorRole": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name of the role in the requested locale, such as `Author` or `Actor`." }, "value": { "type": "string", "description": "Role value for the Amazon catalog item, such as `author` or `actor`." } }, "required": [ "value" ] }, "catalogItems_2022_04_01_ItemDimensions": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "item": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } }, "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "package": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } } } }, "required": [ "marketplaceId" ] } }, "catalogItems_2022_04_01_ItemDimensionsByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "item": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } }, "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "package": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } } } }, "required": [ "marketplaceId" ] }, "catalogItems_2022_04_01_ItemDisplayGroupSalesRank": { "type": "object", "properties": { "websiteDisplayGroup": { "type": "string", "description": "Name of the website display group that is associated with the sales rank" }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales rank." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "websiteDisplayGroup", "title", "rank" ] }, "catalogItems_2022_04_01_ItemIdentifier": { "type": "object", "properties": { "identifierType": { "type": "string", "description": "Type of identifier, such as UPC, EAN, or ISBN." }, "identifier": { "type": "string", "description": "Identifier of the item." } }, "required": [ "identifierType", "identifier" ] }, "catalogItems_2022_04_01_ItemIdentifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).identifier." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "identifierType": { "type": "string", "description": "Type of identifier, such as UPC, EAN, or ISBN." }, "identifier": { "type": "string", "description": "Identifier of the item." } }, "required": [ "identifierType", "identifier" ] }, "description": "Identifiers associated with the item in the Amazon catalog for the indicated `marketplaceId`." } }, "required": [ "marketplaceId", "identifiers" ] } }, "catalogItems_2022_04_01_ItemIdentifiersByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).identifier." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "identifierType": { "type": "string", "description": "Type of identifier, such as UPC, EAN, or ISBN." }, "identifier": { "type": "string", "description": "Identifier of the item." } }, "required": [ "identifierType", "identifier" ] }, "description": "Identifiers associated with the item in the Amazon catalog for the indicated `marketplaceId`." } }, "required": [ "marketplaceId", "identifiers" ] }, "catalogItems_2022_04_01_ItemImage": { "type": "object", "properties": { "variant": { "type": "string", "enum": [ "MAIN", "PT01", "PT02", "PT03", "PT04", "PT05", "PT06", "PT07", "PT08", "SWCH" ], "description": "Variant of the image, such as `MAIN` or `PT01`." }, "link": { "type": "string", "description": "URL for the image." }, "height": { "type": "number", "description": "Height of the image in pixels." }, "width": { "type": "number", "description": "Width of the image in pixels." } }, "required": [ "variant", "link", "height", "width" ] }, "catalogItems_2022_04_01_ItemImages": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "images": { "type": "array", "items": { "type": "object", "properties": { "variant": { "type": "string", "enum": [ "MAIN", "PT01", "PT02", "PT03", "PT04", "PT05", "PT06", "PT07", "PT08", "SWCH" ], "description": "Variant of the image, such as `MAIN` or `PT01`." }, "link": { "type": "string", "description": "URL for the image." }, "height": { "type": "number", "description": "Height of the image in pixels." }, "width": { "type": "number", "description": "Width of the image in pixels." } }, "required": [ "variant", "link", "height", "width" ] }, "description": "Images for an item in the Amazon catalog, grouped by `marketplaceId`." } }, "required": [ "marketplaceId", "images" ] } }, "catalogItems_2022_04_01_ItemImagesByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "images": { "type": "array", "items": { "type": "object", "properties": { "variant": { "type": "string", "enum": [ "MAIN", "PT01", "PT02", "PT03", "PT04", "PT05", "PT06", "PT07", "PT08", "SWCH" ], "description": "Variant of the image, such as `MAIN` or `PT01`." }, "link": { "type": "string", "description": "URL for the image." }, "height": { "type": "number", "description": "Height of the image in pixels." }, "width": { "type": "number", "description": "Width of the image in pixels." } }, "required": [ "variant", "link", "height", "width" ] }, "description": "Images for an item in the Amazon catalog, grouped by `marketplaceId`." } }, "required": [ "marketplaceId", "images" ] }, "catalogItems_2022_04_01_ItemProductTypeByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "productType": { "type": "string", "description": "Name of the product type that is associated with the Amazon catalog item." } } }, "catalogItems_2022_04_01_ItemProductTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "productType": { "type": "string", "description": "Name of the product type that is associated with the Amazon catalog item." } } } }, "catalogItems_2022_04_01_ItemRelationship": { "type": "object", "properties": { "childAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are children of this item." }, "parentAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are parents of this item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "Names of the Amazon catalog item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family." } }, "description": "ASINs of the related items that are parents of this item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "Type of relationship." } }, "required": [ "type" ] }, "catalogItems_2022_04_01_ItemRelationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are children of this item." }, "parentAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are parents of this item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "Names of the Amazon catalog item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family." } }, "description": "ASINs of the related items that are parents of this item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "Type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the item." } }, "required": [ "marketplaceId", "relationships" ] } }, "catalogItems_2022_04_01_ItemRelationshipsByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are children of this item." }, "parentAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are parents of this item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "Names of the Amazon catalog item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family." } }, "description": "ASINs of the related items that are parents of this item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "Type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the item." } }, "required": [ "marketplaceId", "relationships" ] }, "catalogItems_2022_04_01_ItemSalesRanks": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classificationRanks": { "type": "array", "items": { "type": "object", "properties": { "classificationId": { "type": "string", "description": "Identifier of the classification that is associated with the sales rank." }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales category." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "classificationId", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification." }, "displayGroupRanks": { "type": "array", "items": { "type": "object", "properties": { "websiteDisplayGroup": { "type": "string", "description": "Name of the website display group that is associated with the sales rank" }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales rank." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "websiteDisplayGroup", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group." } }, "required": [ "marketplaceId" ] } }, "catalogItems_2022_04_01_ItemSalesRanksByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classificationRanks": { "type": "array", "items": { "type": "object", "properties": { "classificationId": { "type": "string", "description": "Identifier of the classification that is associated with the sales rank." }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales category." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "classificationId", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification." }, "displayGroupRanks": { "type": "array", "items": { "type": "object", "properties": { "websiteDisplayGroup": { "type": "string", "description": "Name of the website display group that is associated with the sales rank" }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales rank." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "websiteDisplayGroup", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group." } }, "required": [ "marketplaceId" ] }, "catalogItems_2022_04_01_ItemSearchResults": { "type": "object", "properties": { "numberOfResults": { "type": "number", "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." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that you can use to retrieve the next page." }, "previousToken": { "type": "string", "description": "A token that you can use to retrieve the previous page." } }, "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." }, "refinements": { "type": "object", "properties": { "brands": { "type": "array", "items": { "type": "object", "properties": { "numberOfResults": { "type": "number", "description": "The estimated number of results that would be returned if you refine your search by the specified `brandName`." }, "brandName": { "type": "string", "description": "The brand name that you can use to refine your search." } }, "required": [ "numberOfResults", "brandName" ] }, "description": "A list of brands you can use to refine your search." }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "numberOfResults": { "type": "number", "description": "The estimated number of results that would be returned if you refine your search by the specified `classificationId`." }, "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "The identifier of the classification that you can use to refine your search." } }, "required": [ "numberOfResults", "displayName", "classificationId" ] }, "description": "A list of classifications you can use to refine your search." } }, "required": [ "brands", "classifications" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" }, "attributes": {}, "classifications": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ] }, "description": "Classifications (browse nodes) that are associated with the item in the Amazon catalog." } }, "required": [ "marketplaceId" ] } }, "dimensions": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "item": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } }, "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "package": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } } } }, "required": [ "marketplaceId" ] } }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).identifier." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "identifierType": { "type": "string", "description": "Type of identifier, such as UPC, EAN, or ISBN." }, "identifier": { "type": "string", "description": "Identifier of the item." } }, "required": [ "identifierType", "identifier" ] }, "description": "Identifiers associated with the item in the Amazon catalog for the indicated `marketplaceId`." } }, "required": [ "marketplaceId", "identifiers" ] } }, "images": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "images": { "type": "array", "items": { "type": "object", "properties": { "variant": { "type": "string", "enum": [ "MAIN", "PT01", "PT02", "PT03", "PT04", "PT05", "PT06", "PT07", "PT08", "SWCH" ], "description": "Variant of the image, such as `MAIN` or `PT01`." }, "link": { "type": "string", "description": "URL for the image." }, "height": { "type": "number", "description": "Height of the image in pixels." }, "width": { "type": "number", "description": "Width of the image in pixels." } }, "required": [ "variant", "link", "height", "width" ] }, "description": "Images for an item in the Amazon catalog, grouped by `marketplaceId`." } }, "required": [ "marketplaceId", "images" ] } }, "productTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "productType": { "type": "string", "description": "Name of the product type that is associated with the Amazon catalog item." } } } }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are children of this item." }, "parentAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are parents of this item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "Names of the Amazon catalog item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family." } }, "description": "ASINs of the related items that are parents of this item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "Type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the item." } }, "required": [ "marketplaceId", "relationships" ] } }, "salesRanks": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classificationRanks": { "type": "array", "items": { "type": "object", "properties": { "classificationId": { "type": "string", "description": "Identifier of the classification that is associated with the sales rank." }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales category." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "classificationId", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification." }, "displayGroupRanks": { "type": "array", "items": { "type": "object", "properties": { "websiteDisplayGroup": { "type": "string", "description": "Name of the website display group that is associated with the sales rank" }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales rank." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "websiteDisplayGroup", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group." } }, "required": [ "marketplaceId" ] } }, "summaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "adultProduct": { "type": "boolean", "description": "When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature." }, "autographed": { "type": "boolean", "description": "When `true`, the Amazon catalog item is autographed." }, "brand": { "type": "string", "description": "Name of the brand that is associated with the Amazon catalog item." }, "browseClassification": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ], "description": "Name of the brand that is associated with the Amazon catalog item." }, "color": { "type": "string", "description": "The color that is associated with the Amazon catalog item." }, "contributors": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name of the role in the requested locale, such as `Author` or `Actor`." }, "value": { "type": "string", "description": "Role value for the Amazon catalog item, such as `author` or `actor`." } }, "required": [ "value" ] }, "value": { "type": "string", "description": "Name of the contributor, such as `Jane Austen`." } }, "required": [ "role", "value" ] }, "description": "Individual contributors to the creation of the item, such as the authors or actors." }, "itemClassification": { "type": "string", "enum": [ "BASE_PRODUCT", "OTHER", "PRODUCT_BUNDLE", "VARIATION_PARENT" ], "description": "Classification type that is associated with the Amazon catalog item." }, "itemName": { "type": "string", "description": "The name that is associated with the Amazon catalog item." }, "manufacturer": { "type": "string", "description": "The name of the manufacturer that is associated with the Amazon catalog item." }, "memorabilia": { "type": "boolean", "description": "When true, the item is classified as memorabilia." }, "modelNumber": { "type": "string", "description": "The model number that is associated with the Amazon catalog item." }, "packageQuantity": { "type": "number", "description": "The quantity of the Amazon catalog item within one package." }, "partNumber": { "type": "string", "description": "The part number that is associated with the Amazon catalog item." }, "releaseDate": { "type": "string", "description": "The earliest date on which the Amazon catalog item can be shipped to customers." }, "size": { "type": "string", "description": "The name of the size of the Amazon catalog item." }, "style": { "type": "string", "description": "The name of the style that is associated with the Amazon catalog item." }, "tradeInEligible": { "type": "boolean", "description": "When true, the Amazon catalog item is eligible for trade-in." }, "websiteDisplayGroup": { "type": "string", "description": "The identifier of the website display group that is associated with the Amazon catalog item." }, "websiteDisplayGroupName": { "type": "string", "description": "The display name of the website display group that is associated with the Amazon catalog item." } }, "required": [ "marketplaceId" ] } }, "vendorDetails": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "brandCode": { "type": "string", "description": "The brand code that is associated with an Amazon catalog item." }, "manufacturerCode": { "type": "string", "description": "The manufacturer code that is associated with an Amazon catalog item." }, "manufacturerCodeParent": { "type": "string", "description": "The parent vendor code of the manufacturer code." }, "productCategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The parent vendor code of the manufacturer code." }, "productGroup": { "type": "string", "description": "The product group that is associated with an Amazon catalog item." }, "productSubcategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The product group that is associated with an Amazon catalog item." }, "replenishmentCategory": { "type": "string", "enum": [ "ALLOCATED", "BASIC_REPLENISHMENT", "IN_SEASON", "LIMITED_REPLENISHMENT", "MANUFACTURER_OUT_OF_STOCK", "NEW_PRODUCT", "NON_REPLENISHABLE", "NON_STOCKUPABLE", "OBSOLETE", "PLANNED_REPLENISHMENT" ], "description": "The replenishment category that is associated with an Amazon catalog item." } }, "required": [ "marketplaceId" ] } } }, "required": [ "asin" ] }, "description": "A list of items from the Amazon catalog." } }, "required": [ "numberOfResults", "items" ] }, "catalogItems_2022_04_01_ItemSummaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "adultProduct": { "type": "boolean", "description": "When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature." }, "autographed": { "type": "boolean", "description": "When `true`, the Amazon catalog item is autographed." }, "brand": { "type": "string", "description": "Name of the brand that is associated with the Amazon catalog item." }, "browseClassification": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ], "description": "Name of the brand that is associated with the Amazon catalog item." }, "color": { "type": "string", "description": "The color that is associated with the Amazon catalog item." }, "contributors": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name of the role in the requested locale, such as `Author` or `Actor`." }, "value": { "type": "string", "description": "Role value for the Amazon catalog item, such as `author` or `actor`." } }, "required": [ "value" ] }, "value": { "type": "string", "description": "Name of the contributor, such as `Jane Austen`." } }, "required": [ "role", "value" ] }, "description": "Individual contributors to the creation of the item, such as the authors or actors." }, "itemClassification": { "type": "string", "enum": [ "BASE_PRODUCT", "OTHER", "PRODUCT_BUNDLE", "VARIATION_PARENT" ], "description": "Classification type that is associated with the Amazon catalog item." }, "itemName": { "type": "string", "description": "The name that is associated with the Amazon catalog item." }, "manufacturer": { "type": "string", "description": "The name of the manufacturer that is associated with the Amazon catalog item." }, "memorabilia": { "type": "boolean", "description": "When true, the item is classified as memorabilia." }, "modelNumber": { "type": "string", "description": "The model number that is associated with the Amazon catalog item." }, "packageQuantity": { "type": "number", "description": "The quantity of the Amazon catalog item within one package." }, "partNumber": { "type": "string", "description": "The part number that is associated with the Amazon catalog item." }, "releaseDate": { "type": "string", "description": "The earliest date on which the Amazon catalog item can be shipped to customers." }, "size": { "type": "string", "description": "The name of the size of the Amazon catalog item." }, "style": { "type": "string", "description": "The name of the style that is associated with the Amazon catalog item." }, "tradeInEligible": { "type": "boolean", "description": "When true, the Amazon catalog item is eligible for trade-in." }, "websiteDisplayGroup": { "type": "string", "description": "The identifier of the website display group that is associated with the Amazon catalog item." }, "websiteDisplayGroupName": { "type": "string", "description": "The display name of the website display group that is associated with the Amazon catalog item." } }, "required": [ "marketplaceId" ] } }, "catalogItems_2022_04_01_ItemSummaryByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "adultProduct": { "type": "boolean", "description": "When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature." }, "autographed": { "type": "boolean", "description": "When `true`, the Amazon catalog item is autographed." }, "brand": { "type": "string", "description": "Name of the brand that is associated with the Amazon catalog item." }, "browseClassification": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ], "description": "Name of the brand that is associated with the Amazon catalog item." }, "color": { "type": "string", "description": "The color that is associated with the Amazon catalog item." }, "contributors": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name of the role in the requested locale, such as `Author` or `Actor`." }, "value": { "type": "string", "description": "Role value for the Amazon catalog item, such as `author` or `actor`." } }, "required": [ "value" ] }, "value": { "type": "string", "description": "Name of the contributor, such as `Jane Austen`." } }, "required": [ "role", "value" ] }, "description": "Individual contributors to the creation of the item, such as the authors or actors." }, "itemClassification": { "type": "string", "enum": [ "BASE_PRODUCT", "OTHER", "PRODUCT_BUNDLE", "VARIATION_PARENT" ], "description": "Classification type that is associated with the Amazon catalog item." }, "itemName": { "type": "string", "description": "The name that is associated with the Amazon catalog item." }, "manufacturer": { "type": "string", "description": "The name of the manufacturer that is associated with the Amazon catalog item." }, "memorabilia": { "type": "boolean", "description": "When true, the item is classified as memorabilia." }, "modelNumber": { "type": "string", "description": "The model number that is associated with the Amazon catalog item." }, "packageQuantity": { "type": "number", "description": "The quantity of the Amazon catalog item within one package." }, "partNumber": { "type": "string", "description": "The part number that is associated with the Amazon catalog item." }, "releaseDate": { "type": "string", "description": "The earliest date on which the Amazon catalog item can be shipped to customers." }, "size": { "type": "string", "description": "The name of the size of the Amazon catalog item." }, "style": { "type": "string", "description": "The name of the style that is associated with the Amazon catalog item." }, "tradeInEligible": { "type": "boolean", "description": "When true, the Amazon catalog item is eligible for trade-in." }, "websiteDisplayGroup": { "type": "string", "description": "The identifier of the website display group that is associated with the Amazon catalog item." }, "websiteDisplayGroupName": { "type": "string", "description": "The display name of the website display group that is associated with the Amazon catalog item." } }, "required": [ "marketplaceId" ] }, "catalogItems_2022_04_01_ItemVariationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "Names of the Amazon catalog item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family." } } }, "catalogItems_2022_04_01_ItemVendorDetails": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "brandCode": { "type": "string", "description": "The brand code that is associated with an Amazon catalog item." }, "manufacturerCode": { "type": "string", "description": "The manufacturer code that is associated with an Amazon catalog item." }, "manufacturerCodeParent": { "type": "string", "description": "The parent vendor code of the manufacturer code." }, "productCategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The parent vendor code of the manufacturer code." }, "productGroup": { "type": "string", "description": "The product group that is associated with an Amazon catalog item." }, "productSubcategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The product group that is associated with an Amazon catalog item." }, "replenishmentCategory": { "type": "string", "enum": [ "ALLOCATED", "BASIC_REPLENISHMENT", "IN_SEASON", "LIMITED_REPLENISHMENT", "MANUFACTURER_OUT_OF_STOCK", "NEW_PRODUCT", "NON_REPLENISHABLE", "NON_STOCKUPABLE", "OBSOLETE", "PLANNED_REPLENISHMENT" ], "description": "The replenishment category that is associated with an Amazon catalog item." } }, "required": [ "marketplaceId" ] } }, "catalogItems_2022_04_01_ItemVendorDetailsByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "brandCode": { "type": "string", "description": "The brand code that is associated with an Amazon catalog item." }, "manufacturerCode": { "type": "string", "description": "The manufacturer code that is associated with an Amazon catalog item." }, "manufacturerCodeParent": { "type": "string", "description": "The parent vendor code of the manufacturer code." }, "productCategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The parent vendor code of the manufacturer code." }, "productGroup": { "type": "string", "description": "The product group that is associated with an Amazon catalog item." }, "productSubcategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The product group that is associated with an Amazon catalog item." }, "replenishmentCategory": { "type": "string", "enum": [ "ALLOCATED", "BASIC_REPLENISHMENT", "IN_SEASON", "LIMITED_REPLENISHMENT", "MANUFACTURER_OUT_OF_STOCK", "NEW_PRODUCT", "NON_REPLENISHABLE", "NON_STOCKUPABLE", "OBSOLETE", "PLANNED_REPLENISHMENT" ], "description": "The replenishment category that is associated with an Amazon catalog item." } }, "required": [ "marketplaceId" ] }, "catalogItems_2022_04_01_ItemVendorDetailsCategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } } }, "catalogItems_2022_04_01_Pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that you can use to retrieve the next page." }, "previousToken": { "type": "string", "description": "A token that you can use to retrieve the previous page." } } }, "catalogItems_2022_04_01_Refinements": { "type": "object", "properties": { "brands": { "type": "array", "items": { "type": "object", "properties": { "numberOfResults": { "type": "number", "description": "The estimated number of results that would be returned if you refine your search by the specified `brandName`." }, "brandName": { "type": "string", "description": "The brand name that you can use to refine your search." } }, "required": [ "numberOfResults", "brandName" ] }, "description": "A list of brands you can use to refine your search." }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "numberOfResults": { "type": "number", "description": "The estimated number of results that would be returned if you refine your search by the specified `classificationId`." }, "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "The identifier of the classification that you can use to refine your search." } }, "required": [ "numberOfResults", "displayName", "classificationId" ] }, "description": "A list of classifications you can use to refine your search." } }, "required": [ "brands", "classifications" ] }, "channel": { "type": "string", "enum": [ "az", "wm" ] }, "components": { "type": "object", "properties": { "schemas": { "type": "object", "properties": { "Error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "string" } }, "required": [ "code", "message" ] }, "ErrorList": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object" } } }, "required": [ "errors" ] }, "Item": { "type": "object", "properties": { "asin": { "type": "object" }, "attributes": { "type": "object" }, "classifications": { "type": "object" }, "dimensions": { "type": "object" }, "identifiers": { "type": "object" }, "images": { "type": "object" }, "productTypes": { "type": "object" }, "relationships": { "type": "object" }, "salesRanks": { "type": "object" }, "summaries": { "type": "object" }, "vendorDetails": { "type": "object" } }, "required": [ "asin" ] }, "ItemAsin": { "type": "string" }, "ItemAttributes": { "type": "object", "properties": {}, "additionalProperties": {} }, "ItemBrowseClassification": { "type": "object", "properties": { "displayName": { "type": "string" }, "classificationId": { "type": "string" }, "parent": { "type": "object" } }, "required": [ "displayName", "classificationId" ] }, "ItemContributor": { "type": "object", "properties": { "role": { "type": "object" }, "value": { "type": "string" } }, "required": [ "role", "value" ] }, "ItemContributorRole": { "type": "object", "properties": { "displayName": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ] }, "ItemBrowseClassifications": { "type": "array", "items": { "type": "object" } }, "ItemBrowseClassificationsByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "classifications": { "type": "array", "items": { "type": "object" } } }, "required": [ "marketplaceId" ] }, "Dimension": { "type": "object", "properties": { "unit": { "type": "string" }, "value": { "type": "number" } } }, "Dimensions": { "type": "object", "properties": { "height": { "type": "object" }, "length": { "type": "object" }, "weight": { "type": "object" }, "width": { "type": "object" } } }, "ItemDimensions": { "type": "array", "items": { "type": "object" } }, "ItemDimensionsByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "item": { "type": "object" }, "package": { "type": "object" } }, "required": [ "marketplaceId" ] }, "ItemIdentifiers": { "type": "array", "items": { "type": "object" } }, "ItemIdentifiersByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "identifiers": { "type": "array", "items": { "type": "object" } } }, "required": [ "marketplaceId", "identifiers" ] }, "ItemIdentifier": { "type": "object", "properties": { "identifierType": { "type": "string" }, "identifier": { "type": "string" } }, "required": [ "identifierType", "identifier" ] }, "ItemImages": { "type": "array", "items": { "type": "object" } }, "ItemImagesByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "images": { "type": "array", "items": { "type": "object" } } }, "required": [ "marketplaceId", "images" ] }, "ItemImage": { "type": "object", "properties": { "variant": { "type": "string", "enum": [ "MAIN", "PT01", "PT02", "PT03", "PT04", "PT05", "PT06", "PT07", "PT08", "SWCH" ], "examples": [ "MAIN" ] }, "link": { "type": "string" }, "height": { "type": "number" }, "width": { "type": "number" } }, "required": [ "variant", "link", "height", "width" ] }, "ItemProductTypes": { "type": "array", "items": { "type": "object" } }, "ItemProductTypeByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "productType": { "type": "string", "examples": [ "LUGGAGE" ] } } }, "ItemSalesRanks": { "type": "array", "items": { "type": "object" } }, "ItemSalesRanksByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "classificationRanks": { "type": "array", "items": { "type": "object" } }, "displayGroupRanks": { "type": "array", "items": { "type": "object" } } }, "required": [ "marketplaceId" ] }, "ItemClassificationSalesRank": { "type": "object", "properties": { "classificationId": { "type": "string" }, "title": { "type": "string" }, "link": { "type": "string" }, "rank": { "type": "number" } }, "required": [ "classificationId", "title", "rank" ] }, "ItemDisplayGroupSalesRank": { "type": "object", "properties": { "websiteDisplayGroup": { "type": "string" }, "title": { "type": "string" }, "link": { "type": "string" }, "rank": { "type": "number" } }, "required": [ "websiteDisplayGroup", "title", "rank" ] }, "ItemSummaries": { "type": "array", "items": { "type": "object" } }, "ItemSummaryByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "adultProduct": { "type": "boolean" }, "autographed": { "type": "boolean" }, "brand": { "type": "string" }, "browseClassification": { "type": "object" }, "color": { "type": "string" }, "contributors": { "type": "array", "items": { "type": "object" } }, "itemClassification": { "type": "string", "enum": [ "BASE_PRODUCT", "OTHER", "PRODUCT_BUNDLE", "VARIATION_PARENT" ] }, "itemName": { "type": "string" }, "manufacturer": { "type": "string" }, "memorabilia": { "type": "boolean" }, "modelNumber": { "type": "string" }, "packageQuantity": { "type": "number" }, "partNumber": { "type": "string" }, "releaseDate": { "type": "string", "description": "Format: date" }, "size": { "type": "string" }, "style": { "type": "string" }, "tradeInEligible": { "type": "boolean" }, "websiteDisplayGroup": { "type": "string" }, "websiteDisplayGroupName": { "type": "string" } }, "required": [ "marketplaceId" ] }, "ItemVariationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" } }, "theme": { "type": "string", "examples": [ "COLOR_NAME/STYLE_NAME" ] } } }, "ItemRelationships": { "type": "array", "items": { "type": "object" } }, "ItemRelationshipsByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "relationships": { "type": "array", "items": { "type": "object" } } }, "required": [ "marketplaceId", "relationships" ] }, "ItemRelationship": { "type": "object", "properties": { "childAsins": { "type": "array", "items": { "type": "string" } }, "parentAsins": { "type": "array", "items": { "type": "string" } }, "variationTheme": { "type": "object", "examples": [ "VARIATION" ] }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "examples": [ "VARIATION" ] } }, "required": [ "type" ] }, "ItemVendorDetailsCategory": { "type": "object", "properties": { "displayName": { "type": "string" }, "value": { "type": "string" } } }, "ItemVendorDetails": { "type": "array", "items": { "type": "object" } }, "ItemVendorDetailsByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "brandCode": { "type": "string" }, "manufacturerCode": { "type": "string" }, "manufacturerCodeParent": { "type": "string" }, "productCategory": { "type": "object" }, "productGroup": { "type": "string" }, "productSubcategory": { "type": "object" }, "replenishmentCategory": { "type": "string", "enum": [ "ALLOCATED", "BASIC_REPLENISHMENT", "IN_SEASON", "LIMITED_REPLENISHMENT", "MANUFACTURER_OUT_OF_STOCK", "NEW_PRODUCT", "NON_REPLENISHABLE", "NON_STOCKUPABLE", "OBSOLETE", "PLANNED_REPLENISHMENT" ] } }, "required": [ "marketplaceId" ] }, "ItemSearchResults": { "type": "object", "properties": { "numberOfResults": { "type": "number" }, "pagination": { "type": "object" }, "refinements": { "type": "object" }, "items": { "type": "array", "items": { "type": "object" } } }, "required": [ "numberOfResults", "items" ] }, "Pagination": { "type": "object", "properties": { "nextToken": { "type": "string" }, "previousToken": { "type": "string" } } }, "Refinements": { "type": "object", "properties": { "brands": { "type": "array", "items": { "type": "object" } }, "classifications": { "type": "array", "items": { "type": "object" } } }, "required": [ "brands", "classifications" ] }, "BrandRefinement": { "type": "object", "properties": { "numberOfResults": { "type": "number" }, "brandName": { "type": "string" } }, "required": [ "numberOfResults", "brandName" ] }, "ClassificationRefinement": { "type": "object", "properties": { "numberOfResults": { "type": "number" }, "displayName": { "type": "string" }, "classificationId": { "type": "string" } }, "required": [ "numberOfResults", "displayName", "classificationId" ] } }, "required": [ "Error", "ErrorList", "Item", "ItemAsin", "ItemAttributes", "ItemBrowseClassification", "ItemContributor", "ItemContributorRole", "ItemBrowseClassifications", "ItemBrowseClassificationsByMarketplace", "Dimension", "Dimensions", "ItemDimensions", "ItemDimensionsByMarketplace", "ItemIdentifiers", "ItemIdentifiersByMarketplace", "ItemIdentifier", "ItemImages", "ItemImagesByMarketplace", "ItemImage", "ItemProductTypes", "ItemProductTypeByMarketplace", "ItemSalesRanks", "ItemSalesRanksByMarketplace", "ItemClassificationSalesRank", "ItemDisplayGroupSalesRank", "ItemSummaries", "ItemSummaryByMarketplace", "ItemVariationTheme", "ItemRelationships", "ItemRelationshipsByMarketplace", "ItemRelationship", "ItemVendorDetailsCategory", "ItemVendorDetails", "ItemVendorDetailsByMarketplace", "ItemSearchResults", "Pagination", "Refinements", "BrandRefinement", "ClassificationRefinement" ] }, "responses": { "not": {} }, "parameters": { "not": {} }, "requestBodies": { "not": {} }, "headers": { "not": {} }, "pathItems": { "not": {} } }, "required": [ "schemas", "responses", "parameters", "requestBodies", "headers", "pathItems" ] }, "Condition": { "type": "object", "properties": { "condition_id": { "type": "number" }, "channel": { "type": "string", "enum": [ "az", "wm" ] }, "condition_name": { "type": [ "string", "null" ] } }, "required": [ "condition_id", "channel", "condition_name" ] }, "ConfirmDeliveryWindowOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "ConfirmDeliveryWindowOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "ConfirmDeliveryWindowOptionsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "ConfirmPackingOptionErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "ConfirmPackingOptionResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "ConfirmPackingOptionSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "ConfirmPlacementOptionErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "ConfirmPlacementOptionResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "ConfirmPlacementOptionSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "operation_complete": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "maybe_202": { "type": "object" } }, "required": [ "mp" ] }, "ConfirmTransportationOptionsBody": { "type": "object", "properties": { "transportationSelections": { "type": "array", "items": { "type": "object", "properties": { "contactInformation": { "type": [ "object", "null" ], "properties": { "email": { "type": [ "string", "null" ], "description": "The email address." }, "name": { "type": "string", "description": "The contact's name.", "nullable": false }, "phoneNumber": { "type": "string", "description": "The phone number.", "nullable": false } }, "required": [ "name", "phoneNumber" ] }, "shipmentId": { "type": "string", "description": "Shipment ID that the transportation Option is for.", "nullable": false }, "transportationOptionId": { "type": "string", "description": "Transportation option being selected for the provided shipment.", "nullable": false } }, "required": [ "shipmentId", "transportationOptionId" ] }, "description": "Information needed to confirm one of the available transportation options.", "nullable": false } }, "required": [ "transportationSelections" ] }, "ConfirmTransportationOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "ConfirmTransportationOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "ConfirmTransportationOptionsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "CreateBookingBody": { "type": "object", "properties": { "payload": { "oneOf": [ { "type": "object", "properties": { "shipmentId": { "type": "string", "nullable": false }, "bookingDetails": { "type": "object", "properties": { "quoteType": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ], "nullable": false }, "quoteId": { "type": "string", "nullable": false }, "unitDetails": { "type": "array", "items": { "type": "object", "properties": { "noOfMixedSkuBoxes": { "type": "number", "nullable": false }, "noOfSingleSkuBoxes": { "type": "number", "nullable": false } }, "required": [ "noOfMixedSkuBoxes", "noOfSingleSkuBoxes" ] }, "nullable": false } }, "required": [ "quoteType", "quoteId", "unitDetails" ], "nullable": false } }, "required": [ "shipmentId", "bookingDetails" ] }, { "type": "object", "properties": { "shipmentId": { "type": "string", "nullable": false }, "bookingDetails": { "type": "object", "properties": { "termsAcceptedTime": { "type": "string", "nullable": false }, "quoteId": { "type": "string", "nullable": false }, "quoteType": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ], "nullable": false }, "pickupDetails": { "type": "object", "properties": { "businessLocationName": { "type": "string", "nullable": false }, "pickupInstruction": { "type": [ "string", "null" ] }, "pickupDateInfo": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "pickupDate": { "type": "string", "nullable": false }, "readyTime": { "type": "string", "nullable": false }, "closeTime": { "type": "string", "nullable": false }, "priority": { "type": "number", "nullable": false } }, "required": [ "pickupDate", "readyTime", "closeTime", "priority" ] } } }, "required": [ "businessLocationName" ], "nullable": false }, "shipperInfo": { "type": "object", "properties": { "contactInfo": { "type": "object", "properties": { "primaryContactPhoneNumber": { "type": "string", "nullable": false }, "primaryContactEmailAddress": { "type": "string", "nullable": false } }, "required": [ "primaryContactPhoneNumber", "primaryContactEmailAddress" ], "nullable": false }, "firstName": { "type": "string", "nullable": false }, "name": { "type": "string", "nullable": false }, "lastName": { "type": [ "string", "null" ] }, "requesterType": { "type": "string", "enum": [ "IWFS" ], "nullable": false } }, "required": [ "contactInfo", "firstName", "name", "requesterType" ], "nullable": false }, "locations": { "type": "object", "properties": { "origin": { "type": "object", "properties": { "addressLine1": { "type": "string", "nullable": false }, "addressLine2": { "type": [ "string", "null" ] }, "city": { "type": "string", "nullable": false }, "postalCode": { "type": "string", "nullable": false }, "state": { "type": "string", "nullable": false }, "countryCode": { "type": "string", "nullable": false }, "phone": { "type": [ "string", "null" ] }, "locationName": { "type": [ "string", "null" ] }, "locationType": { "type": [ "string", "null" ], "description": "Length between 0 and 15" }, "operationHours": { "type": "array", "items": { "type": "object", "properties": { "dayOfWeekCode": { "type": "string", "nullable": false }, "operationType": { "type": "string", "enum": [ "OPR" ], "nullable": false }, "openStrTime": { "type": "string", "nullable": false }, "closeStrTime": { "type": "string", "nullable": false } }, "required": [ "dayOfWeekCode", "operationType", "openStrTime", "closeStrTime" ] }, "nullable": false } }, "required": [ "state", "countryCode", "operationHours" ], "nullable": false }, "destination": { "type": "object", "properties": { "addressLine1": { "type": "string", "nullable": false }, "addressLine2": { "type": [ "string", "null" ] }, "city": { "type": "string", "nullable": false }, "postalCode": { "type": "string", "nullable": false }, "state": { "type": "string", "nullable": false }, "countryCode": { "type": "string", "nullable": false }, "phone": { "type": [ "string", "null" ] }, "locationName": { "type": [ "string", "null" ] }, "locationType": { "type": [ "string", "null" ], "description": "Length between 0 and 15" } }, "required": [ "state", "countryCode" ], "nullable": false } }, "required": [ "origin", "destination" ], "nullable": false }, "unitDetails": { "type": "array", "items": { "type": "object", "properties": { "declaredValue": { "type": [ "number", "null" ] }, "totalPalletCount": { "type": "number", "nullable": false }, "noOfSingleSkuBoxes": { "type": "number", "nullable": false }, "noOfMixedSkuBoxes": { "type": "number", "nullable": false }, "shipmentPackages": { "type": "array", "items": { "type": "object", "properties": { "packageSequenceNumber": { "type": "number", "description": "Package Sequence Number", "nullable": false }, "weight": { "type": "number", "description": "Weight. -1 to 150", "nullable": false }, "weightUOM": { "type": "string", "enum": [ "lb" ], "description": "Weight unit of measurement, should always be \"lb\"", "nullable": false }, "length": { "type": "number", "description": "Length. ≥ -1", "nullable": false }, "height": { "type": "number", "description": "Length. ≥ -1", "nullable": false }, "width": { "type": "number", "nullable": false }, "lengthUOM": { "type": "string", "enum": [ "in" ], "description": "Length unit of measurement, should always be \"in\"", "nullable": false }, "packageType": { "type": [ "string", "null" ], "enum": [ "SINGLE SKUS", "MIXED SKUS", "PALLET" ], "description": "Length unit of measurement, should always be \"in\"" }, "isStackable": { "type": [ "boolean", "null" ], "description": "Only for LTL / FTL" }, "noOfPackages": { "type": [ "number", "null" ], "description": "Only for FTL" } }, "required": [ "packageSequenceNumber", "weight", "weightUOM", "length", "height", "width", "lengthUOM" ] }, "nullable": false } }, "required": [ "totalPalletCount", "noOfSingleSkuBoxes", "noOfMixedSkuBoxes", "shipmentPackages" ] }, "nullable": false } }, "required": [ "termsAcceptedTime", "quoteId", "quoteType", "pickupDetails", "shipperInfo", "locations", "unitDetails" ], "nullable": false } }, "required": [ "shipmentId", "bookingDetails" ] } ], "nullable": false } } }, "CreateBookingParams": { "type": "object", "properties": { "payload": { "oneOf": [ { "type": "object", "properties": { "shipmentId": { "type": "string" }, "bookingDetails": { "type": "object", "properties": { "quoteType": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "quoteId": { "type": "string" }, "unitDetails": { "type": "array", "items": { "type": "object", "properties": { "noOfMixedSkuBoxes": { "type": "number" }, "noOfSingleSkuBoxes": { "type": "number" } }, "required": [ "noOfMixedSkuBoxes", "noOfSingleSkuBoxes" ] } } }, "required": [ "quoteType", "quoteId", "unitDetails" ] } }, "required": [ "shipmentId", "bookingDetails" ] }, { "type": "object", "properties": { "shipmentId": { "type": "string" }, "bookingDetails": { "type": "object", "properties": { "termsAcceptedTime": { "type": "string" }, "quoteId": { "type": "string" }, "quoteType": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "pickupDetails": { "type": "object", "properties": { "businessLocationName": { "type": "string" }, "pickupInstruction": { "type": "string" }, "pickupDateInfo": { "type": "array", "items": { "type": "object", "properties": { "pickupDate": { "type": "string" }, "readyTime": { "type": "string" }, "closeTime": { "type": "string" }, "priority": { "type": "number" } }, "required": [ "pickupDate", "readyTime", "closeTime", "priority" ] } } }, "required": [ "businessLocationName" ] }, "shipperInfo": { "type": "object", "properties": { "contactInfo": { "type": "object", "properties": { "primaryContactPhoneNumber": { "type": "string" }, "primaryContactEmailAddress": { "type": "string" } }, "required": [ "primaryContactPhoneNumber", "primaryContactEmailAddress" ] }, "firstName": { "type": "string" }, "name": { "type": "string" }, "lastName": { "type": "string" }, "requesterType": { "type": "string", "enum": [ "IWFS" ] } }, "required": [ "contactInfo", "firstName", "name", "requesterType" ] }, "locations": { "type": "object", "properties": { "origin": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string" }, "phone": { "type": "string" }, "locationName": { "type": "string" }, "locationType": { "type": "string", "description": "Length between 0 and 15" }, "operationHours": { "type": "array", "items": { "type": "object", "properties": { "dayOfWeekCode": { "type": "string" }, "operationType": { "type": "string", "enum": [ "OPR" ] }, "openStrTime": { "type": "string" }, "closeStrTime": { "type": "string" } }, "required": [ "dayOfWeekCode", "operationType", "openStrTime", "closeStrTime" ] } } }, "required": [ "state", "countryCode", "operationHours" ] }, "destination": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string" }, "phone": { "type": "string" }, "locationName": { "type": "string" }, "locationType": { "type": "string", "description": "Length between 0 and 15" } }, "required": [ "state", "countryCode" ] } }, "required": [ "origin", "destination" ] }, "unitDetails": { "type": "array", "items": { "type": "object", "properties": { "declaredValue": { "type": "number" }, "totalPalletCount": { "type": "number" }, "noOfSingleSkuBoxes": { "type": "number" }, "noOfMixedSkuBoxes": { "type": "number" }, "shipmentPackages": { "type": "array", "items": { "type": "object", "properties": { "packageSequenceNumber": { "type": "number", "description": "Package Sequence Number" }, "weight": { "type": "number", "description": "Weight. -1 to 150" }, "weightUOM": { "type": "string", "enum": [ "lb" ], "description": "Weight unit of measurement, should always be \"lb\"" }, "length": { "type": "number", "description": "Length. ≥ -1" }, "height": { "type": "number", "description": "Length. ≥ -1" }, "width": { "type": "number" }, "lengthUOM": { "type": "string", "enum": [ "in" ], "description": "Length unit of measurement, should always be \"in\"" }, "packageType": { "type": "string", "enum": [ "SINGLE SKUS", "MIXED SKUS", "PALLET" ], "description": "Length unit of measurement, should always be \"in\"" }, "isStackable": { "type": "boolean", "description": "Only for LTL / FTL" }, "noOfPackages": { "type": "number", "description": "Only for FTL" } }, "required": [ "packageSequenceNumber", "weight", "weightUOM", "length", "height", "width", "lengthUOM" ] } } }, "required": [ "totalPalletCount", "noOfSingleSkuBoxes", "noOfMixedSkuBoxes", "shipmentPackages" ] } } }, "required": [ "termsAcceptedTime", "quoteId", "quoteType", "pickupDetails", "shipperInfo", "locations", "unitDetails" ] } }, "required": [ "shipmentId", "bookingDetails" ] } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "payload", "mp" ] }, "CreateBookingResponse": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ] }, "CreateBookingSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "CreateCarrierRateQuoteBody": { "type": "object", "properties": { "payload": { "oneOf": [ { "type": "object", "properties": { "shipmentId": { "type": "string" }, "quoteType": { "type": "string", "enum": [ "PARCEL" ] }, "units": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "destination": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "city": { "type": "string" }, "stateOrProvince": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" } }, "required": [ "addressLine1", "city", "stateOrProvince", "postalCode", "country" ] } ] }, "origin": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "object" }, "city": { "type": "string" }, "stateOrProvince": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "object" }, "locationName": { "type": "string" } }, "required": [ "addressLine1", "city", "stateOrProvince", "postalCode", "country", "locationName" ] } ] }, "unitDetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "shipmentPackages": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "packageSequenceNumber": { "type": "number" }, "weight": { "type": "number" }, "weightUOM": { "type": "string", "enum": [ "lb" ] }, "length": { "type": "number" }, "height": { "type": "number" }, "width": { "type": "number" }, "lengthUOM": { "type": "string", "enum": [ "in" ] }, "packageType": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PALLET" ] }, { "type": "string", "enum": [ "SINGLE SKUS" ] }, { "type": "string", "enum": [ "MIXED SKUS" ] } ] }, "isStackable": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "noOfPackages": { "oneOf": [ { "type": "object" }, { "type": "number" } ] } }, "required": [ "packageSequenceNumber", "weight", "weightUOM", "length", "height", "width", "lengthUOM" ] } } ] } } } ] } } } } ] } }, "required": [ "shipmentId", "quoteType" ] }, { "type": "object", "properties": { "shipmentId": { "type": "string" }, "quoteType": { "type": "string", "enum": [ "LTL" ] }, "pickUpFromDate": { "type": "object" }, "pickUpToDate": { "type": "object" }, "units": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "destination": { "type": "object" }, "origin": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "object" }, "city": { "type": "string" }, "stateOrProvince": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "locationName": { "type": "string" } }, "required": [ "addressLine1", "city", "stateOrProvince", "postalCode", "country", "locationName" ] } ] }, "unitDetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "freightClass": { "type": "object" }, "declaredValue": { "type": "object" }, "noOfSingleSkuBoxes": { "type": "object" }, "noOfMixedSkuBoxes": { "type": "object" }, "totalPalletCount": { "type": "object" }, "shipmentPackages": { "type": "object" } } } ] } } } } ] } }, "required": [ "shipmentId", "quoteType" ] }, { "type": "object", "properties": { "shipmentNumber": { "type": "string" }, "quoteType": { "type": "string", "enum": [ "FTL" ] }, "pickUpFromDate": { "oneOf": [ { "type": "object" }, { "type": "string", "format": "date-time" } ] }, "pickUpToDate": { "type": "object" }, "equipmentDetails": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "length": { "type": "object", "properties": { "unitOfMeasure": { "type": "object" }, "measurementValue": { "type": "object" } } }, "protectionLevel": { "type": "string" }, "type": { "type": "string" } }, "required": [ "length", "protectionLevel", "type" ] } } ] }, "units": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "sequenceNbr": { "type": "object" }, "mode": { "type": "object" }, "serviceLevel": { "type": "object" }, "destination": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "state": { "type": "string" }, "countryCode": { "type": "string" }, "phone": { "type": "object" }, "locationName": { "type": "object" }, "locationType": { "type": "object" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "object" }, "city": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "state", "countryCode", "addressLine1", "city", "postalCode" ] } ] }, "origin": { "type": "object" }, "unitDetails": { "type": "object" } } } } ] } }, "required": [ "shipmentNumber", "quoteType" ] } ] } } }, "CreateCarrierRateQuoteResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } } } }, "CreateCarrierRateQuoteSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "CreateInboundPlanBody": { "type": "object", "properties": { "destinationMarketplaces": { "type": "array", "items": { "type": "string" }, "description": "Marketplaces where the items need to be shipped to. Currently only one marketplace can be selected in this request.", "nullable": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped.", "nullable": false } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "Items included in this plan.", "nullable": false }, "name": { "type": [ "string", "null" ], "description": "Name for the Inbound Plan. If one isn't provided, a default name will be provided." }, "sourceAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information.", "nullable": false }, "addressLine2": { "type": [ "string", "null" ], "description": "Additional street address information." }, "city": { "type": "string", "description": "The city.", "nullable": false }, "companyName": { "type": [ "string", "null" ], "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format.", "nullable": false }, "districtOrCounty": { "type": [ "string", "null" ], "description": "The district or county." }, "email": { "type": [ "string", "null" ], "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact.", "nullable": false }, "phoneNumber": { "type": "string", "description": "The phone number.", "nullable": false }, "postalCode": { "type": "string", "description": "The postal code.", "nullable": false }, "stateOrProvinceCode": { "type": [ "string", "null" ], "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "phoneNumber", "postalCode" ], "description": "Name for the Inbound Plan. If one isn't provided, a default name will be provided.", "nullable": false } }, "required": [ "destinationMarketplaces", "items", "sourceAddress" ] }, "CreateInboundPlanErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "CreateInboundPlanResponse": { "type": "object", "properties": { "inboundPlanId": { "type": "string", "description": "Identifier of an inbound plan." }, "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "inboundPlanId", "operationId" ] }, "CreateInboundPlanSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "plan_id": { "type": "string" } } }, "CreateInboundShipmentLabelBody": { "type": "object", "properties": { "shipmentId": { "type": "string" }, "labelSize": { "type": "string", "enum": [ "X4_6", "X4_3" ] }, "labelFormat": { "type": "string", "enum": [ "PDF", "ZPL" ] }, "loadTypes": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number" }, "loadType": { "type": "string" } }, "required": [ "count", "loadType" ] } } } }, "CreateInboundShipmentLabelSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "CreateLTLBookingRequest": { "type": "object", "properties": { "shipmentId": { "type": "string" }, "bookingDetails": { "type": "object", "properties": { "termsAcceptedTime": { "type": "string" }, "quoteId": { "type": "string" }, "quoteType": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "pickupDetails": { "type": "object", "properties": { "businessLocationName": { "type": "string" }, "pickupInstruction": { "type": "string" }, "pickupDateInfo": { "type": "array", "items": { "type": "object", "properties": { "pickupDate": { "type": "string" }, "readyTime": { "type": "string" }, "closeTime": { "type": "string" }, "priority": { "type": "number" } }, "required": [ "pickupDate", "readyTime", "closeTime", "priority" ] } } }, "required": [ "businessLocationName" ] }, "shipperInfo": { "type": "object", "properties": { "contactInfo": { "type": "object", "properties": { "primaryContactPhoneNumber": { "type": "string" }, "primaryContactEmailAddress": { "type": "string" } }, "required": [ "primaryContactPhoneNumber", "primaryContactEmailAddress" ] }, "firstName": { "type": "string" }, "name": { "type": "string" }, "lastName": { "type": "string" }, "requesterType": { "type": "string", "enum": [ "IWFS" ] } }, "required": [ "contactInfo", "firstName", "name", "requesterType" ] }, "locations": { "type": "object", "properties": { "origin": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string" }, "phone": { "type": "string" }, "locationName": { "type": "string" }, "locationType": { "type": "string", "description": "Length between 0 and 15" }, "operationHours": { "type": "array", "items": { "type": "object", "properties": { "dayOfWeekCode": { "type": "string" }, "operationType": { "type": "string", "enum": [ "OPR" ] }, "openStrTime": { "type": "string" }, "closeStrTime": { "type": "string" } }, "required": [ "dayOfWeekCode", "operationType", "openStrTime", "closeStrTime" ] } } }, "required": [ "state", "countryCode", "operationHours" ] }, "destination": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string" }, "phone": { "type": "string" }, "locationName": { "type": "string" }, "locationType": { "type": "string", "description": "Length between 0 and 15" } }, "required": [ "state", "countryCode" ] } }, "required": [ "origin", "destination" ] }, "unitDetails": { "type": "array", "items": { "type": "object", "properties": { "declaredValue": { "type": "number" }, "totalPalletCount": { "type": "number" }, "noOfSingleSkuBoxes": { "type": "number" }, "noOfMixedSkuBoxes": { "type": "number" }, "shipmentPackages": { "type": "array", "items": { "type": "object", "properties": { "packageSequenceNumber": { "type": "number", "description": "Package Sequence Number" }, "weight": { "type": "number", "description": "Weight. -1 to 150" }, "weightUOM": { "type": "string", "enum": [ "lb" ], "description": "Weight unit of measurement, should always be \"lb\"" }, "length": { "type": "number", "description": "Length. ≥ -1" }, "height": { "type": "number", "description": "Length. ≥ -1" }, "width": { "type": "number" }, "lengthUOM": { "type": "string", "enum": [ "in" ], "description": "Length unit of measurement, should always be \"in\"" }, "packageType": { "type": "string", "enum": [ "SINGLE SKUS", "MIXED SKUS", "PALLET" ], "description": "Length unit of measurement, should always be \"in\"" }, "isStackable": { "type": "boolean", "description": "Only for LTL / FTL" }, "noOfPackages": { "type": "number", "description": "Only for FTL" } }, "required": [ "packageSequenceNumber", "weight", "weightUOM", "length", "height", "width", "lengthUOM" ] } } }, "required": [ "totalPalletCount", "noOfSingleSkuBoxes", "noOfMixedSkuBoxes", "shipmentPackages" ] } } }, "required": [ "termsAcceptedTime", "quoteId", "quoteType", "pickupDetails", "shipperInfo", "locations", "unitDetails" ] } }, "required": [ "shipmentId", "bookingDetails" ] }, "CreateMarketplaceReportParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "report_type": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] } }, "required": [ "report_type" ] }, "CreateMarketplaceReportResponse": { "oneOf": [ { "type": "object", "properties": { "requestId": { "type": "string", "description": "System-generated ID that uniquely identifies the report request." }, "requestStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ], "description": "Filters report requests by status." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated. Example: ITEM for Item Report." }, "reportVersion": { "type": "string", "description": "Version of report for which the request is created. Example, v1." }, "requestSubmissionDate": { "type": "string", "description": "Date and time on which the report request is submitted." }, "payload": { "type": "object", "properties": { "rowFilters": { "type": "array", "items": { "type": "object" } }, "excludeColumns": { "type": "array", "items": { "type": "string" }, "description": "List of columns to exclude from the report." }, "dataStartTime": { "type": "string", "format": "date-time", "description": "Start timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." }, "dataEndTime": { "type": "string", "format": "date-time", "description": "End timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." } }, "description": "Date and time on which the report request is submitted." } } }, { "type": "object", "properties": { "reportId": { "type": "string", "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." } }, "required": [ "reportId" ] } ] }, "CreateMarketplaceReportSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "report_type": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] } } }, "CreateReportBody": { "type": "object", "properties": { "reportOptions": { "anyOf": [ {}, { "type": "null" } ] }, "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.", "nullable": false }, "dataStartTime": { "type": [ "string", "null" ], "description": "The start of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this." }, "dataEndTime": { "type": [ "string", "null" ], "description": "The end of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.", "nullable": false } }, "required": [ "reportType", "marketplaceIds" ] }, "CreateReportErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "Error response returned when the request is unsuccessful." } }, "required": [ "errors" ] }, "CreateReportResponse": { "type": "object", "properties": { "reports": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "requestId": { "type": "string", "description": "System-generated ID that uniquely identifies the report request." }, "requestStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ], "description": "Filters report requests by status." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated. Example: ITEM for Item Report." }, "reportVersion": { "type": "string", "description": "Version of report for which the request is created. Example, v1." }, "requestSubmissionDate": { "type": "string", "description": "Date and time on which the report request is submitted." }, "payload": { "type": "object", "properties": { "rowFilters": { "type": "array", "items": { "type": "object" } }, "excludeColumns": { "type": "array", "items": { "type": "string" }, "description": "List of columns to exclude from the report." }, "dataStartTime": { "type": "string", "format": "date-time", "description": "Start timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." }, "dataEndTime": { "type": "string", "format": "date-time", "description": "End timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." } }, "description": "Date and time on which the report request is submitted." } } }, { "type": "object", "properties": { "reportId": { "type": "string", "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." } }, "required": [ "reportId" ] } ] } } }, "required": [ "reports" ] }, "CreateReportScheduleBody": { "type": "object", "properties": { "frequency": { "type": [ "string", "null" ], "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ], "description": "Specifies the frequency at which the report should be generated. For example, if set to YEARLY, the report will be generated once every year." }, "repeatsEvery": { "type": [ "number", "null" ], "description": "Defines the interval at which the report repeats based on the selected frequency." }, "hour": { "type": [ "number", "null" ], "description": "Specifies the hour of the day at which the schedule will be triggered. Allowed values are from 0 to 23, where 0 corresponds to 12:00 AM UTC and 23 corresponds to 11:00 PM UTC. The hour selection is based on the UTC timezone." }, "dayOfMonth": { "type": [ "number", "null" ], "description": "Specifies the day of the month on which the schedule will be triggered." }, "dayOfWeek": { "type": [ "number", "null" ], "description": "Specifies the day of the week on which the schedule will be triggered. Allowed values are from 0 to 6, where 0 represents Monday and 6 represents Sunday." }, "monthOfYear": { "type": [ "number", "null" ], "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." }, "scheduleStartDate": { "type": [ "string", "null" ], "description": "Specifies the start date for the schedule. The date should be in a valid date format (Example: YYYY-MM-DD)." }, "filters": { "type": [ "object", "null" ], "properties": { "rowFilters": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "values": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Specifies the enum filter values that must be included in the report." }, "columnName": { "type": "string", "description": "Specifies the column to which the filter should be applied.", "nullable": false }, "type": { "type": "string", "enum": [ "rangeFilter", "enumFilter", "multiValueFilter" ], "description": "Specifies the type of the filter.", "nullable": false } }, "required": [ "columnName", "type" ] } }, "excludeColumns": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "List of columns to exclude from the report." }, "dataStartTime": { "type": [ "string", "null" ], "format": "date-time", "description": "Start timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." }, "dataEndTime": { "type": [ "string", "null" ], "format": "date-time", "description": "End timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." } }, "description": "Specifies the start date for the schedule. The date should be in a valid date format (Example: YYYY-MM-DD)." } } }, "CreateReportScheduleResponse": { "type": "object", "properties": { "scheduleId": { "type": "string", "description": "Unique identifier for the schedule." }, "requestSubmissionDate": { "type": "string", "format": "date-time", "description": "The timestamp (date and time) indicating when the report request was submitted." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated." }, "reportVersion": { "type": "string", "description": "Specifies the version of report for which the request is created. Example: v1." }, "reportSummary": { "type": "string", "description": "Provides a brief summary of the report." }, "scheduleStartDate": { "type": "string", "description": "Specifies the start date for the schedule. The date should be in a valid date format (Example: YYYY-MM-DD)." }, "nextScheduledTime": { "type": "string", "description": "The next scheduled time for the report." }, "payload": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ], "description": "Specifies the frequency at which the report should be generated. For example, if set to YEARLY, the report will be generated once every year." }, "repeatsEvery": { "type": "number", "description": "Defines the interval at which the report repeats based on the selected frequency." }, "hour": { "type": "number", "description": "Specifies the hour of the day at which the schedule will be triggered. Allowed values are from 0 to 23, where 0 corresponds to 12:00 AM UTC and 23 corresponds to 11:00 PM UTC. The hour selection is based on the UTC timezone." }, "dayOfMonth": { "type": "number", "description": "Specifies the day of the month on which the schedule will be triggered." }, "dayOfWeek": { "type": "number", "description": "Specifies the day of the week on which the schedule will be triggered. Allowed values are from 0 to 6, where 0 represents Monday and 6 represents Sunday." }, "monthOfYear": { "type": "number", "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." }, "filters": { "type": "object", "properties": { "email": { "type": "string" }, "rowFilters": { "type": "object", "properties": { "type": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } }, "columnName": { "type": "string" } }, "required": [ "type", "values", "columnName" ] } }, "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." } }, "description": "The next scheduled time for the report." }, "requestModifiedTime": { "type": "string", "description": "The date and time when the report schedule was last modified." } }, "required": [ "scheduleId", "requestSubmissionDate", "reportType", "reportVersion", "payload" ] }, "CreateReportScheduleSeachParams": {}, "CreateReportSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "CreateShipmentBody": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "inboundServices": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "inventoryTransferService": { "type": "string", "enum": [ "Y" ] } }, "required": [ "inventoryTransferService" ] } ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "orderItems": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string" }, "productType": { "type": "string", "enum": [ "GTIN" ] }, "sku": { "type": "string" }, "itemDesc": { "type": "string" }, "itemQty": { "type": "number" }, "vendorPackQty": { "type": "number" }, "innerPackQty": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "addOnServices": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "serviceType": { "type": "string", "enum": [ "LABEL", "BAG", "TAPE", "WRAP" ] } }, "required": [ "serviceType" ] } } ] }, "itemNbr": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "dimensions": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "number" } } ] }, "itemWeightQty": { "type": "object" }, "nonSortItem": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "shipNode": { "type": "object" } }, "required": [ "productId", "productType", "sku", "itemDesc", "itemQty", "vendorPackQty", "innerPackQty", "expectedDeliveryDate" ] } } ] } } }, "CreateShipmentParams": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "inboundServices": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "inventoryTransferService": { "type": "string", "enum": [ "Y" ] } }, "required": [ "inventoryTransferService" ] } ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "orderItems": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string" }, "productType": { "type": "string", "enum": [ "GTIN" ] }, "sku": { "type": "string" }, "itemDesc": { "type": "string" }, "itemQty": { "type": "number" }, "vendorPackQty": { "type": "number" }, "innerPackQty": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "addOnServices": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "serviceType": { "type": "string", "enum": [ "LABEL", "BAG", "TAPE", "WRAP" ] } }, "required": [ "serviceType" ] } } ] }, "itemNbr": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "dimensions": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "number" } } ] }, "itemWeightQty": { "type": "object" }, "nonSortItem": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "shipNode": { "type": "object" } }, "required": [ "productId", "productType", "sku", "itemDesc", "itemQty", "vendorPackQty", "innerPackQty", "expectedDeliveryDate" ] } } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "inboundOrderId", "returnAddress", "mp" ] }, "CreateShipmentResponse": { "type": "object", "properties": { "status": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object", "properties": { "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "shipmentItems": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "itemQty": { "type": "number" } }, "required": [ "vendorSku", "itemQty" ] } }, "expectedDeliveryDate": { "type": "string", "format": "date-time" } }, "required": [ "shipmentId", "shipToAddress", "shipmentItems", "expectedDeliveryDate" ] } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } } }, "required": [ "status", "payload" ] }, "CreateShipmentSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "CreateSubscriptionBody": {}, "CreateSubscriptionResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "events": { "type": "array", "items": { "type": "object", "properties": { "eventType": { "type": "string", "description": "Event type for which the subscription was created." }, "subscriptionId": { "type": "string", "description": "Unique identifier for the subscription that you can use to fetch details, edit, or delete the subscription." }, "partnerId": { "type": "string", "description": "Partner ID of the seller who created the subscription." }, "eventVersion": { "type": "string", "description": "Version of the event type for which the subscription was created." }, "resourceName": { "type": "string", "description": "Resource or functional category that the event type is mapped to (for example, ITEM, ORDER, PRICE)." }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ], "description": "Current state of the subscription." }, "eventUrl": { "type": "string", "description": "Destination URL where notifications for this subscription will be delivered." }, "authDetails": { "type": "object", "properties": { "authMethod": { "type": "string", "enum": [ "BASIC_AUTH", "OAUTH", "HMAC" ], "description": "Authentication method for the destination URL." }, "userName": { "type": "string", "description": "Username used to access the destination URL (required for BASIC_AUTH)." }, "password": { "type": "string", "description": "Password used to access the destination URL (required for BASIC_AUTH)." }, "authHeaderName": { "type": "string", "description": "Header name used to pass the authorization value to the destination URL (for example, Authorization)." }, "authUrl": { "type": "string", "description": "OAuth server or token URL used when the authentication method is OAUTH." }, "clientSecret": { "type": "string", "description": "Client secret used with the OAuth server (OAUTH) or as key material for HMAC." }, "clientId": { "type": "string", "description": "Client ID used with the OAuth server when the authentication method is OAUTH." } }, "required": [ "authMethod", "userName", "password", "authHeaderName", "authUrl", "clientSecret", "clientId" ], "description": "Destination URL where notifications for this subscription will be delivered." }, "headers": { "type": "object", "properties": { "content-type": { "type": "string" } }, "required": [ "content-type" ], "description": "Headers required for accessing the destination URL." } }, "required": [ "eventType", "subscriptionId", "partnerId", "eventVersion", "resourceName", "status", "eventUrl", "authDetails", "headers" ] } } } }, "CreateSubscriptionSearchParams": {}, "CreateWmReportScheduleParams": { "type": "object", "properties": { "frequency": { "type": [ "string", "null" ], "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ], "description": "Specifies the frequency at which the report should be generated. For example, if set to YEARLY, the report will be generated once every year." }, "repeatsEvery": { "type": [ "number", "null" ], "description": "Defines the interval at which the report repeats based on the selected frequency." }, "hour": { "type": [ "number", "null" ], "description": "Specifies the hour of the day at which the schedule will be triggered. Allowed values are from 0 to 23, where 0 corresponds to 12:00 AM UTC and 23 corresponds to 11:00 PM UTC. The hour selection is based on the UTC timezone." }, "dayOfMonth": { "type": [ "number", "null" ], "description": "Specifies the day of the month on which the schedule will be triggered." }, "dayOfWeek": { "type": [ "number", "null" ], "description": "Specifies the day of the week on which the schedule will be triggered. Allowed values are from 0 to 6, where 0 represents Monday and 6 represents Sunday." }, "monthOfYear": { "type": [ "number", "null" ], "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated.", "nullable": false }, "reportVersion": { "type": [ "string", "null" ], "description": "Specifies the version of the report. For example, v2." }, "scheduleStartDate": { "type": [ "string", "null" ], "description": "Specifies the start date for the schedule. The date should be in a valid date format (Example: YYYY-MM-DD)." }, "filters": { "type": [ "object", "null" ], "properties": { "rowFilters": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "values": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Specifies the enum filter values that must be included in the report." }, "columnName": { "type": "string", "description": "Specifies the column to which the filter should be applied.", "nullable": false }, "type": { "type": "string", "enum": [ "rangeFilter", "enumFilter", "multiValueFilter" ], "description": "Specifies the type of the filter.", "nullable": false } }, "required": [ "columnName", "type" ] } }, "excludeColumns": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "List of columns to exclude from the report." }, "dataStartTime": { "type": [ "string", "null" ], "format": "date-time", "description": "Start timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." }, "dataEndTime": { "type": [ "string", "null" ], "format": "date-time", "description": "End timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." } }, "description": "Specifies the start date for the schedule. The date should be in a valid date format (Example: YYYY-MM-DD)." } }, "required": [ "reportType" ] }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "CustomPlacementBySku": { "type": "object", "properties": { "warehouseId": { "type": "string" }, "mskus": { "type": "array", "items": { "type": "string" } } }, "required": [ "warehouseId", "mskus" ] }, "Dashboard": { "type": "object", "properties": { "wfs_quantity": { "type": "number" }, "wfs_inbound": { "type": "number" }, "sf_quantity": { "type": "number" }, "quantity_in_plan": { "type": "number" }, "skus": { "type": "number" }, "unlisted_quantity": { "type": "number" } }, "required": [ "wfs_quantity", "wfs_inbound", "sf_quantity", "quantity_in_plan", "skus", "unlisted_quantity" ] }, "DateToString": { "type": "object", "properties": {} }, "definitionsProductTypes_2020_09_01_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "definitionsProductTypes_2020_09_01_ProductType": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Amazon product type." }, "displayName": { "type": "string", "description": "Human-readable and localized description of the Amazon product type." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "The Amazon marketplace identifiers for which the product type definition is available." } }, "required": [ "name", "displayName", "marketplaceIds" ] }, "definitionsProductTypes_2020_09_01_ProductTypeDefinition": { "type": "object", "properties": { "metaSchema": { "type": "object", "properties": { "link": { "type": "object", "properties": { "resource": { "type": "string", "description": "URI resource for the link." }, "verb": { "type": "string", "enum": [ "GET" ], "description": "HTTP method for the link operation." } }, "required": [ "resource", "verb" ], "description": "Link to retrieve the schema." }, "checksum": { "type": "string", "description": "Checksum hash of the schema (Base64 MD5). Use this to verify schema contents, identify changes between schema versions, and for caching." } }, "required": [ "link", "checksum" ] }, "schema": { "type": "object", "properties": { "link": { "type": "object", "properties": { "resource": { "type": "string", "description": "URI resource for the link." }, "verb": { "type": "string", "enum": [ "GET" ], "description": "HTTP method for the link operation." } }, "required": [ "resource", "verb" ], "description": "Link to retrieve the schema." }, "checksum": { "type": "string", "description": "Checksum hash of the schema (Base64 MD5). Use this to verify schema contents, identify changes between schema versions, and for caching." } }, "required": [ "link", "checksum" ] }, "requirements": { "type": "string", "enum": [ "LISTING", "LISTING_PRODUCT_ONLY", "LISTING_OFFER_ONLY" ], "description": "Name of the requirements set represented in this product type definition." }, "requirementsEnforced": { "type": "string", "enum": [ "ENFORCED", "NOT_ENFORCED" ], "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)." }, "propertyGroups": { "description": "Mapping of property group names to property groups. Property groups represent logical groupings of schema properties that can be used for display or informational purposes." }, "locale": { "type": "string", "description": "Locale of the display elements contained in the product type definition." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "Amazon marketplace identifiers for which the product type definition is applicable." }, "productType": { "type": "string", "description": "The name of the Amazon product type that this product type definition applies to." }, "displayName": { "type": "string", "description": "Human-readable and localized description of the Amazon product type." }, "productTypeVersion": { "type": "object", "properties": { "version": { "type": "string", "description": "Version identifier." }, "latest": { "type": "boolean", "description": "When true, the version indicated by the version identifier is the latest available for the Amazon product type." }, "releaseCandidate": { "type": "boolean", "description": "When true, the version indicated by the version identifier is the prerelease (release candidate) for the Amazon product type." } }, "required": [ "version", "latest" ], "description": "Human-readable and localized description of the Amazon product type." } }, "required": [ "schema", "requirements", "requirementsEnforced", "propertyGroups", "locale", "marketplaceIds", "productType", "displayName", "productTypeVersion" ] }, "definitionsProductTypes_2020_09_01_ProductTypeList": { "type": "object", "properties": { "productTypes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Amazon product type." }, "displayName": { "type": "string", "description": "Human-readable and localized description of the Amazon product type." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "The Amazon marketplace identifiers for which the product type definition is available." } }, "required": [ "name", "displayName", "marketplaceIds" ] }, "description": "A list of product types." }, "productTypeVersion": { "type": "string", "description": "Amazon product type version identifier." } }, "required": [ "productTypes", "productTypeVersion" ] }, "definitionsProductTypes_2020_09_01_ProductTypeVersion": { "type": "object", "properties": { "version": { "type": "string", "description": "Version identifier." }, "latest": { "type": "boolean", "description": "When true, the version indicated by the version identifier is the latest available for the Amazon product type." }, "releaseCandidate": { "type": "boolean", "description": "When true, the version indicated by the version identifier is the prerelease (release candidate) for the Amazon product type." } }, "required": [ "version", "latest" ] }, "definitionsProductTypes_2020_09_01_SchemaLink": { "type": "object", "properties": { "link": { "type": "object", "properties": { "resource": { "type": "string", "description": "URI resource for the link." }, "verb": { "type": "string", "enum": [ "GET" ], "description": "HTTP method for the link operation." } }, "required": [ "resource", "verb" ], "description": "Link to retrieve the schema." }, "checksum": { "type": "string", "description": "Checksum hash of the schema (Base64 MD5). Use this to verify schema contents, identify changes between schema versions, and for caching." } }, "required": [ "link", "checksum" ] }, "DeleteAttachmentsParams": { "type": "object", "properties": { "attachment_ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "attachment_ids" ] }, "DeleteAttachmentsResponse": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "type": "object", "properties": { "attachment_id": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" } }, "required": [ "attachment_id", "deleted" ] } } }, "required": [ "attachments" ] }, "DeleteAttachmentsSearchParams": { "type": "object", "properties": { "attachment_ids": { "type": "string", "description": "comma separated list of `attachment_id`s" } }, "required": [ "attachment_ids" ] }, "DeleteAzBoxesResponse": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "box_id": { "type": "string" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" } } } } }, "required": [ "boxes" ] }, "DeleteAzPalletsParams": { "type": "object", "properties": { "shipment_id": { "type": "string" }, "pallet_ids": { "type": "array", "items": { "type": "number" } } }, "required": [ "pallet_ids" ] }, "DeleteAzPalletsResponse": { "type": "array", "items": { "type": "object", "properties": { "pallet_id": { "type": "number" }, "deleted": { "type": "string" } }, "required": [ "pallet_id", "deleted" ] } }, "DeleteBundlePathParams": { "type": "object", "properties": { "bundle_id": { "type": "string", "description": "comma separated list of `bundle_id`s" } }, "required": [ "bundle_id" ] }, "DeleteBundlesResponse": { "type": "object", "properties": { "bundles": { "type": "array", "items": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" } }, "required": [ "bundle_id", "deleted" ] } } }, "required": [ "bundles" ] }, "DeletedAttachment": { "type": "object", "properties": { "attachment_id": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" } }, "required": [ "attachment_id", "deleted" ] }, "DeletedAzBox": { "type": "object", "properties": { "box_id": { "type": "string" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" } } }, "DeletedLocation": { "type": "object", "properties": { "location_id": { "type": "string" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" } } }, "DeletedPackTemplate": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" } } }, "DeletedPlan": { "type": "object", "properties": { "plan_id": { "type": "string" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" } } }, "DeletedPurchaseOrder": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" } }, "required": [ "purchase_order_id", "deleted" ] }, "DeletedPurchaseOrderItem": { "type": "object", "properties": { "purchase_order_item_id": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" } }, "required": [ "purchase_order_item_id", "deleted" ] }, "DeletedSupplier": { "type": "object", "properties": { "supplier_id": { "type": "string" }, "archived": { "type": [ "string", "null" ], "format": "date-time" } } }, "DeletedTag": { "type": "object", "properties": { "tag_id": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" } }, "required": [ "tag_id", "deleted" ] }, "DeleteLocationsResponse": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "location_id": { "type": "string" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" } } } } }, "required": [ "locations" ] }, "DeleteMappingsResponse": { "type": "array", "items": { "type": "object", "properties": { "mapping_id": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" } }, "required": [ "mapping_id", "deleted" ] } }, "DeleteMappingsSearchParams": { "type": "object", "properties": { "mapping_ids": { "type": "string", "description": "comma separated list of `mapping_id`s" } }, "required": [ "mapping_ids" ] }, "DeletePackTemplateItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "sku": { "type": "string" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" } } } } }, "required": [ "items" ] }, "DeletePackTemplateItemsSearchParams": { "type": "object", "properties": { "skus": { "type": "array", "items": { "type": "string" } } } }, "DeletePackTemplatesResponse": { "type": "object", "properties": { "pack_templates": { "type": "array", "items": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" } } } } }, "required": [ "pack_templates" ] }, "DeletePlanItemsPathParams": { "type": "object", "properties": { "plan_id": { "type": "string" }, "plan_item_id": { "type": "string", "description": "comma separated list of `plan_item_id`s, eg. `123,456`" } }, "required": [ "plan_item_id" ] }, "DeletePlanItemsResponse": { "type": "object", "properties": { "plan_items": { "type": "array", "items": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "deleted": { "type": [ "string", "null" ] } }, "required": [ "plan_item_id", "deleted" ] } } }, "required": [ "plan_items" ] }, "DeletePlansResponse": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "plan_id": { "type": "string" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" } } } } }, "required": [ "plans" ] }, "DeletePlansSearchParams": { "type": "object", "properties": { "put_back": { "type": "boolean" } } }, "DeleteProxyeesResponse": { "type": "object", "properties": { "proxyees": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" }, "disabled": { "type": "string", "format": "date-time", "description": "The user who can be proxied into by the user_id account" } }, "required": [ "disabled" ] } } }, "required": [ "proxyees" ] }, "DeletePurchaseOrderItemsParams": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "purchase_order_item_ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "purchase_order_id", "purchase_order_item_ids" ] }, "DeletePurchaseOrderItemsPathParams": { "type": "object", "properties": { "purchase_order_id": { "type": "string" } } }, "DeletePurchaseOrderItemsResponse": { "type": "object", "properties": { "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_item_id": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" } }, "required": [ "purchase_order_item_id", "deleted" ] } } }, "required": [ "purchase_order_items" ] }, "DeletePurchaseOrderItemsSearchParams": { "type": "object", "properties": { "purchase_order_item_ids": { "type": "string", "description": "comma separated list of `purchase_order_item_id`s" } }, "required": [ "purchase_order_item_ids" ] }, "DeletePurchaseOrdersResponse": { "type": "object", "properties": { "purchase_orders": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" } }, "required": [ "purchase_order_id", "deleted" ] } } }, "required": [ "purchase_orders" ] }, "DeleteReportScheduleParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "scheduleId": { "type": "string", "description": "A unique identifier assigned to the report schedule." } }, "required": [ "scheduleId" ] }, "DeleteReportScheduleResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "message": { "type": "string" } } }, "DeleteSettingsSearchParams": { "type": "object", "properties": { "client_id": { "type": "string", "description": "if provided, delete the setting at the client-level" } } }, "DeleteSubscriptionResponse": { "type": "object", "properties": { "eventType": { "type": "string", "description": "Event type for which the subscription was created." }, "subscriptionId": { "type": "string", "description": "Unique identifier for the subscription that you can use to fetch details, edit, or delete the subscription." }, "partnerId": { "type": "string", "description": "Partner ID of the seller who created the subscription." }, "eventVersion": { "type": "string", "description": "Version of the event type for which the subscription was created." }, "resourceName": { "type": "string", "description": "Resource or functional category that the event type is mapped to (for example, ITEM, ORDER, PRICE)." }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ], "description": "Current state of the subscription." }, "message": { "type": "string" }, "subscribedBy": { "type": "string" } }, "required": [ "message", "subscribedBy" ] }, "DeleteSubscriptionSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "DeleteTagsParams": { "type": "object", "properties": { "tag_ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "tag_ids" ] }, "DeleteTagsResponse": { "type": "object", "properties": { "tags": { "type": "object", "properties": { "tag_id": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" } }, "required": [ "tag_id", "deleted" ] } }, "required": [ "tags" ] }, "DeleteWebHookResponse": { "type": "object", "properties": { "web_hook": { "type": "object", "properties": { "name": { "type": "string" }, "deleted": { "type": "string" } }, "required": [ "deleted" ] } }, "required": [ "web_hook" ] }, "DisableClientsResponse": { "type": "object", "properties": { "clients": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" }, "disabled": { "type": "string", "format": "date-time", "description": "The user who can be proxied into by the user_id account" } }, "required": [ "disabled" ] } } }, "required": [ "clients" ] }, "DisabledProxyee": { "type": "object", "properties": { "user_id": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" }, "disabled": { "type": "string", "format": "date-time", "description": "The user who can be proxied into by the user_id account" } }, "required": [ "disabled" ] }, "DisableUserIntegrationResponse": { "type": "object", "properties": { "integration_id": { "type": "string" }, "disabled": { "type": [ "string", "null" ], "format": "date-time", "description": "The user who can be proxied into by the user_id account" } }, "required": [ "disabled" ] }, "DownloadLabelSearchParams": { "type": "object", "properties": { "shipmentId": { "type": "string" }, "labelType": { "type": "string" }, "labelSize": { "type": "string" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "DownloadReportParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "requestId": { "type": "string", "description": "System-generated ID that uniquely identifies the report request." } }, "required": [ "requestId" ] }, "DownloadReportResponse": { "type": "object", "properties": { "requestId": { "type": "string", "description": "System-generated ID that uniquely identifies the report request." }, "requestStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ], "description": "Filters report requests by status." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated. Example: ITEM for Item Report." }, "reportVersion": { "type": "string", "description": "Version of report for which the request is created. Example, v1." }, "downloadURL": { "type": "string", "description": "URL to be used to download the report." }, "downloadURLExpirationTime": { "type": "string", "description": "Time till when the URL to download the report will be valid." }, "requestSubmissionDate": { "type": "string", "description": "Date and time on which the report request is submitted." }, "reportGenerationDate": { "type": "string", "description": "Date and time on which the report is generated. Attribute is available only if report is generated." } } }, "EnableUserIntegrationResponse": { "type": "object", "properties": { "integration_id": { "type": "string" }, "success": { "type": "boolean", "description": "true if successful. May be false if integration_id doesn't exist or has been archived." } }, "required": [ "success" ] }, "Error": {}, "EventTypesResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "eventTypes": { "type": "array", "items": { "type": "object", "properties": { "resourceName": { "type": "string", "description": "Resource (functional category) that the event type maps to (for example, ITEM, PRICE, ORDER)." }, "eventType": { "type": "string", "description": "Event type you can subscribe to." }, "eventVersion": { "type": "string", "description": "Version identifier of the event type." }, "description": { "type": "string", "description": "Description of the specific event type." } }, "required": [ "resourceName", "eventType", "eventVersion", "description" ] }, "description": "List of event type definitions available for subscription." } } }, "EventTypesSearchParams": { "type": "object", "properties": { "mp": { "type": "string" } }, "required": [ "mp" ] }, "ExtendedAzBox": { "type": "object", "properties": { "box_id": { "type": "string" }, "user_id": { "type": "string" }, "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "pallet_id": { "type": [ "number", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "tracking_id": { "type": [ "string", "null" ] }, "inbound_plan_id": { "type": [ "string", "null" ] }, "packing_option_id": { "type": [ "string", "null" ] }, "packing_group_id": { "type": [ "string", "null" ] }, "package_id": { "type": [ "string", "null" ] }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ] }, "print_box_label_quantity": { "type": "number" }, "length": { "type": [ "number", "null" ] }, "width": { "type": [ "number", "null" ] }, "height": { "type": [ "number", "null" ] }, "unit_of_measurement": { "type": [ "string", "null" ], "enum": [ "CM", "IN" ] }, "weight": { "type": [ "number", "null" ] }, "unit_of_weight": { "type": [ "string", "null" ], "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "amazon_box_id": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "box_item_id": { "type": "string" }, "user_id": { "type": "string" }, "box_id": { "type": "number" }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "external_id": { "type": "string" }, "sku": { "type": "string" }, "fnsku": { "type": [ "string", "null" ] }, "label_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ] }, "prep_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ] }, "manufacturing_lot_code": { "type": [ "string", "null" ] }, "prep_instructions": { "anyOf": [ {}, { "type": "null" } ] }, "quantity": { "type": "number" }, "packing_group_id": { "type": [ "string", "null" ] }, "plan_item_id": { "type": [ "number", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "box_item_id", "user_id", "box_id", "expires", "external_id", "sku", "fnsku", "label_owner", "prep_owner", "manufacturing_lot_code", "prep_instructions", "quantity", "packing_group_id", "plan_item_id", "created", "created_by", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by" ] }, "description": "set if `with_items` option was set" } } }, "ExtendedBundle": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "bundle_item_id": { "type": "string" }, "bundle_id": { "type": "string" }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } } } } } } } }, "ExtendedBundleItem": { "type": "object", "properties": { "bundle_item_id": { "type": "string" }, "bundle_id": { "type": "string" }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } } } } }, "ExtendedFeed": { "type": "object", "properties": { "feed_id": { "type": "string" }, "user_id": { "type": "string" }, "feed_type_id": { "type": "number" }, "feed_status_id": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "data": { "type": [ "object", "null" ], "properties": { "feedId": { "type": "string" }, "feedType": { "type": "string", "enum": [ "price", "inventory", "MP_ITEM_MATCH", "MP_ITEM", "PRICE_AND_PROMOTION", "OMNI_WFS" ] }, "feedStatus": { "type": "string", "enum": [ "ERROR", "RECEIVED", "INPROGRESS", "PROCESSED", "Submitted" ] }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "itemDetails": { "type": "object", "properties": { "itemIngestionStatus": { "type": "object", "additionalProperties": { "type": "object", "properties": { "martId": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "wpid": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "index": { "type": "object" }, "ingestionStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "INPROGRESS" ] }, { "type": "string", "enum": [ "SUCCESS" ] }, { "type": "string", "enum": [ "DATA_ERROR" ] }, { "type": "string", "enum": [ "SYSTEM_ERROR" ] }, { "type": "string", "enum": [ "TIMEOUT_ERROR" ] } ] }, "sku": { "type": "object" }, "ingestionErrors": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "ingestionError": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ] }, "code": { "type": "string" }, "field": { "type": "object" }, "description": { "type": "object" } }, "required": [ "type", "code" ] } } ] } } } ] } } } } }, "required": [ "itemIngestionStatus" ] } }, "required": [ "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing", "itemDetails" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "source_data": { "type": [ "object", "null" ], "properties": { "buylist_ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "buylist_ids" ] }, "pending_feeds": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "MPItemFeedHeader": { "oneOf": [ { "type": "object", "properties": { "requestId": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "requestBatchId": { "type": "object" }, "feedDate": { "type": "object" }, "processMode": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "REPLACE" ] } ] }, "subset": { "type": "object" }, "Mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sellingChannel": { "type": "string", "enum": [ "mpsetupbymatch" ] }, "version": { "type": "string", "enum": [ "4.2" ] }, "locale": { "type": "string", "enum": [ "en" ] } }, "required": [ "sellingChannel", "version", "locale" ] }, { "type": "object", "properties": { "businessUnit": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ] }, "locale": { "type": "string", "enum": [ "en" ] }, "version": { "type": "string", "enum": [ "5.0.20250121-19_24_23-api" ] } }, "required": [ "businessUnit", "locale", "version" ] }, { "type": "object", "properties": { "businessUnit": { "type": "object" }, "locale": { "type": "string", "enum": [ "en" ] }, "version": { "type": "string", "enum": [ "2.0.20240126-12_25_52-api" ] } }, "required": [ "businessUnit", "locale", "version" ] } ] }, "MPItem": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "Item": { "type": "object", "properties": { "sku": { "type": "string" }, "productIdentifiers": { "type": "object", "properties": { "productIdType": { "type": "string", "enum": [ "EAN", "GTIN", "ISBN", "UPC" ] }, "productId": { "type": "string" } }, "required": [ "productIdType", "productId" ] }, "price": { "type": "number" }, "ShippingWeight": { "type": "number" }, "condition": { "type": "string", "enum": [ "New", "New with defects", "New without box", "New without tags", "Open Box", "Pre-Owned: Fair", "Pre-Owned: Good", "Pre-Owned: Like New", "Remanufactured", "Restored Premium", "Restored" ] }, "mainImageUrl": { "type": "object" }, "productSecondaryImageURL": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "productCategory": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "Animal Accessories" ] }, { "type": "string", "enum": [ "Animal Food" ] }, { "type": "string", "enum": [ "Animal Health & Grooming" ] }, { "type": "string", "enum": [ "Animal Other" ] }, { "type": "string", "enum": [ "Art & Craft" ] }, { "type": "string", "enum": [ "Baby Diapering, Care, & Other" ] }, { "type": "string", "enum": [ "Baby Food" ] }, { "type": "string", "enum": [ "Baby Furniture" ] }, { "type": "string", "enum": [ "Baby Toys" ] }, { "type": "string", "enum": [ "Baby Transport" ] }, { "type": "string", "enum": [ "Beauty, Personal Care, & Hygiene" ] }, { "type": "string", "enum": [ "Bedding" ] }, { "type": "string", "enum": [ "Books & Magazines" ] }, { "type": "string", "enum": [ "Building Supply" ] }, { "type": "string", "enum": [ "Cameras & Lenses" ] }, { "type": "string", "enum": [ "Carriers & Accessories" ] }, { "type": "string", "enum": [ "Cases & Bags" ] }, { "type": "string", "enum": [ "Ceremonial Clothing & Accessories" ] }, { "type": "string", "enum": [ "Clothing" ] }, { "type": "string", "enum": [ "Computer Components" ] }, { "type": "string", "enum": [ "Computers" ] }, { "type": "string", "enum": [ "Costumes" ] }, { "type": "string", "enum": [ "Cycling" ] }, { "type": "string", "enum": [ "Decorations & Favors" ] }, { "type": "string", "enum": [ "Electrical" ] }, { "type": "string", "enum": [ "Electronics Accessories" ] }, { "type": "string", "enum": [ "Electronics Cables" ] }, { "type": "string", "enum": [ "Electronics Other" ] }, { "type": "string", "enum": [ "Food & Beverage" ] }, { "type": "string", "enum": [ "Footwear" ] }, { "type": "string", "enum": [ "Fuels & Lubricants" ] }, { "type": "string", "enum": [ "Funeral" ] }, { "type": "string", "enum": [ "Furniture" ] }, { "type": "string", "enum": [ "Garden & Patio" ] }, { "type": "string", "enum": [ "Gift Supply & Awards" ] }, { "type": "string", "enum": [ "Grills & Outdoor Cooking" ] }, { "type": "string", "enum": [ "Hardware" ] }, { "type": "string", "enum": [ "Health & Beauty Electronics" ] }, { "type": "string", "enum": [ "Home Decor, Kitchen, & Other" ] }, { "type": "string", "enum": [ "Household Cleaning Products & Supplies" ] }, { "type": "string", "enum": [ "Instrument Accessories" ] }, { "type": "string", "enum": [ "Jewelry" ] }, { "type": "string", "enum": [ "Land Vehicles" ] }, { "type": "string", "enum": [ "Large Appliances" ] }, { "type": "string", "enum": [ "Medical Aids & Equipment" ] }, { "type": "string", "enum": [ "Medicine & Supplements" ] }, { "type": "string", "enum": [ "Movies" ] }, { "type": "string", "enum": [ "Music Cases & Bags" ] }, { "type": "string", "enum": [ "Music" ] }, { "type": "string", "enum": [ "Musical Instruments" ] }, { "type": "string", "enum": [ "Office" ] }, { "type": "string", "enum": [ "Optical" ] }, { "type": "string", "enum": [ "Optics" ] }, { "type": "string", "enum": [ "Other" ] }, { "type": "string", "enum": [ "Photo Accessories" ] }, { "type": "string", "enum": [ "Plumbing & HVAC" ] }, { "type": "string", "enum": [ "Printers, Scanners, & Imaging" ] }, { "type": "string", "enum": [ "Safety & Emergency" ] }, { "type": "string", "enum": [ "Software" ] }, { "type": "string", "enum": [ "Sound & Recording" ] }, { "type": "string", "enum": [ "Sports & Recreation Other" ] }, { "type": "string", "enum": [ "Storage" ] }, { "type": "string", "enum": [ "TV Shows" ] }, { "type": "string", "enum": [ "TVs & Video Displays" ] }, { "type": "string", "enum": [ "Tires" ] }, { "type": "string", "enum": [ "Tools & Hardware Other" ] }, { "type": "string", "enum": [ "Tools" ] }, { "type": "string", "enum": [ "Toys" ] }, { "type": "string", "enum": [ "Vehicle Other" ] }, { "type": "string", "enum": [ "Vehicle Parts & Accessories" ] }, { "type": "string", "enum": [ "Video Games" ] }, { "type": "string", "enum": [ "Video Projectors" ] }, { "type": "string", "enum": [ "Watches" ] }, { "type": "string", "enum": [ "Watercraft" ] }, { "type": "string", "enum": [ "Wheels & Wheel Components" ] } ] }, "stateRestrictions": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "stateRestrictionsText": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "None" ] }, { "type": "string", "enum": [ "Illegal for Sale" ] }, { "type": "string", "enum": [ "Commercial" ] } ] }, "states": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "AK - Alaska" ] }, { "type": "string", "enum": [ "AL - Alabama" ] }, { "type": "string", "enum": [ "AR - Arkansas" ] }, { "type": "string", "enum": [ "AS - American Samoa" ] }, { "type": "string", "enum": [ "AZ - Arizona" ] }, { "type": "string", "enum": [ "CA - California" ] }, { "type": "string", "enum": [ "CO - Colorado" ] }, { "type": "string", "enum": [ "CT - Connecticut" ] }, { "type": "string", "enum": [ "DC - District of Columbia" ] }, { "type": "string", "enum": [ "DE - Delaware" ] }, { "type": "string", "enum": [ "FL - Florida" ] }, { "type": "string", "enum": [ "FM - Federated States of Micronesia" ] }, { "type": "string", "enum": [ "GA - Georgia" ] }, { "type": "string", "enum": [ "GU - Guam" ] }, { "type": "string", "enum": [ "HI - Hawaii" ] }, { "type": "string", "enum": [ "IA - Iowa" ] }, { "type": "string", "enum": [ "ID - Idaho" ] }, { "type": "string", "enum": [ "IL - Illinois" ] }, { "type": "string", "enum": [ "IN - Indiana" ] }, { "type": "string", "enum": [ "KS - Kansas" ] }, { "type": "string", "enum": [ "KY - Kentucky" ] }, { "type": "string", "enum": [ "LA - Louisiana" ] }, { "type": "string", "enum": [ "MA - Massachusetts" ] }, { "type": "string", "enum": [ "MD - Maryland" ] }, { "type": "string", "enum": [ "ME - Maine" ] }, { "type": "string", "enum": [ "MH - Marshall Islands" ] }, { "type": "string", "enum": [ "MI - Michigan" ] }, { "type": "string", "enum": [ "MN - Minnesota" ] }, { "type": "string", "enum": [ "MO - Missouri" ] }, { "type": "string", "enum": [ "MP - Commonwealth of the Northern Mariana Islands" ] }, { "type": "string", "enum": [ "MS - Mississippi" ] }, { "type": "string", "enum": [ "MT - Montana" ] }, { "type": "string", "enum": [ "NC - North Carolina" ] }, { "type": "string", "enum": [ "ND - North Dakota" ] }, { "type": "string", "enum": [ "NE - Nebraska" ] }, { "type": "string", "enum": [ "NH - New Hampshire" ] }, { "type": "string", "enum": [ "NJ - New Jersey" ] }, { "type": "string", "enum": [ "NM - New Mexico" ] }, { "type": "string", "enum": [ "NV - Nevada" ] }, { "type": "string", "enum": [ "NY - New York" ] }, { "type": "string", "enum": [ "OH - Ohio" ] }, { "type": "string", "enum": [ "OK - Oklahoma" ] }, { "type": "string", "enum": [ "OR - Oregon" ] }, { "type": "string", "enum": [ "PA - Pennsylvania" ] }, { "type": "string", "enum": [ "PR - Puerto Rico" ] }, { "type": "string", "enum": [ "PW - Palau" ] }, { "type": "string", "enum": [ "RI - Rhode Island" ] }, { "type": "string", "enum": [ "SC - South Carolina" ] }, { "type": "string", "enum": [ "SD - South Dakota" ] }, { "type": "string", "enum": [ "TN - Tennessee" ] }, { "type": "string", "enum": [ "TX - Texas" ] }, { "type": "string", "enum": [ "UM - U.S. Minor Outlying Islands" ] }, { "type": "string", "enum": [ "UT - Utah" ] }, { "type": "string", "enum": [ "VA - Virginia" ] }, { "type": "string", "enum": [ "VI - U.S. Virgin Islands" ] }, { "type": "string", "enum": [ "VT - Vermont" ] }, { "type": "string", "enum": [ "WA - Washington" ] }, { "type": "string", "enum": [ "WI - Wisconsin" ] }, { "type": "string", "enum": [ "WV - West Virginia" ] }, { "type": "string", "enum": [ "WY - Wyoming" ] } ] }, "zipCodes": { "type": "object" } } } } ] }, "additionalProductAttributes": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "productAttributeName": { "type": "string" }, "productAttributeValue": { "type": "string" } }, "required": [ "productAttributeName", "productAttributeValue" ] } } ] }, "additionalOfferAttributes": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "additionalOfferAttributeName": { "type": "string" }, "additionalOfferAttributeValue": { "type": "string" } }, "required": [ "additionalOfferAttributeName", "additionalOfferAttributeValue" ] } } ] } }, "required": [ "sku", "productIdentifiers", "price", "ShippingWeight", "condition" ] } }, "required": [ "Item" ] }, { "type": "object", "properties": { "Orderable": { "type": "object", "properties": { "sku": { "type": "string" }, "productIdentifiers": { "type": "object" }, "price": { "type": "number" }, "ShippingWeight": { "type": "number" }, "stateRestrictions": { "type": "object" }, "electronicsIndicator": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "Yes" ] }, { "type": "string", "enum": [ "No" ] } ] }, "chemicalAerosolPesticide": { "type": "object" }, "batteryTechnologyType": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "Mercury" ] }, { "type": "string", "enum": [ "Carbon Zinc" ] }, { "type": "string", "enum": [ "Lead Acid (Non-Spillable)" ] }, { "type": "string", "enum": [ "Alkaline" ] }, { "type": "string", "enum": [ "Does Not Contain a Battery" ] }, { "type": "string", "enum": [ "Lithium Primary (Lithium Metal)" ] }, { "type": "string", "enum": [ "Nickel Cadmium" ] }, { "type": "string", "enum": [ "Lithium Ion" ] }, { "type": "string", "enum": [ "Nickel Metal Hydride" ] }, { "type": "string", "enum": [ "Lead Acid" ] }, { "type": "string", "enum": [ "Silver" ] }, { "type": "string", "enum": [ "Magnesium" ] } ] }, "fulfillmentLagTime": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "shipsInOriginalPackaging": { "type": "object" }, "MustShipAlone": { "type": "object" }, "IsPreorder": { "type": "object" }, "releaseDate": { "type": "object" }, "startDate": { "type": "object" }, "endDate": { "type": "object" }, "quantity": { "type": "object" }, "fulfillmentCenterID": { "type": "object" }, "inventoryAvailabilityDate": { "type": "object" }, "ProductIdUpdate": { "type": "object" }, "SkuUpdate": { "type": "object" }, "msrp": { "type": "object" } }, "required": [ "sku", "productIdentifiers", "price", "ShippingWeight" ] }, "Visible": { "type": "object", "additionalProperties": { "type": "object", "properties": { "productName": { "type": "string" }, "brand": { "type": "string" }, "shortDescription": { "type": "string" }, "keyFeatures": { "type": "object" }, "mainImageUrl": { "type": "string" }, "isProp65WarningRequired": { "type": "string", "enum": [ "Yes", "No" ] }, "smallPartsWarnings": { "type": "string", "enum": [ "0 - No warning applicable", "1 - Choking hazard is a small ball", "2 - Choking hazard contains small ball", "3 - Choking hazard contains small parts", "4 - Choking hazard balloon", "5 - Choking hazard is a marble", "6 - Choking hazard contains a marble" ] }, "has_written_warranty": { "type": "string", "enum": [ "No", "Yes - Warranty Text", "Yes - Warranty URL" ] }, "netContent": { "type": "object", "properties": { "productNetContentMeasure": { "type": "number" }, "productNetContentUnit": { "type": "string", "enum": [ "Count", "Cubic Foot", "Case", "Centiliter", "Centimeter", "Each", "Fluid Ounces", "Foot", "Gallon", "Gram", "Inch", "Kilogram", "Liter", "Meter", "Milliliter", "Ounce", "Pallet/Unit Load", "Pint", "Pound", "Quart Dry", "Quart", "Square Foot", "Yard" ] } }, "required": [ "productNetContentMeasure", "productNetContentUnit" ] }, "productSecondaryImageURL": { "type": "object" }, "assembledProductLength": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "measure": { "type": "number" }, "unit": { "type": "string", "enum": [ "mm", "ft", "cm", "in" ] } }, "required": [ "measure", "unit" ] } ] }, "assembledProductWidth": { "type": "object" }, "assembledProductHeight": { "type": "object" }, "assembledProductWeight": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "measure": { "type": "number" }, "unit": { "type": "string", "enum": [ "lb", "oz" ] } }, "required": [ "measure", "unit" ] } ] }, "prop65WarningText": { "type": "object" }, "color": { "type": "object" }, "colorCategory": { "type": "array", "items": { "type": "string", "enum": [ "Silver", "Beige", "Black", "Blue", "Bronze", "Brown", "Clear", "Gold", "Gray", "Green", "Multicolor", "Off-White", "Orange", "Pink", "Purple", "Red", "White", "Yellow" ] } }, "countPerPack": { "type": "object" }, "condition": { "type": "object" }, "manufacturer": { "type": "object" }, "manufacturerPartNumber": { "type": "object" }, "material": { "type": "object" }, "modelNumber": { "type": "object" }, "multipackQuantity": { "type": "object" }, "netContentStatement": { "type": "object" }, "pieceCount": { "type": "object" }, "occasion": { "type": "object" }, "productLine": { "type": "object" }, "skateboard_riser_type": { "type": "object" }, "sportsLeague": { "type": "object" }, "sportsTeam": { "type": "object" }, "thirdPartyAccreditationSymbolOnProductPackageCode": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "Fair 'n Green", "Mom's Choice Award", "Parent Tested Parent Approved (PTPA) Winner's Seal of Approval", "Water Quality Association (WQA's)- Tested and Certified", "100 Percent Canadian Milk", "100% Veganskt", "ACMI", "ADCCPA", "AFIA Pet Food Facility", "AGRI Confiance", "AMA Organic Seal", "ATG", "Absence of Eggs and Milk is a Certified Allergen Control (CAC)", "Absence of Eggs, Milk and Peanuts is a Certified Allergen Control (CAC)", "Absence of Peanuts & Almonds is a Certified Allergen Control (CAC)", "Agence Bio", "Agri Natura", "Agriculture Biologique", "Air cleaner performance standard e.g., humidifiers", "Aise 2005", "Aise 2010", "Aise", "Aliments BIO Prepares au Quebec", "Aliments Prepares au Quebec", "Aliments du Quebec BIO", "Aliments du Quebec", "Alpinavera", "Aluminium Gesamtverband der Aluminiumindustrie", "Ama Organic Seal Black", "Ama Seal of Approval", "American Dental Association", "American Heart Association Certified", "Animal Welfare Approved Grassfed", "Appellation Origine Controlee", "Approved by the Asthma and Allergy Association", "Aqua GAP", "Aquaculture Stewardship Council", "Arla Farmer Owned", "Asmi", "Asthma and Allergy Foundation of America", "Atlanta Kashrus Commission Certification", "BC SPCA", "BDIH Logo", "BRC Global Standards", "BSCI", "Bais Din of Crown Heights Vaad HaKashrus Certification", "Bebat", "Belgaqua", "Benor", "Berchtesgadener Land", "Best Aquaculture Practices 2 Stars", "Best Aquaculture Practices 3 Stars", "Best Aquaculture Practices 4 Stars", "Best Aquaculture Practices", "Beter Leven 1 Ster", "Beter Leven 2 Ster", "Beter Leven 3 Ster", "Better Business Bureau Accredited", "Better Cotton Initiative", "Biko Tirol", "Bio Fisch", "Bio Gourmet Knospe", "Bio Knospe Umstellung", "Bio Knospe", "Bio Partenaire", "Bio Ring Allgaeu", "Bio Solidaire", "Bio Suisse Knospe Umstellung", "Bio Suisse Knospe", "Bio-Bayern with Certificate of Provenance", "Bio-Bayern without Certificate of Provenance", "Bio-LABEL Baden-Württemberg", "Bio-LABEL Hessen", "Biodegradable Ingredients", "Biodegradable Products Institute", "Biodegradable", "Biodynamic Certification", "Biogarantie", "Biokreis", "Bioland Ennstal", "Bioland", "Biopark", "Bios Kontrolle", "Bird Friendly Coffee Smithsonian Certification", "Bk Check Vaad Hakashrus Of Buffalo", "Blue Angel", "Blue Ribbon Kosher", "Bluesign Technologies AG Approved e.g., footwear insoles", "BonSucro", "Bord Bia Approved Meat", "Bord Bia Approved", "BreatheWay", "Brewers Association Certified Independent Craft", "British Retail Consortium Certification", "Bullfrog Power", "CAC Absence of Almond", "CAC Absence of Egg", "CAC Absence of Milk", "CAC Absence of Peanut", "CAN/ BNQ Certified", "CCA Gluten Free", "CCF Rabbit Certification", "CCOF", "CEBEC", "CO2 Neutral Certified", "CO2 Reduceret Emballage", "CPE Scharrel Eieren", "CPE Vrije Uitloop Eieren", "CSA International", "CSA/NCA - Gluten Free", "Canada Organic Canadian Organic Logo", "CanadaGAP program certification mark of conformity", "Canadian Agricultural Products", "Canadian Association of Fire Chiefs Approved", "Canadian Certified Compostable", "Canadian Eco Logo", "Canadian Federal Government – CFIA Grade Stamps Canada A e.g. poultry & eggs", "Canadian Federal Government – CFIA Grade Stamps Canada C e.g. poultry & eggs", "Canadian Federal Government – CFIA Grade Stamps Canada Utility e.g. poultry & eggs", "Canadian Federal Government – Dairy Product Grade", "Canadian Federal Government – Processed Egg Products", "Canadian Food Inspection Agency (CFIA) as Federally Registered & Inspected Facility - Fish", "Canadian Food Inspection Agency (CFIA) as Federally Registered & Inspected Facility e.g., meat", "Canned in Canada to describe green beans", "Carbon Footprint Standard", "Carbon Neutral NCOS Certified", "Carbon Neutral packaging", "Carbon Neutral", "Caribbean Kosher", "Caring Consumer PETA", "Celiac Sprue Association", "Central Rabbinical Congress Kosher", "Certified Angus Beef", "Certified B Corporation", "Certified California Sustainable Vineyard and Winery (CCSW)", "Certified Carbon Free", "Certified Humane Organisation", "Certified Humane", "Certified Naturally Grown (CNG)", "Certified Naturally Grown", "Certified OE 100", "Certified Organic Baystate Organic Certifiers", "Certified Organic By Organic Certifiers", "Certified Paleo Friendly", "Certified Paleo", "Certified Sustainable Wine of Chile", "Certified WBENC", "Certified Wildlife Friendly", "Cheese – World Champion Cheese Contest", "Ches K", "Chicago Rabbinical Council", "Cincinnati Kosher", "Claro Fair Trade", "Climate Neutral", "Cocoa Life", "Consumer Choice Award", "Corrugated Recycles", "Cosmebio", "Cotton made in Africa", "Council of Orthodox Rabbis of Greater Detroit Certification", "Cradle To Cradle", "Crossed Grain Symbol", "Culinarium", "DLG Award", "DZG Gluten Free", "Dallas Kosher Certification", "Dansk IP Kvalitet", "Dansk Maelk", "Deer Protection Program", "Delinat", "Demeter Label", "Dermatology Review Panel (\"DRP\") independent dermatologists review", "Design for the Environment (DfE)", "Diamond K - Massachusetts Certification", "Direct Trade", "Distilled in Canada to describe bottled water", "Dolphin Safe", "Donau Soya Standard", "ECARF Seal", "ECOCert Cosmos Natural", "ECOCert Cosmos Organic", "ECOLAND", "EarthKosher Kosher Certification", "Earthsure", "Eco Kreis", "Eco Label Ladybug", "Eco Logo", "EcoCert Certificate", "Ecogarantie", "Ecovin", "Eczema Society of Canada- Accepted", "Eesti Okomark", "Eesti Parim Toiduaine", "Eko", "Enec", "Energy Star", "Epeat Bronze", "Epeat Gold", "Epeat Silver", "Equal Exchange Fairly Traded", "Equalitas Sustainable Wine", "Erde Saat", "Erkend Streek Product", "Ethical Tea Partnership", "Fair Flowers Fair Plants", "Fair Food Program Label", "Fair Trade USA Ingredients", "Fair Trade USA", "Fair for Life", "Fair trade mark", "FairTSA", "FairTrade Cotton", "FairTrade Sugar", "Fairtrade Sourced Ingredient Cashew Nuts", "Fairtrade Sourced Ingredient Cocoa", "Fairtrade Sourced Ingredient Coconut", "Fairtrade Sourced Ingredient Dried Apricots", "Fairtrade Sourced Ingredient Green Tea", "Fairtrade Sourced Ingredient Honey", "Fairtrade Sourced Ingredient Lime Juice", "Fairtrade Sourced Ingredient Mango Juice", "Fairtrade Sourced Ingredient Olive Oil", "Fairtrade Sourced Ingredient Pepper", "Fairtrade Sourced Ingredient Quinoa", "Fairtrade Sourced Ingredient Rice", "Fairtrade Sourced Ingredient Roses", "Fairtrade Sourced Ingredient Tea", "Fairtrade Sourced Ingredient Vanilla", "Falken", "Farmers & Growers (Organic Certification UK2)", "Federal Communications Commission (U.S.)", "Federally Registered Inspected Canada", "Fidelio", "Finnish Heart Symbol", "Finnish Pork Meat Certification System", "Fish Wise Certification", "Flamme Verte", "Flandria", "Food Alliance Certified", "Food Federation", "Food Justice Certified", "Food Safety System Certification 22000", "Foodland Ontario", "For Life (Social Responsibility)", "Forest Products - Product Lines From a Certified Forest", "Forest Stewardship Council 100 Percent", "Forest Stewardship Council Label", "Forest Stewardship Council Mix", "Forest Stewardship Council Recycled", "Foundation Art", "Freiland", "Freshcare", "Friend of the Sea", "GAA", "GCP – Global Coffee Platform", "GFCO", "GFCP", "GIG - Gluten Free Foodservice", "GMO Guard from Natural Food Certifiers", "GMO Marked", "GMP Certified", "GMP ISO 22716", "GRASKEURMERK", "GRASP – Risk Assessment on Social Practise", "Gaskeur", "Gastec", "Gebana", "Gepruefte Sicherheit", "Gezondere Keuze", "Global Care", "Global Gap", "Global Organic Latex Standard", "Global Organic Textile Standard", "Gluten-free Certified: Allergen Control Group/ National Foundation for Celiac Awareness (NFCA)", "Glycaemic Index Foundation", "Glycaemic Research Institute", "Good Housekeeping", "GoodWeave", "Green America Certified Business", "Green Dot", "Green Restaurant Association Endorsed", "Green Seal Certified", "Green Seal", "Green Shield Certified", "Green Star Certified", "Green-e Energy Certified", "Green-e Energy", "GreenChoice", "Groen Label Kas", "Guaranteed Irish", "Halal Certification Services", "Halal Certification Services, CH", "Halal Correct", "Halal Islamic Food and Nutrition Council of Canada (IFANCC)", "Halal Islamic Society of North America (ISNA)", "Halal Plus", "Haute Valeur Environnementale", "Hazard Analysis Critical Control Point", "Health Check", "Heumilch", "Hochstamm Suisse", "Humane Heartland", "Hypertension Canada Medical Device", "ICADA", "ICEA", "IFANCA Halal", "IFOAM", "IFS HPC", "IGP", "IHTK Seal", "IKB EIEREN", "IKB KIP", "IKB VARKEN", "INSTITUT FRESENIUS", "INT Protection", "IP Suisse", "ISEAL Alliance", "ISO Quality", "IVN Natural Leather", "IVN Natural Textiles Best", "IVO Seal – International Verified Omega-3 e.g., Fish oil", "Imported in bulk and packaged in Canada", "Indeklima Maerket", "Integrity and Sustainability Certified", "International Aloe Science Council Certificate", "International Taste & Quality (iTQi) Superior Taste Award", "Intertek Certificate", "Intertek Electrical Testing Laboratories (ETL) Mark", "Jay Kosher Pareve", "KAT", "KEMA KEUR", "KIWA", "KOF K Kosher", "KOMO", "KSA - Kosher", "KSA D - Kosher Dairy", "KVBG Approved", "KVH Kosher", "Kashruth Council of Canada Kosher Certification", "Kehilla Kosher California K", "Kehilla Kosher Heart K", "Klasa", "Kosher - Chicago Rabbinical Council (CRC) Dairy", "Kosher COR Dairy Equipment", "Kosher COR Dairy", "Kosher COR Fish", "Kosher Certification Service", "Kosher Check", "Kosher Chicago Rabbinical Council (CRC) Pareve", "Kosher Grand Rabbinate of Quebec Parve", "Kosher Inspection Service India", "Kosher KW Young Israel Of West Hempstead", "Kosher Kosher Greece", "Kosher Kosher Madrid Spain", "Kosher OK Dairy", "Kosher Oregon Kosher", "Kosher Organics", "Kosher Orthodox Jewish Congregation Parve", "Kosher Ottawa Vaad HaKashrut Canada", "Kosher Parve Natural Food Certifier", "Kosher Peru Certification", "Kosher Star-K -Parve and Passover", "Kosher Star-K-Parve", "Kosher Supervisors of Wisconsin Certification", "Kosher Western Kosher (WK)", "KosherMex", "Krav Mark", "LACON", "LGA", "LVA", "Label Rouge", "Label of the Allergy and Asthma Federation", "Laendle Qualitaet", "Leaping Bunny", "Lodi Rules \"Certified Green\"", "London Beth Din Kosher", "MCIA Organic", "MEHR WEG", "MPS A", "Made Green in Italy", "Made in Canada (a)", "Made in Canada from Domestic and Imported Ingredients", "Made in Canada", "Made with 100% Canadian Oats", "Made with Canadian (ingredient)", "Made with Canadian Beef", "Made with Canadian Mustard Seeds", "Made with Ontario Pork", "Marine Stewardship Council label", "Max Havelaar", "Midwest Kosher", "Minnesota Kosher Council", "Montreal Vaad Hair Mk Pareve", "Mortadella Bologna", "Mundusvini Gold", "Mundusvini Silver", "My Climate", "NAOOA Certified Quality", "NDOA", "NF Marque", "NMX", "NOM", "NPA", "NSF Certified For Sport", "NSF Gluten Free", "NSF Non GMO True North", "NSF Sustainability Certified", "NSF", "National Eczema Association Seal of Acceptance", "Natrue Label", "Natura- Beef", "Natura-Veal", "Nature Care Product", "Nature Et Progres", "Natureplus", "Naturland Fair Trade", "Naturland Wildfish", "Naturland", "Neuland", "No Product Package Certifications Apply", "Non GMO Project", "Non-GMO By Earthkosher", "Nyckelhalet", "OCIA", "OEKO Control", "OEKO Kreislauf", "OEKO Quality Guarantee Bavaria", "OEKO-Tex Made in Green", "OK Compost Home", "OK Compost Industrial", "OK Compost label by Vincotte", "OK Kosher Certification", "OKOTEST", "ORBI", "OU Kosher Dairy", "OU Kosher Fish", "OU Kosher Meat", "OU Kosher Passover", "Ocean Wise Recommended Sourced Responsibly", "Oeko Tex Label", "Official Eco label Sun", "On the way to planetproof", "Ontario - Localize", "Ontario approved legend - Inspected meat products, provincially licensed plants", "Oregon LIVE (Low Input Viticulture and Enology)", "Oregon Tilth", "Organic 100 Content Standard", "Organic Certifying Body - Centre for Systems Integration,", "Organic Certifying Body - International Certification Services, Inc. (ICS), North Dakota, USA", "Organic Certifying Body - JAS (Japanese Agricultural Standards)", "Organic Certifying Body - OTCO (OREGON TILTH CERTIFIED ORGANIC), Oregon, U.S.A.", "Organic Certifying Body – Agricultural Services Certified Organic (ASCO)", "Organic Certifying Body – Debio", "Organic Certifying Body – EcoCert, Quebec, Canada", "Organic Certifying Body – Global Organic Alliance (GOA), Ohio, U.S.A.", "Organic Certifying Body – Letis S.A.", "Organic Certifying Body – Organisme de Certification Québec Vrai (OCQV)", "Organic Certifying Body – Pro-Cert Organic Systems, Saskatchewan, Canada", "Organic Certifying Body – Province of British Columbia Certified Organic, British Columbia Association for Regenerative Agriculture (BCARA), Canada", "Organic Certifying Body – Quality Certification Services (QCS), Florida, U.S.A.", "Organic Certifying Body – Trans Canada Organic Certification Services (TCO), Saskatchewan, Canada", "Organic Certifying Body –Pacific Agricultural Certification Society (PACS), British Columbia, Canada", "Organic Cotton", "Orthodox Rabbinical Board", "Orthodox Union Kosher", "Ozone Friendly General Claim", "PCO", "PEFC Certified", "PEFC Recycled", "PEFC", "Paleo Approved", "Paleo By Earthkosher", "Pet to Pet", "Plastic Free Trust Mark", "Prepared in Canada", "Pro Specie Rara", "Pro-Terra Non-GMO Certification", "Processed in Canada", "Proderm", "Product of Canada", "Product of the Vinho Verde Region", "Product of the Year, Consumer Survey", "Produit en Bretagne", "Protected Designation of Origin", "Protected Geographical Indication", "Protected Harvest Certified", "Proudly Canadian", "Proven Quality Bavaria", "Puhtaasti Kotimainen", "QAI", "QS", "Qualenvi", "Qualitaet Tirol", "Quality Rhoen", "RAL Quality Candles", "REGIONALFENSTER", "RHP", "RSB – Roundtable on Sustainable Biomaterials", "RT-QuIC Tested", "RT-QuIC", "Rabbinical Council Of British Columbia BCK", "Rabbinical Council Of California", "Rabbinical Council Of New England", "Rainforest Alliance", "Real California Cheese", "Real California Milk", "Real Food Seal", "Recognized Canadian Dermatology Association Skin Health", "Recognized Canadian Dermatology Association Sun Protection", "Recupel", "Recyclable General Claim", "Refined in Canada", "Roasted and blended in Canada to describe coffee", "Round Table on Responsible Soy", "SCS Sustainably Grown", "SGS Organic", "SKG 1 star", "SKG 2 star", "SKG 3 star", "SKG Certificate", "SLG Child Safety", "SLG Type Tested", "SLK Bio", "SOIL Organic Cosmos", "SOSTain", "STAR K Kosher", "SUS", "Safe Feed Safe Food", "Safe Quality Food", "Salmon Safe Certification", "Schweizer Allergie Gütesiegel", "Schweizer Alpprodukt", "Schweizer Bergprodukt", "SeaChoice", "Seedling", "Shopper Army", "Society of the Plastics Industry (SPI)", "Soil Association Organic Symbol", "Star D Kosher", "Steel Recycling", "Stellar Certification Services", "Stiftung Warentest", "Stop Climate Change", "Streekproduct.be", "Suisse Garantie", "Sunshine State Kosher", "Sustainable Forestry Initiative", "Sustainable In Practice (SIP)", "Sustainable Palm Oil RSPO Certified", "Sustainable Palm Oil RSPO Credits", "Sustainable Palm Oil RSPO Mixed", "TCO Development", "TNO Approved", "TOOTHFRIENDLY", "Tarnopol Kashrus Kosher", "Terra Vitis", "The EcoLogo Certification", "The Fair Rubber Association", "The Natural and Organic Awards", "Three Line Kosher", "Traditional Specialty Guaranteed", "Transport Canada National Safety Mark (NSM)", "Triangle K Certification", "Triman", "True Foods Canada Trustmark", "True Source Certified", "U.S. Department of Agriculture (USDA) – Grade A e.g., eggs", "UNSER Land", "USDA Grade - AA", "USDA Inspection", "USDA Organic", "USDA", "UTZ Certified Cocoa", "UTZ Certified", "Underwriters laboratory", "Underwriters' Laboratory Certified, Canada \"C\" and U.S. US", "Uniquely Finnish", "United Egg Producers Certified", "V Label Vegan", "V Label Vegetarian", "V.I.V.A.", "VDE", "VDS Certificate", "VEILIG WONEN POLITIE KEURMERK", "Vaad Hakashrus of Denver Scroll K Certification", "Vaad Hoeir Kosher", "Vaelg Fuldkorn Forst", "Vegan - VegeCert", "Vegan Awareness Foundation", "Vegan By Earthkosher", "Vegan Natural Food Certifiers", "Vegan Society Vegan Logo", "Vegaplan", "Vegetarian Society - Vegetarian", "Vignerons en Développement Durable (VDD)", "WEIDEMELK", "WINERIES for Climate Protection (WfCP)", "WSDA", "WWF Panda Label", "Weight Watchers Endorsed", "Whole Grain 100 Percent Stamp", "Whole Grain Basic Stamp", "Whole Grain Council Stamp", "Whole grains 50 percent Stamp", "Zero Waste Business Council Certified" ] } } ] }, "count": { "type": "object" }, "warrantyText": { "type": "object" }, "warrantyURL": { "type": "object" }, "variantGroupId": { "type": "object" }, "variantAttributeNames": { "type": "object" }, "isPrimaryVariant": { "type": "object" }, "swatchImages": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "swatchVariantAttribute": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "color" ] }, { "type": "string", "enum": [ "assembledProductWidth" ] }, { "type": "string", "enum": [ "multipackQuantity" ] } ] }, "swatchImageUrl": { "type": "object" } } } } ] } }, "required": [ "productName", "brand", "shortDescription", "keyFeatures", "mainImageUrl", "isProp65WarningRequired", "smallPartsWarnings", "has_written_warranty", "netContent", "colorCategory", "condition" ] } }, "TradeItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "sku": { "type": "string" }, "countryOfOriginAssembly": { "type": "object" } }, "required": [ "sku", "countryOfOriginAssembly" ] } ] } }, "required": [ "Orderable", "Visible" ] }, { "type": "object", "properties": { "Promo&Discount": { "type": "object", "properties": { "sku": { "type": "string" }, "price": { "type": "number" }, "msrp": { "type": "number" } }, "required": [ "sku", "price", "msrp" ] } }, "required": [ "Promo&Discount" ] } ] } }, "feedId": { "type": "string" }, "feedType": { "type": "string", "enum": [ "price", "inventory", "MP_ITEM_MATCH", "MP_ITEM", "PRICE_AND_PROMOTION", "OMNI_WFS" ] }, "feedStatus": { "type": "string", "enum": [ "ERROR", "RECEIVED", "INPROGRESS", "PROCESSED", "Submitted" ] }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "buylist_ids": { "type": "object" } }, "required": [ "buylist_ids" ] } ] } }, "required": [ "MPItemFeedHeader", "MPItem", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "SupplierItemFeedHeader": { "type": "object", "properties": { "businessUnit": { "type": "string", "enum": [ "WALMART_US" ] }, "version": { "type": "string" }, "locale": { "type": "string", "enum": [ "en" ] } }, "required": [ "businessUnit", "version", "locale" ] }, "SupplierItem": { "type": "array", "items": { "type": "object", "properties": { "Visible": { "type": "object" }, "Orderable": { "type": "object" }, "TradeItem": { "type": "object" } }, "required": [ "Visible", "Orderable", "TradeItem" ] } }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "SupplierItemFeedHeader", "SupplierItem", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "InventoryHeader": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "1.4", "1.5" ] } }, "required": [ "version" ] }, "Inventory": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ] }, "amount": { "type": "number" } }, "required": [ "unit", "amount" ] } ] }, "inventoryAvailableDate": { "type": "object" }, "shipNodes": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "shipNode": { "type": "string" }, "quantity": { "type": "object" } }, "required": [ "shipNode", "quantity" ] } } ] } }, "required": [ "sku" ] } }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "InventoryHeader", "Inventory", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "inventoryHeader": { "type": "object" }, "inventory": { "type": "object" }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "inventoryHeader", "inventory", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "PriceHeader": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "1.7" ] } }, "required": [ "version" ] }, "Price": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "pricing": { "type": "array", "items": { "type": "object", "properties": { "currentPrice": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } }, "required": [ "currentPrice" ] } } }, "required": [ "sku", "pricing" ] } }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "PriceHeader", "Price", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] } ] } }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "A list of feeds to be processed when this one completes" }, "feed_type": { "type": "string", "enum": [ "MP_ITEM_MATCH", "MP_ITEM", "inventory", "PRICE_AND_PROMOTION", "OMNI_WFS", "price" ] }, "feed_status": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "PROCESSED", "ERROR", "Submitted" ] } }, "required": [ "feed_type", "feed_status" ] }, "ExtendedIntegration": { "type": "object", "properties": { "integration_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": [ "string", "null" ] }, "logo": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" } } }, "ExtendedItemLocation": { "type": "object", "properties": { "item_location_id": { "type": "string" }, "user_id": { "type": "string" }, "location_id": { "type": "string" }, "sku": { "type": "string" }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "attachment_id": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "fulfillable": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "total": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that cannot be sold in its current state." }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "The sum of `fulfillable` and `damaged` quantity at this location." }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "location_name": { "type": "string" }, "inventory": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "product": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "value" ] } }, { "type": "object" } ] }, "data": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sku": { "type": "object" }, "condition": { "type": "object" }, "wpid": { "type": "object" }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "productName": { "type": "object" }, "shelf": { "type": "object" }, "productType": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } ] }, "publishedStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PUBLISHED" ] }, { "type": "string", "enum": [ "READY_TO_PUBLISH" ] }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "UNPUBLISHED" ] }, { "type": "string", "enum": [ "STAGE" ] }, { "type": "string", "enum": [ "SYSTEM_PROBLEM." ] } ] }, "additionalAttributes": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "nameValueAttribute": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "variantResourceType": { "type": "object" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "object" }, "source": { "type": "object" }, "rank": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "isVariant": { "type": "object" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } ] } } } ] }, "unpublishedReasons": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "reason": { "oneOf": [ { "type": "object" }, { "type": "object" } ] } } } ] }, "lifecycleStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "ARCHIVED" ] }, { "type": "string", "enum": [ "RETIRED" ] } ] }, "isDuplicate": { "type": "object" }, "isCustomerFavorite": { "type": "object" }, "duplicateItemdetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "status": { "type": "object" }, "lastUpdatedDate": { "type": "object" }, "identifiedDate": { "type": "object" }, "destinationItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "type": "object" }, "wpid": { "type": "object" }, "gtin": { "type": "object" }, "upc": { "type": "object" }, "itemId": { "type": "object" }, "productName": { "type": "object" }, "productType": { "type": "object" }, "additionalAttributes": { "type": "object" } } } ] } } } ] } } } ] }, "getSearchResult": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "condition": { "type": "object" }, "isMarketPlaceItem": { "type": "object" }, "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } ] }, "customerRating": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } ] }, "description": { "type": "object" }, "title": { "type": "object" }, "brand": { "type": "object" }, "productType": { "type": "object" }, "properties": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variant_items_num": { "type": "object" }, "num_reviews": { "type": "object" }, "categories": { "type": "object" }, "variants": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variantMeta": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } ] }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "object" }, "itemId": { "type": "object" }, "isAvailable": { "type": "object" }, "title": { "type": "object" }, "variantValues": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "object" }, "value": { "type": "object" } } } } ] } } } } }, "required": [ "variantData" ] } ] }, "next_day_eligible": { "type": "object" } } } ] }, "parent": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } ] } } } ] } } }, { "type": "object" } ] }, "meltable": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "expiration_required": { "type": "object" }, "hazmat": { "type": "object" }, "size": { "type": "object" }, "category": { "type": "object" }, "dims": { "type": "object" }, "feed_data": { "type": "object" }, "gtins": { "type": "object" }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": "object" }, "icon": { "type": "object" } }, "required": [ "tag_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data", "gtins" ] }, "condition": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } } } } } } }, "ExtendedLedger": { "type": "object", "properties": { "inventory_ledger_id": { "type": "string" }, "user_id": { "type": "string" }, "input_sku": { "type": "string", "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU." }, "output_sku": { "type": "string", "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU." }, "ledger_entry_type": { "type": "string", "enum": [ "ALLOCATION", "ALLOCATION_RELEASED", "BUNDLE_BUILD", "BUNDLE_UNBUILD", "CYCLE_COUNT_ADJUST", "DAMAGE_WRITE_OFF", "INVENTORY_IMPORT", "LOCATION_TRANSFER", "PO_CANCELLED", "PO_CREATED", "PO_RECEIPT_ADJUSTED", "PO_RECEIVED", "RETURN_TO_STOCK", "SHIPMENT_CANCELLED", "SHIPMENT_CONFIRMED", "SHIPMENT_PACKED", "TRANSFER_DAMAGED" ], "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `output_sku` represents the SKU that Amazon or Walmart will see. When bundling, this represents the \"bundled\" SKU." }, "quantity": { "type": "number", "description": "The quantity in (postive) or out (negative)" }, "running_quantity": { "type": "number", "description": "The quantity in (postive) or out (negative)" }, "purchase_order_item_id": { "type": [ "string", "null" ] }, "location_id": { "type": [ "number", "null" ] }, "plan_item_id": { "type": [ "number", "null" ] }, "az_shipment_id": { "type": [ "string", "null" ] }, "wm_shipment_id": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": "string" }, "created_by_name": { "type": "string" }, "location_name": { "type": "string" }, "po_name": { "type": "string" } } }, "ExtendedPackingGroup": { "type": "object", "properties": { "packingGroupId": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] } } }, "required": [ "packingGroupId" ] }, "ExtendedPackingOption": { "type": "object", "properties": { "discounts": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Discount for the offered option." }, "expiration": { "type": "string", "description": "The time at which this packing option is no longer valid. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "fees": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Fee for the offered option." }, "packingOptionId": { "type": "string", "description": "Identifier of a packing option." }, "status": { "type": "string", "description": "The status of the packing option. Possible values: `OFFERED`, `ACCEPTED`, `EXPIRED`." }, "supportedConfigurations": { "type": "array", "items": { "type": "object", "properties": { "boxPackingMethods": { "type": "array", "items": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ] }, "description": "The box content information sources that are allowed." }, "boxRequirements": { "type": "object", "properties": { "weight": { "type": "object", "properties": { "maximum": { "type": "number", "description": "Maximum allowed weight." }, "minimum": { "type": "number", "description": "Minimum allowed weight." }, "unit": { "type": "string", "enum": [ "LB", "KG" ], "description": "Minimum allowed weight." } }, "required": [ "maximum", "minimum", "unit" ] } }, "required": [ "weight" ], "description": "The box content information sources that are allowed." }, "shippingRequirements": { "type": "array", "items": { "type": "object", "properties": { "modes": { "type": "array", "items": { "type": "string" }, "description": "Available shipment modes for this shipping program." }, "solution": { "type": "string", "description": "Shipping program for the option. Can be: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." } }, "required": [ "modes", "solution" ] }, "description": "A list of supported shipping requirements for this packing configuration." } } }, "description": "A list of possible configurations for this option." }, "supportedShippingConfigurations": { "type": "array", "items": { "type": "object", "properties": { "shippingMode": { "type": "string", "description": "Mode of shipment transportation that this option will provide. Possible values: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`." }, "shippingSolution": { "type": "string", "description": "Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." } } }, "description": "*This field is deprecated**. Use the `shippingRequirements` property under `supportedConfigurations` instead. List of supported shipping modes." }, "packingGroups": { "type": "array", "items": { "type": "object", "properties": { "packingGroupId": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] } } }, "required": [ "packingGroupId" ] } } }, "required": [ "packingGroups" ] }, "ExtendedPackTemplate": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "owner": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": [ "number", "null" ] }, "unit_of_weight": { "type": [ "string", "null" ], "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "type": "number" } } } } } }, "ExtendedPackTemplateItem": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "sku": { "type": "string" }, "quantity": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } } }, "ExtendedPlan": { "type": "object", "properties": { "plan_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": "string" }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "errors": { "anyOf": [ { "description": "The method by which the plan was created" }, { "type": "null" } ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id" }, "flow": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ], "description": "For Walmart plans, this is the inbound_order_id" }, "location_id": { "type": [ "string", "null" ] }, "pick_list": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string" }, "location_name": { "type": "string" }, "quantity": { "type": "number" }, "location_id": { "type": "string", "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] } }, "content_information_source": { "type": [ "string", "null" ], "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "description": "When PO items are imported into a plan, this is a list of what locations in the warehouse contain the imported items." }, "status": { "type": "string", "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ] }, "prep_matrix_type": { "type": [ "string", "null" ] }, "prep_matrix_price": { "type": [ "number", "null" ] }, "prep_matrix_currency_code": { "type": [ "string", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "type": [ "object", "null" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "customPlacement": { "type": "array", "items": { "type": "object", "properties": { "warehouseId": { "type": "string" }, "mskus": { "type": "array", "items": { "type": "string" } } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": "string", "description": "Expected delivery date for shipment" } }, "description": "Data used to generate WM Inbound Preview or AZ Inbound Plan" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "wm_shipment_ids": { "type": "array", "items": { "type": "string" }, "description": "A list of shipment ids in the Walmart marketplace created from this plan" }, "az_shipment_ids": { "type": "array", "items": { "type": "string" }, "description": "A list of shipment ids in the Amazon marketplace created from this plan" }, "placement_options": { "type": "array", "items": { "type": "object" }, "description": "present when `with_placement_options` option was passed; az shipments on this plan, grouped by placement option" }, "skus": { "type": "number", "description": "The total number of unique SKUs in the plan" }, "units": { "type": "number", "description": "The total quantity of all items in the plan" }, "inbound_previews": { "type": "array", "items": { "type": "object", "properties": { "previewType": { "type": "string", "enum": [ "inbound", "selfMirroring" ] }, "preview": { "type": "array", "items": { "type": "object", "properties": { "shipNode": { "type": "string" }, "isSortable": { "type": "boolean" }, "isNonSortable": { "type": "boolean" }, "nodeType": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "totalNetTransferCharge": { "type": "number" }, "currencyUnit": { "type": "string" }, "shipmentItems": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] } }, "shippingSummary": { "type": "object", "properties": { "boxes": { "type": "array", "items": {} } }, "required": [ "boxes" ] } }, "required": [ "shipNode", "isSortable", "isNonSortable", "nodeType", "shipToAddress", "totalNetTransferCharge", "currencyUnit", "shipmentItems", "shippingSummary" ] } } }, "required": [ "previewType", "preview" ] }, "description": "A list of inbound previews for the plan" }, "items": { "type": "array", "items": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "gtin": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "prep_details": { "type": "object", "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] } }, "required": [ "gtin", "title" ] }, "description": "present if `with_items` option was passed" }, "ship_from": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "place_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ], "description": "present if `with_ship_from` option was passed" } }, "required": [ "skus", "units" ] }, "ExtendedPlanAuditLog": { "type": "object", "properties": { "plan_audit_log_id": { "type": "string" }, "plan_id": { "type": "number" }, "event_type": { "type": "string", "enum": [ "change_plan_status", "print_box_label", "print_item_label" ] }, "status": { "type": [ "string", "null" ], "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ] }, "sku": { "type": [ "string", "null" ] }, "box_id": { "type": [ "number", "null" ] }, "quantity": { "type": [ "number", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": "string" }, "created_by_name": { "type": "string" }, "plan_name": { "type": "string" } } }, "ExtendedPlanItem": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "inventory": { "type": "object", "properties": { "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "product": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "value" ] } }, { "type": "object" } ] }, "data": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sku": { "type": "object" }, "condition": { "type": "object" }, "wpid": { "type": "object" }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "productName": { "type": "object" }, "shelf": { "type": "object" }, "productType": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } ] }, "publishedStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PUBLISHED" ] }, { "type": "string", "enum": [ "READY_TO_PUBLISH" ] }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "UNPUBLISHED" ] }, { "type": "string", "enum": [ "STAGE" ] }, { "type": "string", "enum": [ "SYSTEM_PROBLEM." ] } ] }, "additionalAttributes": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "nameValueAttribute": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "variantResourceType": { "type": "object" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "object" }, "source": { "type": "object" }, "rank": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "isVariant": { "type": "object" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } ] } } } ] }, "unpublishedReasons": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "reason": { "oneOf": [ { "type": "object" }, { "type": "object" } ] } } } ] }, "lifecycleStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "ARCHIVED" ] }, { "type": "string", "enum": [ "RETIRED" ] } ] }, "isDuplicate": { "type": "object" }, "isCustomerFavorite": { "type": "object" }, "duplicateItemdetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "status": { "type": "object" }, "lastUpdatedDate": { "type": "object" }, "identifiedDate": { "type": "object" }, "destinationItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "type": "object" }, "wpid": { "type": "object" }, "gtin": { "type": "object" }, "upc": { "type": "object" }, "itemId": { "type": "object" }, "productName": { "type": "object" }, "productType": { "type": "object" }, "additionalAttributes": { "type": "object" } } } ] } } } ] } } } ] }, "getSearchResult": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "condition": { "type": "object" }, "isMarketPlaceItem": { "type": "object" }, "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } ] }, "customerRating": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } ] }, "description": { "type": "object" }, "title": { "type": "object" }, "brand": { "type": "object" }, "productType": { "type": "object" }, "properties": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variant_items_num": { "type": "object" }, "num_reviews": { "type": "object" }, "categories": { "type": "object" }, "variants": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variantMeta": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } ] }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "object" }, "itemId": { "type": "object" }, "isAvailable": { "type": "object" }, "title": { "type": "object" }, "variantValues": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "object" }, "value": { "type": "object" } } } } ] } } } } }, "required": [ "variantData" ] } ] }, "next_day_eligible": { "type": "object" } } } ] }, "parent": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } ] } } } ] } } }, { "type": "object" } ] }, "meltable": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "expiration_required": { "type": "object" }, "hazmat": { "type": "object" }, "size": { "type": "object" }, "category": { "type": "object" }, "dims": { "type": "object" }, "feed_data": { "type": "object" }, "gtins": { "type": "object" }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": "object" }, "icon": { "type": "object" } }, "required": [ "tag_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data", "gtins" ] }, "condition": { "type": "string" } }, "required": [ "product", "condition" ] }, "prep_matrices": { "type": "array", "items": { "type": "object" } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "bundle_item_id": { "type": "string" }, "bundle_id": { "type": "string" }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } } } } } } } } } }, "required": [ "inventory" ] }, "ExtendedWebHook": { "type": "object", "properties": { "web_hook_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "endpoint": { "type": "string" }, "enabled": { "type": "boolean" }, "options": { "anyOf": [ {}, { "type": "null" } ] }, "has_secret_key": { "type": "boolean" } }, "required": [ "has_secret_key" ] }, "fbaInbound_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] }, "fbaInbound_ErrorList": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } }, "fbaInbound_GetItemEligibilityPreviewResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "asin": { "type": "string", "description": "The ASIN for which eligibility was determined." }, "marketplaceId": { "type": "string", "description": "The marketplace for which eligibility was determined." }, "program": { "type": "string", "enum": [ "INBOUND", "COMMINGLING" ], "description": "The program for which eligibility was determined." }, "isEligibleForProgram": { "type": "boolean", "description": "Indicates if the item is eligible for the program." }, "ineligibilityReasonList": { "type": "array", "items": { "type": "object" }, "description": "Potential Ineligibility Reason Codes." } }, "required": [ "asin", "program", "isEligibleForProgram" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "fbaInbound_ItemEligibilityPreview": { "type": "object", "properties": { "asin": { "type": "string", "description": "The ASIN for which eligibility was determined." }, "marketplaceId": { "type": "string", "description": "The marketplace for which eligibility was determined." }, "program": { "type": "string", "enum": [ "INBOUND", "COMMINGLING" ], "description": "The program for which eligibility was determined." }, "isEligibleForProgram": { "type": "boolean", "description": "Indicates if the item is eligible for the program." }, "ineligibilityReasonList": { "type": "array", "items": { "type": "object" }, "description": "Potential Ineligibility Reason Codes." } }, "required": [ "asin", "program", "isEligibleForProgram" ] }, "fbaInventory_AddInventoryResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "fbaInventory_CreateInventoryItemResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "fbaInventory_DeleteInventoryItemResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "fbaInventory_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] }, "fbaInventory_ErrorList": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } }, "fbaInventory_GetInventorySummariesResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "granularity": { "type": "object", "properties": { "granularityType": { "type": "string", "description": "The granularity type for the inventory aggregation level." }, "granularityId": { "type": "string", "description": "The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId." } } }, "inventorySummaries": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } } } } }, "required": [ "granularity", "inventorySummaries" ] }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "fbaInventory_GetInventorySummariesResult": { "type": "object", "properties": { "granularity": { "type": "object", "properties": { "granularityType": { "type": "string", "description": "The granularity type for the inventory aggregation level." }, "granularityId": { "type": "string", "description": "The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId." } } }, "inventorySummaries": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } } } } }, "required": [ "granularity", "inventorySummaries" ] }, "fbaInventory_Granularity": { "type": "object", "properties": { "granularityType": { "type": "string", "description": "The granularity type for the inventory aggregation level." }, "granularityId": { "type": "string", "description": "The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId." } } }, "fbaInventory_InventoryItem": { "type": "object", "properties": { "sellerSku": { "type": "string", "description": "The seller SKU of the item.", "nullable": false }, "marketplaceId": { "type": "string", "description": "The marketplaceId.", "nullable": false }, "quantity": { "type": "number", "description": "The quantity of item to add.", "nullable": false } }, "required": [ "sellerSku", "marketplaceId", "quantity" ] }, "fbaInventory_InventoryItems": { "type": "array", "items": { "type": "object", "properties": { "sellerSku": { "type": "string", "description": "The seller SKU of the item.", "nullable": false }, "marketplaceId": { "type": "string", "description": "The marketplaceId.", "nullable": false }, "quantity": { "type": "number", "description": "The quantity of item to add.", "nullable": false } }, "required": [ "sellerSku", "marketplaceId", "quantity" ] } }, "fbaInventory_InventorySummaries": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } } } }, "fbaInventory_Pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return." } } }, "FindShipFromParams": { "type": "object", "properties": { "address_line_1": { "type": "string", "nullable": false }, "city": { "type": "string", "nullable": false }, "state_code": { "type": "string", "nullable": false }, "postal_code": { "type": "string", "nullable": false }, "country_code": { "type": "string", "nullable": false }, "address_line_2": { "type": [ "string", "null" ] } } }, "FindShipFromResponse": { "type": [ "string", "null" ] }, "fulfillmentInbound_2024_03_20_Address": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ] }, "fulfillmentInbound_2024_03_20_AddressInput": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information.", "nullable": false }, "addressLine2": { "type": [ "string", "null" ], "description": "Additional street address information." }, "city": { "type": "string", "description": "The city.", "nullable": false }, "companyName": { "type": [ "string", "null" ], "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format.", "nullable": false }, "districtOrCounty": { "type": [ "string", "null" ], "description": "The district or county." }, "email": { "type": [ "string", "null" ], "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact.", "nullable": false }, "phoneNumber": { "type": "string", "description": "The phone number.", "nullable": false }, "postalCode": { "type": "string", "description": "The postal code.", "nullable": false }, "stateOrProvinceCode": { "type": [ "string", "null" ], "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "phoneNumber", "postalCode" ] }, "fulfillmentInbound_2024_03_20_AppointmentSlot": { "type": "object", "properties": { "slotId": { "type": "string", "description": "An identifier to a self-ship appointment slot." }, "slotTime": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ], "description": "An identifier to a self-ship appointment slot." } }, "required": [ "slotId", "slotTime" ] }, "fulfillmentInbound_2024_03_20_AppointmentSlotTime": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ] }, "fulfillmentInbound_2024_03_20_Box": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": "string", "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": "string", "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": "string", "description": "Template name of the box." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] }, "fulfillmentInbound_2024_03_20_BoxContentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ] }, "fulfillmentInbound_2024_03_20_BoxInput": { "type": "object", "properties": { "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "nullable": false }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package.", "nullable": false }, "length": { "type": "number", "description": "The length of a package.", "nullable": false }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package.", "nullable": false }, "width": { "type": "number", "description": "The width of a package.", "nullable": false } }, "required": [ "height", "length", "unitOfMeasurement", "width" ], "nullable": false }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped.", "nullable": false } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ], "nullable": false }, "value": { "type": "number", "description": "Value of a weight.", "nullable": false } }, "required": [ "unit", "value" ], "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false } }, "required": [ "contentInformationSource", "dimensions", "quantity", "weight" ] }, "fulfillmentInbound_2024_03_20_BoxUpdateInput": { "type": "object", "properties": { "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ] }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped." } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed" }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "The number of containers where all other properties like weight or dimensions are identical." } }, "required": [ "contentInformationSource", "dimensions", "quantity", "weight" ] }, "fulfillmentInbound_2024_03_20_CancelInboundPlanResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_CancelSelfShipAppointmentResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_Carrier": { "type": "object", "properties": { "alphaCode": { "type": "string", "description": "The carrier code. For example, USPS or DHLEX." }, "name": { "type": "string", "description": "The name of the carrier." } } }, "fulfillmentInbound_2024_03_20_CarrierAppointment": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ] }, "fulfillmentInbound_2024_03_20_ComplianceDetail": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number, which identifies the detail page identifier." }, "fnsku": { "type": "string", "description": "The Fulfillment Network SKU, which identifies a real fulfillable item with catalog data and condition." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "taxDetails": { "type": "object", "properties": { "declaredValue": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "hsnCode": { "type": "string", "description": "Harmonized System of Nomenclature code." }, "taxRates": { "type": "array", "items": { "type": "object", "properties": { "cessRate": { "type": "number", "description": "Rate of cess tax." }, "gstRate": { "type": "number", "description": "Rate of gst tax." }, "taxType": { "type": "string", "description": "Type of tax. Possible values: `CGST`, `SGST`, `IGST`, `TOTAL_TAX`." } } }, "description": "List of tax rates." } }, "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." } } }, "fulfillmentInbound_2024_03_20_ConfirmDeliveryWindowOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_ConfirmPackingOptionResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_ConfirmPlacementOptionResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_ConfirmShipmentContentUpdatePreviewResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_ConfirmTransportationOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_ContactInformation": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The contact's name." }, "phoneNumber": { "type": "string", "description": "The phone number." } }, "required": [ "name", "phoneNumber" ] }, "fulfillmentInbound_2024_03_20_ContentUpdatePreview": { "type": "object", "properties": { "contentUpdatePreviewId": { "type": "string", "description": "Identifier of a content update preview." }, "expiration": { "type": "string", "description": "The time at which the content update expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "requestedUpdates": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ] }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped." } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed" }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "The number of containers where all other properties like weight or dimensions are identical." } }, "required": [ "contentInformationSource", "dimensions", "quantity", "weight" ] }, "description": "A list of boxes that will be present in the shipment after the update." }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped." } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "A list of all items that will be present in the shipment after the update." } }, "description": "The time at which the content update expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "transportationOption": { "type": "object", "properties": { "carrier": { "type": "object", "properties": { "alphaCode": { "type": "string", "description": "The carrier code. For example, USPS or DHLEX." }, "name": { "type": "string", "description": "The name of the carrier." } } }, "carrierAppointment": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ] }, "preconditions": { "type": "array", "items": { "type": "string" }, "description": "Identifies a list of preconditions for confirming the transportation option." }, "quote": { "type": "object", "properties": { "cost": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "expiration": { "type": "string", "description": "The time at which this transportation option quote expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "voidableUntil": { "type": "string", "description": "Voidable until timestamp." } }, "required": [ "cost" ], "description": "Identifies a list of preconditions for confirming the transportation option." }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "shippingMode": { "type": "string", "description": "Mode of shipment transportation that this option will provide. Possible values: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`." }, "shippingSolution": { "type": "string", "description": "Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." }, "transportationOptionId": { "type": "string", "description": "Identifier of a transportation option. A transportation option represent one option for how to send a shipment." } }, "required": [ "carrier", "preconditions", "shipmentId", "shippingMode", "shippingSolution", "transportationOptionId" ] } }, "required": [ "contentUpdatePreviewId", "expiration", "requestedUpdates", "transportationOption" ] }, "fulfillmentInbound_2024_03_20_CreateInboundPlanResponse": { "type": "object", "properties": { "inboundPlanId": { "type": "string", "description": "Identifier of an inbound plan." }, "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "inboundPlanId", "operationId" ] }, "fulfillmentInbound_2024_03_20_CreateMarketplaceItemLabelsResponse": { "type": "object", "properties": { "documentDownloads": { "type": "array", "items": { "type": "object", "properties": { "downloadType": { "type": "string", "description": "The type of download. Possible values: `URL`." }, "expiration": { "type": "string", "description": "The URI's expiration time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "uri": { "type": "string", "description": "Uniform resource identifier to identify where the document is located." } }, "required": [ "downloadType", "uri" ] }, "description": "Resources to download the requested document." } }, "required": [ "documentDownloads" ] }, "fulfillmentInbound_2024_03_20_Currency": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "fulfillmentInbound_2024_03_20_CustomPlacementInput": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped.", "nullable": false } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "Items included while creating Inbound Plan.", "nullable": false }, "warehouseId": { "type": "string", "description": "Warehouse Id.", "nullable": false } }, "required": [ "items", "warehouseId" ] }, "fulfillmentInbound_2024_03_20_Dates": { "type": "object", "properties": { "readyToShipWindow": { "type": "object", "properties": { "editableUntil": { "type": "string", "description": "The timestamp at which this Window can no longer be edited." }, "end": { "type": "string", "description": "The end timestamp of the window." }, "start": { "type": "string", "description": "The start timestamp of the window." } }, "required": [ "end", "start" ] } } }, "fulfillmentInbound_2024_03_20_DeliveryWindowOption": { "type": "object", "properties": { "availabilityType": { "type": "string", "description": "The type of delivery window availability. Values: `AVAILABLE`, `BLOCKED`, `CONGESTED`, `DISCOUNTED`" }, "deliveryWindowOptionId": { "type": "string", "description": "Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered." }, "discounts": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Discounts for the offered option." }, "endDate": { "type": "string", "description": "The time at which this delivery window option ends. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." }, "startDate": { "type": "string", "description": "The time at which this delivery window option starts. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." }, "validUntil": { "type": "string", "description": "The time at which this window delivery option is no longer valid. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." } }, "required": [ "availabilityType", "deliveryWindowOptionId", "endDate", "startDate", "validUntil" ] }, "fulfillmentInbound_2024_03_20_Dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "fulfillmentInbound_2024_03_20_DocumentDownload": { "type": "object", "properties": { "downloadType": { "type": "string", "description": "The type of download. Possible values: `URL`." }, "expiration": { "type": "string", "description": "The URI's expiration time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "uri": { "type": "string", "description": "Uniform resource identifier to identify where the document is located." } }, "required": [ "downloadType", "uri" ] }, "fulfillmentInbound_2024_03_20_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "fulfillmentInbound_2024_03_20_FreightInformation": { "type": "object", "properties": { "declaredValue": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "freightClass": { "type": "string", "description": "Freight class. Possible values: `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`." } } }, "fulfillmentInbound_2024_03_20_GenerateDeliveryWindowOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_GeneratePackingOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_GeneratePlacementOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_GenerateShipmentContentUpdatePreviewsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_GenerateTransportationOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_GetDeliveryChallanDocumentResponse": { "type": "object", "properties": { "documentDownload": { "type": "object", "properties": { "downloadType": { "type": "string", "description": "The type of download. Possible values: `URL`." }, "expiration": { "type": "string", "description": "The URI's expiration time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "uri": { "type": "string", "description": "Uniform resource identifier to identify where the document is located." } }, "required": [ "downloadType", "uri" ] } }, "required": [ "documentDownload" ] }, "fulfillmentInbound_2024_03_20_GetSelfShipAppointmentSlotsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "selfShipAppointmentSlotsAvailability": { "type": "object", "properties": { "expiresAt": { "type": "string", "description": "The time at which the self ship appointment slot expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format." }, "slots": { "type": "array", "items": { "type": "object", "properties": { "slotId": { "type": "string", "description": "An identifier to a self-ship appointment slot." }, "slotTime": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ], "description": "An identifier to a self-ship appointment slot." } }, "required": [ "slotId", "slotTime" ] }, "description": "A list of appointment slots." } } } }, "required": [ "selfShipAppointmentSlotsAvailability" ] }, "fulfillmentInbound_2024_03_20_InboundOperationStatus": { "type": "object", "properties": { "operation": { "type": "string", "description": "The name of the operation in the asynchronous API call." }, "operationId": { "type": "string", "description": "The operation ID returned by the asynchronous API call." }, "operationProblems": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "severity": { "type": "string", "description": "The severity of the problem. Possible values: `WARNING`, `ERROR`." } }, "required": [ "code", "message", "severity" ] }, "description": "The problems in the processing of the asynchronous operation." }, "operationStatus": { "type": "string", "enum": [ "SUCCESS", "FAILED", "IN_PROGRESS" ], "description": "The problems in the processing of the asynchronous operation." } }, "required": [ "operation", "operationId", "operationProblems", "operationStatus" ] }, "fulfillmentInbound_2024_03_20_InboundPlan": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "The time at which the inbound plan was created. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "inboundPlanId": { "type": "string", "description": "Identifier of an inbound plan." }, "lastUpdatedAt": { "type": "string", "description": "The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace IDs." }, "name": { "type": "string", "description": "Human-readable name of the inbound plan." }, "packingOptions": { "type": "array", "items": { "type": "object", "properties": { "packingOptionId": { "type": "string", "description": "Identifier of a packing option." }, "status": { "type": "string", "description": "The status of a packing option. Possible values: 'OFFERED', 'ACCEPTED', 'EXPIRED'." } }, "required": [ "packingOptionId", "status" ] }, "description": "Packing options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, only packing options for that placement option will be returned. If there are confirmed shipments, only packing options for those shipments will be returned. Query the packing option for more details." }, "placementOptions": { "type": "array", "items": { "type": "object", "properties": { "placementOptionId": { "type": "string", "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "status": { "type": "string", "description": "The status of a placement option. Possible values: `OFFERED`, `ACCEPTED`." } }, "required": [ "placementOptionId", "status" ] }, "description": "Placement options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, that will be the only returned option. Query the placement option for more details." }, "shipments": { "type": "array", "items": { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "status": { "type": "string", "description": "The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`" } }, "required": [ "shipmentId", "status" ] }, "description": "A list of shipment IDs for the inbound plan. This property is populated when it has been generated with the `confirmPlacementOptions` operation. Only shipments from the chosen placement option are returned. Query the shipment for more details." }, "sourceAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ], "description": "A list of shipment IDs for the inbound plan. This property is populated when it has been generated with the `confirmPlacementOptions` operation. Only shipments from the chosen placement option are returned. Query the shipment for more details." }, "status": { "type": "string", "description": "Current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`." } }, "required": [ "createdAt", "inboundPlanId", "lastUpdatedAt", "marketplaceIds", "name", "sourceAddress", "status" ] }, "fulfillmentInbound_2024_03_20_InboundPlanSummary": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "The time at which the inbound plan was created. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "inboundPlanId": { "type": "string", "description": "Identifier of an inbound plan." }, "lastUpdatedAt": { "type": "string", "description": "The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace IDs." }, "name": { "type": "string", "description": "Human-readable name of the inbound plan." }, "sourceAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ], "description": "Human-readable name of the inbound plan." }, "status": { "type": "string", "description": "The current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`." } }, "required": [ "createdAt", "inboundPlanId", "lastUpdatedAt", "marketplaceIds", "name", "sourceAddress", "status" ] }, "fulfillmentInbound_2024_03_20_Item": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "fulfillmentInbound_2024_03_20_ItemInput": { "type": "object", "properties": { "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped.", "nullable": false } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "fulfillmentInbound_2024_03_20_ItemLabelPageType": { "type": "string", "enum": [ "A4_21", "A4_24", "A4_24_64x33", "A4_24_66x35", "A4_24_70x36", "A4_24_70x37", "A4_24i", "A4_27", "A4_40_52x29", "A4_44_48x25", "Letter_30" ] }, "fulfillmentInbound_2024_03_20_LabelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ] }, "fulfillmentInbound_2024_03_20_LabelPrintType": { "type": "string", "enum": [ "STANDARD_FORMAT", "THERMAL_PRINTING" ] }, "fulfillmentInbound_2024_03_20_ListDeliveryWindowOptionsResponse": { "type": "object", "properties": { "deliveryWindowOptions": { "type": "array", "items": { "type": "object", "properties": { "availabilityType": { "type": "string", "description": "The type of delivery window availability. Values: `AVAILABLE`, `BLOCKED`, `CONGESTED`, `DISCOUNTED`" }, "deliveryWindowOptionId": { "type": "string", "description": "Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered." }, "discounts": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Discounts for the offered option." }, "endDate": { "type": "string", "description": "The time at which this delivery window option ends. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." }, "startDate": { "type": "string", "description": "The time at which this delivery window option starts. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." }, "validUntil": { "type": "string", "description": "The time at which this window delivery option is no longer valid. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." } }, "required": [ "availabilityType", "deliveryWindowOptionId", "endDate", "startDate", "validUntil" ] }, "description": "Delivery window options generated for the placement option." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "Delivery window options generated for the placement option." } }, "required": [ "deliveryWindowOptions" ] }, "fulfillmentInbound_2024_03_20_ListInboundPlanBoxesResponse": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": "string", "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": "string", "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": "string", "description": "Template name of the box." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] }, "description": "A list of boxes in an inbound plan." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "A list of boxes in an inbound plan." } }, "required": [ "boxes" ] }, "fulfillmentInbound_2024_03_20_ListInboundPlanItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "The items in an inbound plan." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "The items in an inbound plan." } }, "required": [ "items" ] }, "fulfillmentInbound_2024_03_20_ListInboundPlanPalletsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "pallets": { "type": "array", "items": { "type": "object", "properties": { "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "stackability": { "type": "string", "enum": [ "STACKABLE", "NON_STACKABLE" ], "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ] } }, "required": [ "packageId" ] }, "description": "The pallets in an inbound plan." } }, "required": [ "pallets" ] }, "fulfillmentInbound_2024_03_20_ListInboundPlansResponse": { "type": "object", "properties": { "inboundPlans": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "The time at which the inbound plan was created. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "inboundPlanId": { "type": "string", "description": "Identifier of an inbound plan." }, "lastUpdatedAt": { "type": "string", "description": "The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace IDs." }, "name": { "type": "string", "description": "Human-readable name of the inbound plan." }, "sourceAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ], "description": "Human-readable name of the inbound plan." }, "status": { "type": "string", "description": "The current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`." } }, "required": [ "createdAt", "inboundPlanId", "lastUpdatedAt", "marketplaceIds", "name", "sourceAddress", "status" ] }, "description": "A list of inbound plans with minimal information." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "A list of inbound plans with minimal information." } } }, "fulfillmentInbound_2024_03_20_ListItemComplianceDetailsResponse": { "type": "object", "properties": { "complianceDetails": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number, which identifies the detail page identifier." }, "fnsku": { "type": "string", "description": "The Fulfillment Network SKU, which identifies a real fulfillable item with catalog data and condition." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "taxDetails": { "type": "object", "properties": { "declaredValue": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "hsnCode": { "type": "string", "description": "Harmonized System of Nomenclature code." }, "taxRates": { "type": "array", "items": { "type": "object", "properties": { "cessRate": { "type": "number", "description": "Rate of cess tax." }, "gstRate": { "type": "number", "description": "Rate of gst tax." }, "taxType": { "type": "string", "description": "Type of tax. Possible values: `CGST`, `SGST`, `IGST`, `TOTAL_TAX`." } } }, "description": "List of tax rates." } }, "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." } } }, "description": "List of compliance details." } } }, "fulfillmentInbound_2024_03_20_ListPackingGroupBoxesResponse": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": "string", "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": "string", "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": "string", "description": "Template name of the box." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] }, "description": "Provides the information about the list of boxes in the packing group." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "Provides the information about the list of boxes in the packing group." } }, "required": [ "boxes" ] }, "fulfillmentInbound_2024_03_20_ListPackingGroupItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Provides the information about the list of items in the packing group." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "Provides the information about the list of items in the packing group." } }, "required": [ "items" ] }, "fulfillmentInbound_2024_03_20_ListPlacementOptionsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "placementOptions": { "type": "array", "items": { "type": "object", "properties": { "discounts": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Discount for the offered option." }, "expiration": { "type": "string", "description": "The expiration date of the placement option. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "fees": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "The fee for the offered option." }, "placementOptionId": { "type": "string", "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "shipmentIds": { "type": "array", "items": { "type": "string" }, "description": "Shipment ids." }, "status": { "type": "string", "description": "The status of a placement option. Possible values: `OFFERED`, `ACCEPTED`, `EXPIRED`." } }, "required": [ "discounts", "fees", "placementOptionId", "shipmentIds", "status" ] }, "description": "Placement options generated for the inbound plan." } }, "required": [ "placementOptions" ] }, "fulfillmentInbound_2024_03_20_ListPrepDetailsResponse": { "type": "object", "properties": { "mskuPrepDetails": { "type": "array", "items": { "type": "object", "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "description": "A list of MSKUs and related prep details." } }, "required": [ "mskuPrepDetails" ] }, "fulfillmentInbound_2024_03_20_ListShipmentBoxesResponse": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": "string", "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": "string", "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": "string", "description": "Template name of the box." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] }, "description": "A list of boxes in a shipment." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "A list of boxes in a shipment." } }, "required": [ "boxes" ] }, "fulfillmentInbound_2024_03_20_ListShipmentContentUpdatePreviewsResponse": { "type": "object", "properties": { "contentUpdatePreviews": { "type": "array", "items": { "type": "object", "properties": { "contentUpdatePreviewId": { "type": "string", "description": "Identifier of a content update preview." }, "expiration": { "type": "string", "description": "The time at which the content update expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "requestedUpdates": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ] }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped." } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed" }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "The number of containers where all other properties like weight or dimensions are identical." } }, "required": [ "contentInformationSource", "dimensions", "quantity", "weight" ] }, "description": "A list of boxes that will be present in the shipment after the update." }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped." } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "A list of all items that will be present in the shipment after the update." } }, "description": "The time at which the content update expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "transportationOption": { "type": "object", "properties": { "carrier": { "type": "object", "properties": { "alphaCode": { "type": "string", "description": "The carrier code. For example, USPS or DHLEX." }, "name": { "type": "string", "description": "The name of the carrier." } } }, "carrierAppointment": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ] }, "preconditions": { "type": "array", "items": { "type": "string" }, "description": "Identifies a list of preconditions for confirming the transportation option." }, "quote": { "type": "object", "properties": { "cost": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "expiration": { "type": "string", "description": "The time at which this transportation option quote expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "voidableUntil": { "type": "string", "description": "Voidable until timestamp." } }, "required": [ "cost" ], "description": "Identifies a list of preconditions for confirming the transportation option." }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "shippingMode": { "type": "string", "description": "Mode of shipment transportation that this option will provide. Possible values: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`." }, "shippingSolution": { "type": "string", "description": "Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." }, "transportationOptionId": { "type": "string", "description": "Identifier of a transportation option. A transportation option represent one option for how to send a shipment." } }, "required": [ "carrier", "preconditions", "shipmentId", "shippingMode", "shippingSolution", "transportationOptionId" ] } }, "required": [ "contentUpdatePreviewId", "expiration", "requestedUpdates", "transportationOption" ] }, "description": "A list of content update previews in a shipment." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "A list of content update previews in a shipment." } }, "required": [ "contentUpdatePreviews" ] }, "fulfillmentInbound_2024_03_20_ListShipmentItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "The items in a shipment." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "The items in a shipment." } }, "required": [ "items" ] }, "fulfillmentInbound_2024_03_20_ListShipmentPalletsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "pallets": { "type": "array", "items": { "type": "object", "properties": { "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "stackability": { "type": "string", "enum": [ "STACKABLE", "NON_STACKABLE" ], "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ] } }, "required": [ "packageId" ] }, "description": "The pallets in a shipment." } }, "required": [ "pallets" ] }, "fulfillmentInbound_2024_03_20_ListTransportationOptionsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "transportationOptions": { "type": "array", "items": { "type": "object", "properties": { "carrier": { "type": "object", "properties": { "alphaCode": { "type": "string", "description": "The carrier code. For example, USPS or DHLEX." }, "name": { "type": "string", "description": "The name of the carrier." } } }, "carrierAppointment": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ] }, "preconditions": { "type": "array", "items": { "type": "string" }, "description": "Identifies a list of preconditions for confirming the transportation option." }, "quote": { "type": "object", "properties": { "cost": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "expiration": { "type": "string", "description": "The time at which this transportation option quote expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "voidableUntil": { "type": "string", "description": "Voidable until timestamp." } }, "required": [ "cost" ], "description": "Identifies a list of preconditions for confirming the transportation option." }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "shippingMode": { "type": "string", "description": "Mode of shipment transportation that this option will provide. Possible values: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`." }, "shippingSolution": { "type": "string", "description": "Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." }, "transportationOptionId": { "type": "string", "description": "Identifier of a transportation option. A transportation option represent one option for how to send a shipment." } }, "required": [ "carrier", "preconditions", "shipmentId", "shippingMode", "shippingSolution", "transportationOptionId" ] }, "description": "Transportation options generated for the placement option." } }, "required": [ "transportationOptions" ] }, "fulfillmentInbound_2024_03_20_LtlTrackingDetail": { "type": "object", "properties": { "billOfLadingNumber": { "type": "string", "description": "The number of the carrier shipment acknowledgement document." }, "freightBillNumber": { "type": "array", "items": { "type": "string" }, "description": "The number associated with the freight bill." } } }, "fulfillmentInbound_2024_03_20_LtlTrackingDetailInput": { "type": "object", "properties": { "billOfLadingNumber": { "type": [ "string", "null" ], "description": "The number of the carrier shipment acknowledgement document." }, "freightBillNumber": { "type": "array", "items": { "type": "string" }, "description": "Number associated with the freight bill.", "nullable": false } }, "required": [ "freightBillNumber" ] }, "fulfillmentInbound_2024_03_20_MskuPrepDetailInput": { "type": "object", "properties": { "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category.", "nullable": false } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "fulfillmentInbound_2024_03_20_MskuQuantity": { "type": "object", "properties": { "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "A positive integer.", "nullable": false } }, "required": [ "msku", "quantity" ] }, "fulfillmentInbound_2024_03_20_OperationProblem": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "severity": { "type": "string", "description": "The severity of the problem. Possible values: `WARNING`, `ERROR`." } }, "required": [ "code", "message", "severity" ] }, "fulfillmentInbound_2024_03_20_OperationStatus": { "type": "string", "enum": [ "SUCCESS", "FAILED", "IN_PROGRESS" ] }, "fulfillmentInbound_2024_03_20_PackageGroupingInput": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "nullable": false }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package.", "nullable": false }, "length": { "type": "number", "description": "The length of a package.", "nullable": false }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package.", "nullable": false }, "width": { "type": "number", "description": "The width of a package.", "nullable": false } }, "required": [ "height", "length", "unitOfMeasurement", "width" ], "nullable": false }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped.", "nullable": false } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ], "nullable": false }, "value": { "type": "number", "description": "Value of a weight.", "nullable": false } }, "required": [ "unit", "value" ], "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false } }, "required": [ "contentInformationSource", "dimensions", "quantity", "weight" ] }, "description": "Box level information being provided.", "nullable": false }, "packingGroupId": { "type": [ "string", "null" ], "description": "The ID of the `packingGroup` that packages are grouped according to. The `PackingGroupId` can only be provided before placement confirmation, and it must belong to the confirmed `PackingOption`. One of `ShipmentId` or `PackingGroupId` must be provided with every request." }, "shipmentId": { "type": [ "string", "null" ], "description": "The ID of the shipment that packages are grouped according to. The `ShipmentId` can only be provided after placement confirmation, and the shipment must belong to the confirmed placement option. One of `ShipmentId` or `PackingGroupId` must be provided with every request." } }, "required": [ "boxes" ] }, "fulfillmentInbound_2024_03_20_PackingOptionSummary": { "type": "object", "properties": { "packingOptionId": { "type": "string", "description": "Identifier of a packing option." }, "status": { "type": "string", "description": "The status of a packing option. Possible values: 'OFFERED', 'ACCEPTED', 'EXPIRED'." } }, "required": [ "packingOptionId", "status" ] }, "fulfillmentInbound_2024_03_20_Pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "fulfillmentInbound_2024_03_20_Pallet": { "type": "object", "properties": { "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "stackability": { "type": "string", "enum": [ "STACKABLE", "NON_STACKABLE" ], "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ] } }, "required": [ "packageId" ] }, "fulfillmentInbound_2024_03_20_PalletInput": { "type": "object", "properties": { "dimensions": { "type": [ "object", "null" ], "properties": { "height": { "type": "number", "description": "The height of a package.", "nullable": false }, "length": { "type": "number", "description": "The length of a package.", "nullable": false }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package.", "nullable": false }, "width": { "type": "number", "description": "The width of a package.", "nullable": false } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false }, "stackability": { "type": [ "string", "null" ], "enum": [ "STACKABLE", "NON_STACKABLE" ], "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": [ "object", "null" ], "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ], "nullable": false }, "value": { "type": "number", "description": "Value of a weight.", "nullable": false } }, "required": [ "unit", "value" ] } }, "required": [ "quantity" ] }, "fulfillmentInbound_2024_03_20_PlacementOption": { "type": "object", "properties": { "discounts": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Discount for the offered option." }, "expiration": { "type": "string", "description": "The expiration date of the placement option. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "fees": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "The fee for the offered option." }, "placementOptionId": { "type": "string", "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "shipmentIds": { "type": "array", "items": { "type": "string" }, "description": "Shipment ids." }, "status": { "type": "string", "description": "The status of a placement option. Possible values: `OFFERED`, `ACCEPTED`, `EXPIRED`." } }, "required": [ "discounts", "fees", "placementOptionId", "shipmentIds", "status" ] }, "fulfillmentInbound_2024_03_20_PlacementOptionSummary": { "type": "object", "properties": { "placementOptionId": { "type": "string", "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "status": { "type": "string", "description": "The status of a placement option. Possible values: `OFFERED`, `ACCEPTED`." } }, "required": [ "placementOptionId", "status" ] }, "fulfillmentInbound_2024_03_20_PrepInstruction": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "fulfillmentInbound_2024_03_20_PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ] }, "fulfillmentInbound_2024_03_20_Quote": { "type": "object", "properties": { "cost": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "expiration": { "type": "string", "description": "The time at which this transportation option quote expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "voidableUntil": { "type": "string", "description": "Voidable until timestamp." } }, "required": [ "cost" ] }, "fulfillmentInbound_2024_03_20_ReasonComment": { "type": "string", "enum": [ "APPOINTMENT_REQUESTED_BY_MISTAKE", "VEHICLE_DELAY", "SLOT_NOT_SUITABLE", "OUTSIDE_CARRIER_BUSINESS_HOURS", "UNFAVOURABLE_EXTERNAL_CONDITIONS", "PROCUREMENT_DELAY", "SHIPPING_PLAN_CHANGED", "INCREASED_QUANTITY", "OTHER" ] }, "fulfillmentInbound_2024_03_20_Region": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "fulfillmentInbound_2024_03_20_RequestedUpdates": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ] }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped." } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed" }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "The number of containers where all other properties like weight or dimensions are identical." } }, "required": [ "contentInformationSource", "dimensions", "quantity", "weight" ] }, "description": "A list of boxes that will be present in the shipment after the update." }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped." } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "A list of all items that will be present in the shipment after the update." } } }, "fulfillmentInbound_2024_03_20_ScheduleSelfShipAppointmentResponse": { "type": "object", "properties": { "selfShipAppointmentDetails": { "type": "object", "properties": { "appointmentId": { "type": "number", "description": "Identifier for appointment." }, "appointmentSlotTime": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ], "description": "Identifier for appointment." }, "appointmentStatus": { "type": "string", "description": "Status of the appointment." } } } }, "required": [ "selfShipAppointmentDetails" ] }, "fulfillmentInbound_2024_03_20_SelectedDeliveryWindow": { "type": "object", "properties": { "availabilityType": { "type": "string", "description": "The type of delivery window availability. Values: `AVAILABLE`, `BLOCKED`, `CONGESTED`, `DISCOUNTED`" }, "deliveryWindowOptionId": { "type": "string", "description": "Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered." }, "editableUntil": { "type": "string", "description": "The timestamp at which this Window can no longer be edited." }, "endDate": { "type": "string", "description": "The end timestamp of the window." }, "startDate": { "type": "string", "description": "The start timestamp of the window." } }, "required": [ "availabilityType", "deliveryWindowOptionId", "endDate", "startDate" ] }, "fulfillmentInbound_2024_03_20_SelfShipAppointmentDetails": { "type": "object", "properties": { "appointmentId": { "type": "number", "description": "Identifier for appointment." }, "appointmentSlotTime": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ], "description": "Identifier for appointment." }, "appointmentStatus": { "type": "string", "description": "Status of the appointment." } } }, "fulfillmentInbound_2024_03_20_SelfShipAppointmentSlotsAvailability": { "type": "object", "properties": { "expiresAt": { "type": "string", "description": "The time at which the self ship appointment slot expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format." }, "slots": { "type": "array", "items": { "type": "object", "properties": { "slotId": { "type": "string", "description": "An identifier to a self-ship appointment slot." }, "slotTime": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ], "description": "An identifier to a self-ship appointment slot." } }, "required": [ "slotId", "slotTime" ] }, "description": "A list of appointment slots." } } }, "fulfillmentInbound_2024_03_20_SetPackingInformationResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_SetPrepDetailsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_Shipment": { "type": "object", "properties": { "amazonReferenceId": { "type": "string", "description": "A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment." }, "contactInformation": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The contact's name." }, "phoneNumber": { "type": "string", "description": "The phone number." } }, "required": [ "name", "phoneNumber" ], "description": "A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment." }, "dates": { "type": "object", "properties": { "readyToShipWindow": { "type": "object", "properties": { "editableUntil": { "type": "string", "description": "The timestamp at which this Window can no longer be edited." }, "end": { "type": "string", "description": "The end timestamp of the window." }, "start": { "type": "string", "description": "The start timestamp of the window." } }, "required": [ "end", "start" ] } } }, "destination": { "type": "object", "properties": { "address": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ] }, "destinationType": { "type": "string", "description": "The type of destination for this shipment. Possible values: `AMAZON_OPTIMIZED`, `AMAZON_WAREHOUSE`." }, "warehouseId": { "type": "string", "description": "The warehouse that the shipment should be sent to. This can be empty if the destination type is `AMAZON_OPTIMIZED`." } }, "required": [ "destinationType" ] }, "freightInformation": { "type": "object", "properties": { "declaredValue": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "freightClass": { "type": "string", "description": "Freight class. Possible values: `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", "description": "The name of the shipment." }, "placementOptionId": { "type": "string", "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "selectedDeliveryWindow": { "type": "object", "properties": { "availabilityType": { "type": "string", "description": "The type of delivery window availability. Values: `AVAILABLE`, `BLOCKED`, `CONGESTED`, `DISCOUNTED`" }, "deliveryWindowOptionId": { "type": "string", "description": "Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered." }, "editableUntil": { "type": "string", "description": "The timestamp at which this Window can no longer be edited." }, "endDate": { "type": "string", "description": "The end timestamp of the window." }, "startDate": { "type": "string", "description": "The start timestamp of the window." } }, "required": [ "availabilityType", "deliveryWindowOptionId", "endDate", "startDate" ], "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "selectedTransportationOptionId": { "type": "string", "description": "Identifier of a transportation option. A transportation option represent one option for how to send a shipment." }, "selfShipAppointmentDetails": { "type": "array", "items": { "type": "object", "properties": { "appointmentId": { "type": "number", "description": "Identifier for appointment." }, "appointmentSlotTime": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ], "description": "Identifier for appointment." }, "appointmentStatus": { "type": "string", "description": "Status of the appointment." } } }, "description": "List of self ship appointment details." }, "shipmentConfirmationId": { "type": "string", "description": "The confirmed shipment ID which shows up on labels (for example, `FBA1234ABCD`)." }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "source": { "type": "object", "properties": { "address": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ] }, "sourceType": { "type": "string", "description": "The type of source for this shipment. Possible values: `SELLER_FACILITY`." } }, "required": [ "sourceType" ], "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "status": { "type": "string", "description": "The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`" }, "trackingDetails": { "type": "object", "properties": { "ltlTrackingDetail": { "type": "object", "properties": { "billOfLadingNumber": { "type": "string", "description": "The number of the carrier shipment acknowledgement document." }, "freightBillNumber": { "type": "array", "items": { "type": "string" }, "description": "The number associated with the freight bill." } } }, "spdTrackingDetail": { "type": "object", "properties": { "spdTrackingItems": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "trackingId": { "type": "string", "description": "The tracking ID associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment." }, "trackingNumberValidationStatus": { "type": "string", "description": "Indicates whether Amazon has validated the tracking number. Because shipment validation is asynchronous, tracking IDs might not be validated immediately, and the status might change after a few hours. If more than 24 hours have passed and the status is not yet 'VALIDATED' or `NOT_SUPPORTED`, verify the number and update it if necessary. **Possible values:** `VALIDATED`, `NOT_VALIDATED`, `NOT_SUPPORTED` (Amazon is unable to find tracking information for the provided tracking ID)." } } }, "description": "List of Small Parcel Delivery (SPD) tracking items." } } } }, "description": "The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`" } }, "required": [ "destination", "placementOptionId", "shipmentId", "source" ] }, "fulfillmentInbound_2024_03_20_ShipmentDestination": { "type": "object", "properties": { "address": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ] }, "destinationType": { "type": "string", "description": "The type of destination for this shipment. Possible values: `AMAZON_OPTIMIZED`, `AMAZON_WAREHOUSE`." }, "warehouseId": { "type": "string", "description": "The warehouse that the shipment should be sent to. This can be empty if the destination type is `AMAZON_OPTIMIZED`." } }, "required": [ "destinationType" ] }, "fulfillmentInbound_2024_03_20_ShipmentSource": { "type": "object", "properties": { "address": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ] }, "sourceType": { "type": "string", "description": "The type of source for this shipment. Possible values: `SELLER_FACILITY`." } }, "required": [ "sourceType" ] }, "fulfillmentInbound_2024_03_20_ShipmentSummary": { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "status": { "type": "string", "description": "The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`" } }, "required": [ "shipmentId", "status" ] }, "fulfillmentInbound_2024_03_20_ShipmentTransportationConfiguration": { "type": "object", "properties": { "contactInformation": { "type": [ "object", "null" ], "properties": { "email": { "type": [ "string", "null" ], "description": "The email address." }, "name": { "type": "string", "description": "The contact's name.", "nullable": false }, "phoneNumber": { "type": "string", "description": "The phone number.", "nullable": false } }, "required": [ "name", "phoneNumber" ] }, "freightInformation": { "type": [ "object", "null" ], "properties": { "declaredValue": { "type": [ "object", "null" ], "properties": { "amount": { "type": "number", "description": "Decimal value of the currency.", "nullable": false }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code.", "nullable": false } }, "required": [ "amount", "code" ] }, "freightClass": { "type": [ "string", "null" ], "description": "Freight class. Possible values: `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`." } } }, "pallets": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "dimensions": { "type": [ "object", "null" ], "properties": { "height": { "type": "number", "description": "The height of a package.", "nullable": false }, "length": { "type": "number", "description": "The length of a package.", "nullable": false }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package.", "nullable": false }, "width": { "type": "number", "description": "The width of a package.", "nullable": false } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false }, "stackability": { "type": [ "string", "null" ], "enum": [ "STACKABLE", "NON_STACKABLE" ], "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": [ "object", "null" ], "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ], "nullable": false }, "value": { "type": "number", "description": "Value of a weight.", "nullable": false } }, "required": [ "unit", "value" ] } }, "required": [ "quantity" ] }, "description": "List of pallet configuration inputs." }, "readyToShipWindow": { "type": "object", "properties": { "start": { "type": "string", "description": "The start date of the window. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with minute precision. Supports patterns `yyyy-MM-ddTHH:mmZ`, `yyyy-MM-ddTHH:mm:ssZ`, or `yyyy-MM-ddTHH:mm:ss.sssZ`. Note that non-zero second and millisecond components are removed.", "nullable": false } }, "required": [ "start" ], "description": "List of pallet configuration inputs.", "nullable": false }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded.", "nullable": false } }, "required": [ "readyToShipWindow", "shipmentId" ] }, "fulfillmentInbound_2024_03_20_SpdTrackingDetail": { "type": "object", "properties": { "spdTrackingItems": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "trackingId": { "type": "string", "description": "The tracking ID associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment." }, "trackingNumberValidationStatus": { "type": "string", "description": "Indicates whether Amazon has validated the tracking number. Because shipment validation is asynchronous, tracking IDs might not be validated immediately, and the status might change after a few hours. If more than 24 hours have passed and the status is not yet 'VALIDATED' or `NOT_SUPPORTED`, verify the number and update it if necessary. **Possible values:** `VALIDATED`, `NOT_VALIDATED`, `NOT_SUPPORTED` (Amazon is unable to find tracking information for the provided tracking ID)." } } }, "description": "List of Small Parcel Delivery (SPD) tracking items." } } }, "fulfillmentInbound_2024_03_20_SpdTrackingDetailInput": { "type": "object", "properties": { "spdTrackingItems": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box.", "nullable": false }, "trackingId": { "type": "string", "description": "The tracking Id associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. The seller must provide this information.", "nullable": false } }, "required": [ "boxId", "trackingId" ] }, "description": "List of Small Parcel Delivery (SPD) tracking items input.", "nullable": false } }, "required": [ "spdTrackingItems" ] }, "fulfillmentInbound_2024_03_20_SpdTrackingItem": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "trackingId": { "type": "string", "description": "The tracking ID associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment." }, "trackingNumberValidationStatus": { "type": "string", "description": "Indicates whether Amazon has validated the tracking number. Because shipment validation is asynchronous, tracking IDs might not be validated immediately, and the status might change after a few hours. If more than 24 hours have passed and the status is not yet 'VALIDATED' or `NOT_SUPPORTED`, verify the number and update it if necessary. **Possible values:** `VALIDATED`, `NOT_VALIDATED`, `NOT_SUPPORTED` (Amazon is unable to find tracking information for the provided tracking ID)." } } }, "fulfillmentInbound_2024_03_20_SpdTrackingItemInput": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box.", "nullable": false }, "trackingId": { "type": "string", "description": "The tracking Id associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. The seller must provide this information.", "nullable": false } }, "required": [ "boxId", "trackingId" ] }, "fulfillmentInbound_2024_03_20_Stackability": { "type": "string", "enum": [ "STACKABLE", "NON_STACKABLE" ] }, "fulfillmentInbound_2024_03_20_TaxDetails": { "type": "object", "properties": { "declaredValue": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "hsnCode": { "type": "string", "description": "Harmonized System of Nomenclature code." }, "taxRates": { "type": "array", "items": { "type": "object", "properties": { "cessRate": { "type": "number", "description": "Rate of cess tax." }, "gstRate": { "type": "number", "description": "Rate of gst tax." }, "taxType": { "type": "string", "description": "Type of tax. Possible values: `CGST`, `SGST`, `IGST`, `TOTAL_TAX`." } } }, "description": "List of tax rates." } } }, "fulfillmentInbound_2024_03_20_TaxRate": { "type": "object", "properties": { "cessRate": { "type": "number", "description": "Rate of cess tax." }, "gstRate": { "type": "number", "description": "Rate of gst tax." }, "taxType": { "type": "string", "description": "Type of tax. Possible values: `CGST`, `SGST`, `IGST`, `TOTAL_TAX`." } } }, "fulfillmentInbound_2024_03_20_TrackingDetails": { "type": "object", "properties": { "ltlTrackingDetail": { "type": "object", "properties": { "billOfLadingNumber": { "type": "string", "description": "The number of the carrier shipment acknowledgement document." }, "freightBillNumber": { "type": "array", "items": { "type": "string" }, "description": "The number associated with the freight bill." } } }, "spdTrackingDetail": { "type": "object", "properties": { "spdTrackingItems": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "trackingId": { "type": "string", "description": "The tracking ID associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment." }, "trackingNumberValidationStatus": { "type": "string", "description": "Indicates whether Amazon has validated the tracking number. Because shipment validation is asynchronous, tracking IDs might not be validated immediately, and the status might change after a few hours. If more than 24 hours have passed and the status is not yet 'VALIDATED' or `NOT_SUPPORTED`, verify the number and update it if necessary. **Possible values:** `VALIDATED`, `NOT_VALIDATED`, `NOT_SUPPORTED` (Amazon is unable to find tracking information for the provided tracking ID)." } } }, "description": "List of Small Parcel Delivery (SPD) tracking items." } } } } }, "fulfillmentInbound_2024_03_20_TrackingDetailsInput": { "type": "object", "properties": { "ltlTrackingDetail": { "type": [ "object", "null" ], "properties": { "billOfLadingNumber": { "type": [ "string", "null" ], "description": "The number of the carrier shipment acknowledgement document." }, "freightBillNumber": { "type": "array", "items": { "type": "string" }, "description": "Number associated with the freight bill.", "nullable": false } }, "required": [ "freightBillNumber" ] }, "spdTrackingDetail": { "type": [ "object", "null" ], "properties": { "spdTrackingItems": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box.", "nullable": false }, "trackingId": { "type": "string", "description": "The tracking Id associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. The seller must provide this information.", "nullable": false } }, "required": [ "boxId", "trackingId" ] }, "description": "List of Small Parcel Delivery (SPD) tracking items input.", "nullable": false } }, "required": [ "spdTrackingItems" ] } } }, "fulfillmentInbound_2024_03_20_TransportationOption": { "type": "object", "properties": { "carrier": { "type": "object", "properties": { "alphaCode": { "type": "string", "description": "The carrier code. For example, USPS or DHLEX." }, "name": { "type": "string", "description": "The name of the carrier." } } }, "carrierAppointment": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ] }, "preconditions": { "type": "array", "items": { "type": "string" }, "description": "Identifies a list of preconditions for confirming the transportation option." }, "quote": { "type": "object", "properties": { "cost": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "expiration": { "type": "string", "description": "The time at which this transportation option quote expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "voidableUntil": { "type": "string", "description": "Voidable until timestamp." } }, "required": [ "cost" ], "description": "Identifies a list of preconditions for confirming the transportation option." }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "shippingMode": { "type": "string", "description": "Mode of shipment transportation that this option will provide. Possible values: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`." }, "shippingSolution": { "type": "string", "description": "Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." }, "transportationOptionId": { "type": "string", "description": "Identifier of a transportation option. A transportation option represent one option for how to send a shipment." } }, "required": [ "carrier", "preconditions", "shipmentId", "shippingMode", "shippingSolution", "transportationOptionId" ] }, "fulfillmentInbound_2024_03_20_TransportationSelection": { "type": "object", "properties": { "contactInformation": { "type": [ "object", "null" ], "properties": { "email": { "type": [ "string", "null" ], "description": "The email address." }, "name": { "type": "string", "description": "The contact's name.", "nullable": false }, "phoneNumber": { "type": "string", "description": "The phone number.", "nullable": false } }, "required": [ "name", "phoneNumber" ] }, "shipmentId": { "type": "string", "description": "Shipment ID that the transportation Option is for.", "nullable": false }, "transportationOptionId": { "type": "string", "description": "Transportation option being selected for the provided shipment.", "nullable": false } }, "required": [ "shipmentId", "transportationOptionId" ] }, "fulfillmentInbound_2024_03_20_UnitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ] }, "fulfillmentInbound_2024_03_20_UnitOfWeight": { "type": "string", "enum": [ "LB", "KG" ] }, "fulfillmentInbound_2024_03_20_UpdateItemComplianceDetailsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_UpdateShipmentSourceAddressResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_UpdateShipmentTrackingDetailsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "fulfillmentInbound_2024_03_20_Weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ] }, "fulfillmentInbound_2024_03_20_Window": { "type": "object", "properties": { "editableUntil": { "type": "string", "description": "The timestamp at which this Window can no longer be edited." }, "end": { "type": "string", "description": "The end timestamp of the window." }, "start": { "type": "string", "description": "The start timestamp of the window." } }, "required": [ "end", "start" ] }, "fulfillmentInbound_2024_03_20_WindowInput": { "type": "object", "properties": { "start": { "type": "string", "description": "The start date of the window. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with minute precision. Supports patterns `yyyy-MM-ddTHH:mmZ`, `yyyy-MM-ddTHH:mm:ssZ`, or `yyyy-MM-ddTHH:mm:ss.sssZ`. Note that non-zero second and millisecond components are removed.", "nullable": false } }, "required": [ "start" ] }, "fulfillmentInboundV0_Address": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the individual or business." }, "AddressLine1": { "type": "string", "description": "The street address information." }, "AddressLine2": { "type": "string", "description": "Additional street address information, if required." }, "DistrictOrCounty": { "type": "string", "description": "The district or county." }, "City": { "type": "string", "description": "The city." }, "StateOrProvinceCode": { "type": "string", "description": "The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan." }, "CountryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "PostalCode": { "type": "string", "description": "The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan." } }, "required": [ "Name", "AddressLine1", "City", "StateOrProvinceCode", "CountryCode", "PostalCode" ] }, "fulfillmentInboundV0_AmazonPrepFeesDetails": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } }, "fulfillmentInboundV0_AmazonPrepFeesDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } }, "fulfillmentInboundV0_Amount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] }, "fulfillmentInboundV0_ASINPrepInstructions": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } } } }, "fulfillmentInboundV0_ASINPrepInstructionsList": { "type": "array", "items": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } } } } }, "fulfillmentInboundV0_BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ] }, "fulfillmentInboundV0_BigDecimalType": { "type": "number" }, "fulfillmentInboundV0_BillOfLadingDownloadURL": { "type": "object", "properties": { "DownloadURL": { "type": "string", "description": "URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds" } } }, "fulfillmentInboundV0_BoxContentsFeeDetails": { "type": "object", "properties": { "TotalUnits": { "type": "number" }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] }, "TotalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } }, "fulfillmentInboundV0_BoxContentsSource": { "type": "string", "enum": [ "NONE", "FEED", "2D_BARCODE", "INTERACTIVE" ] }, "fulfillmentInboundV0_CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "fulfillmentInboundV0_DateStringType": { "type": "string" }, "fulfillmentInboundV0_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "fulfillmentInboundV0_ErrorList": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } }, "fulfillmentInboundV0_ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ] }, "fulfillmentInboundV0_GetBillOfLadingResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "DownloadURL": { "type": "string", "description": "URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds" } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "fulfillmentInboundV0_GetLabelsResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "DownloadURL": { "type": "string", "description": "URL to download the label for the package. Note: The URL will only be valid for 15 seconds" } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "fulfillmentInboundV0_GetPrepInstructionsResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "SKUPrepInstructionsList": { "type": "array", "items": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } }, "AmazonPrepFeesDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } } } } }, "InvalidSKUList": { "type": "array", "items": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The seller SKU of the item." } } } }, "ASINPrepInstructionsList": { "type": "array", "items": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } } } } }, "InvalidASINList": { "type": "array", "items": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." } } } } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "fulfillmentInboundV0_GetPrepInstructionsResult": { "type": "object", "properties": { "SKUPrepInstructionsList": { "type": "array", "items": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } }, "AmazonPrepFeesDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } } } } }, "InvalidSKUList": { "type": "array", "items": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The seller SKU of the item." } } } }, "ASINPrepInstructionsList": { "type": "array", "items": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } } } } }, "InvalidASINList": { "type": "array", "items": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." } } } } } }, "fulfillmentInboundV0_GetShipmentItemsResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "ItemData": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "A shipment identifier originally returned by the createInboundShipmentPlan operation." }, "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "FulfillmentNetworkSKU": { "type": "string", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityShipped": { "type": "number", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityReceived": { "type": "number" }, "QuantityInCase": { "type": "number" }, "ReleaseDate": { "type": "string" }, "PrepDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER" ] } }, "required": [ "PrepInstruction", "PrepOwner" ] } } }, "required": [ "SellerSKU", "QuantityShipped" ] } }, "NextToken": { "type": "string", "description": "When present and not empty, pass this string token in the next request to return the next response page." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "fulfillmentInboundV0_GetShipmentItemsResult": { "type": "object", "properties": { "ItemData": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "A shipment identifier originally returned by the createInboundShipmentPlan operation." }, "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "FulfillmentNetworkSKU": { "type": "string", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityShipped": { "type": "number", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityReceived": { "type": "number" }, "QuantityInCase": { "type": "number" }, "ReleaseDate": { "type": "string" }, "PrepDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER" ] } }, "required": [ "PrepInstruction", "PrepOwner" ] } } }, "required": [ "SellerSKU", "QuantityShipped" ] } }, "NextToken": { "type": "string", "description": "When present and not empty, pass this string token in the next request to return the next response page." } } }, "fulfillmentInboundV0_GetShipmentsResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "ShipmentData": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "The shipment identifier submitted in the request." }, "ShipmentName": { "type": "string", "description": "The name for the inbound shipment." }, "ShipFromAddress": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the individual or business." }, "AddressLine1": { "type": "string", "description": "The street address information." }, "AddressLine2": { "type": "string", "description": "Additional street address information, if required." }, "DistrictOrCounty": { "type": "string", "description": "The district or county." }, "City": { "type": "string", "description": "The city." }, "StateOrProvinceCode": { "type": "string", "description": "The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan." }, "CountryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "PostalCode": { "type": "string", "description": "The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan." } }, "required": [ "Name", "AddressLine1", "City", "StateOrProvinceCode", "CountryCode", "PostalCode" ], "description": "The name for the inbound shipment." }, "DestinationFulfillmentCenterId": { "type": "string", "description": "An Amazon fulfillment center identifier created by Amazon." }, "ShipmentStatus": { "type": "string", "enum": [ "WORKING", "SHIPPED", "RECEIVING", "CANCELLED", "DELETED", "CLOSED", "ERROR", "IN_TRANSIT", "DELIVERED", "CHECKED_IN" ], "description": "An Amazon fulfillment center identifier created by Amazon." }, "LabelPrepType": { "type": "string", "enum": [ "NO_LABEL", "SELLER_LABEL", "AMAZON_LABEL" ] }, "AreCasesRequired": { "type": "boolean", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "ConfirmedNeedByDate": { "type": "string", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "BoxContentsSource": { "type": "string", "enum": [ "NONE", "FEED", "2D_BARCODE", "INTERACTIVE" ] }, "EstimatedBoxContentsFee": { "type": "object", "properties": { "TotalUnits": { "type": "number" }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] }, "TotalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } }, "required": [ "ShipFromAddress", "AreCasesRequired" ] } }, "NextToken": { "type": "string", "description": "When present and not empty, pass this string token in the next request to return the next response page." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "fulfillmentInboundV0_GetShipmentsResult": { "type": "object", "properties": { "ShipmentData": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "The shipment identifier submitted in the request." }, "ShipmentName": { "type": "string", "description": "The name for the inbound shipment." }, "ShipFromAddress": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the individual or business." }, "AddressLine1": { "type": "string", "description": "The street address information." }, "AddressLine2": { "type": "string", "description": "Additional street address information, if required." }, "DistrictOrCounty": { "type": "string", "description": "The district or county." }, "City": { "type": "string", "description": "The city." }, "StateOrProvinceCode": { "type": "string", "description": "The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan." }, "CountryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "PostalCode": { "type": "string", "description": "The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan." } }, "required": [ "Name", "AddressLine1", "City", "StateOrProvinceCode", "CountryCode", "PostalCode" ], "description": "The name for the inbound shipment." }, "DestinationFulfillmentCenterId": { "type": "string", "description": "An Amazon fulfillment center identifier created by Amazon." }, "ShipmentStatus": { "type": "string", "enum": [ "WORKING", "SHIPPED", "RECEIVING", "CANCELLED", "DELETED", "CLOSED", "ERROR", "IN_TRANSIT", "DELIVERED", "CHECKED_IN" ], "description": "An Amazon fulfillment center identifier created by Amazon." }, "LabelPrepType": { "type": "string", "enum": [ "NO_LABEL", "SELLER_LABEL", "AMAZON_LABEL" ] }, "AreCasesRequired": { "type": "boolean", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "ConfirmedNeedByDate": { "type": "string", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "BoxContentsSource": { "type": "string", "enum": [ "NONE", "FEED", "2D_BARCODE", "INTERACTIVE" ] }, "EstimatedBoxContentsFee": { "type": "object", "properties": { "TotalUnits": { "type": "number" }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] }, "TotalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } }, "required": [ "ShipFromAddress", "AreCasesRequired" ] } }, "NextToken": { "type": "string", "description": "When present and not empty, pass this string token in the next request to return the next response page." } } }, "fulfillmentInboundV0_InboundShipmentInfo": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "The shipment identifier submitted in the request." }, "ShipmentName": { "type": "string", "description": "The name for the inbound shipment." }, "ShipFromAddress": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the individual or business." }, "AddressLine1": { "type": "string", "description": "The street address information." }, "AddressLine2": { "type": "string", "description": "Additional street address information, if required." }, "DistrictOrCounty": { "type": "string", "description": "The district or county." }, "City": { "type": "string", "description": "The city." }, "StateOrProvinceCode": { "type": "string", "description": "The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan." }, "CountryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "PostalCode": { "type": "string", "description": "The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan." } }, "required": [ "Name", "AddressLine1", "City", "StateOrProvinceCode", "CountryCode", "PostalCode" ], "description": "The name for the inbound shipment." }, "DestinationFulfillmentCenterId": { "type": "string", "description": "An Amazon fulfillment center identifier created by Amazon." }, "ShipmentStatus": { "type": "string", "enum": [ "WORKING", "SHIPPED", "RECEIVING", "CANCELLED", "DELETED", "CLOSED", "ERROR", "IN_TRANSIT", "DELIVERED", "CHECKED_IN" ], "description": "An Amazon fulfillment center identifier created by Amazon." }, "LabelPrepType": { "type": "string", "enum": [ "NO_LABEL", "SELLER_LABEL", "AMAZON_LABEL" ] }, "AreCasesRequired": { "type": "boolean", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "ConfirmedNeedByDate": { "type": "string", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "BoxContentsSource": { "type": "string", "enum": [ "NONE", "FEED", "2D_BARCODE", "INTERACTIVE" ] }, "EstimatedBoxContentsFee": { "type": "object", "properties": { "TotalUnits": { "type": "number" }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] }, "TotalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } }, "required": [ "ShipFromAddress", "AreCasesRequired" ] }, "fulfillmentInboundV0_InboundShipmentItem": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "A shipment identifier originally returned by the createInboundShipmentPlan operation." }, "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "FulfillmentNetworkSKU": { "type": "string", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityShipped": { "type": "number", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityReceived": { "type": "number" }, "QuantityInCase": { "type": "number" }, "ReleaseDate": { "type": "string" }, "PrepDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER" ] } }, "required": [ "PrepInstruction", "PrepOwner" ] } } }, "required": [ "SellerSKU", "QuantityShipped" ] }, "fulfillmentInboundV0_InboundShipmentItemList": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "A shipment identifier originally returned by the createInboundShipmentPlan operation." }, "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "FulfillmentNetworkSKU": { "type": "string", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityShipped": { "type": "number", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityReceived": { "type": "number" }, "QuantityInCase": { "type": "number" }, "ReleaseDate": { "type": "string" }, "PrepDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER" ] } }, "required": [ "PrepInstruction", "PrepOwner" ] } } }, "required": [ "SellerSKU", "QuantityShipped" ] } }, "fulfillmentInboundV0_InboundShipmentList": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "The shipment identifier submitted in the request." }, "ShipmentName": { "type": "string", "description": "The name for the inbound shipment." }, "ShipFromAddress": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the individual or business." }, "AddressLine1": { "type": "string", "description": "The street address information." }, "AddressLine2": { "type": "string", "description": "Additional street address information, if required." }, "DistrictOrCounty": { "type": "string", "description": "The district or county." }, "City": { "type": "string", "description": "The city." }, "StateOrProvinceCode": { "type": "string", "description": "The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan." }, "CountryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "PostalCode": { "type": "string", "description": "The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan." } }, "required": [ "Name", "AddressLine1", "City", "StateOrProvinceCode", "CountryCode", "PostalCode" ], "description": "The name for the inbound shipment." }, "DestinationFulfillmentCenterId": { "type": "string", "description": "An Amazon fulfillment center identifier created by Amazon." }, "ShipmentStatus": { "type": "string", "enum": [ "WORKING", "SHIPPED", "RECEIVING", "CANCELLED", "DELETED", "CLOSED", "ERROR", "IN_TRANSIT", "DELIVERED", "CHECKED_IN" ], "description": "An Amazon fulfillment center identifier created by Amazon." }, "LabelPrepType": { "type": "string", "enum": [ "NO_LABEL", "SELLER_LABEL", "AMAZON_LABEL" ] }, "AreCasesRequired": { "type": "boolean", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "ConfirmedNeedByDate": { "type": "string", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "BoxContentsSource": { "type": "string", "enum": [ "NONE", "FEED", "2D_BARCODE", "INTERACTIVE" ] }, "EstimatedBoxContentsFee": { "type": "object", "properties": { "TotalUnits": { "type": "number" }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] }, "TotalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } }, "required": [ "ShipFromAddress", "AreCasesRequired" ] } }, "fulfillmentInboundV0_InvalidASIN": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." } } }, "fulfillmentInboundV0_InvalidASINList": { "type": "array", "items": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." } } } }, "fulfillmentInboundV0_InvalidSKU": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The seller SKU of the item." } } }, "fulfillmentInboundV0_InvalidSKUList": { "type": "array", "items": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The seller SKU of the item." } } } }, "fulfillmentInboundV0_LabelDownloadURL": { "type": "object", "properties": { "DownloadURL": { "type": "string", "description": "URL to download the label for the package. Note: The URL will only be valid for 15 seconds" } } }, "fulfillmentInboundV0_LabelPrepType": { "type": "string", "enum": [ "NO_LABEL", "SELLER_LABEL", "AMAZON_LABEL" ] }, "fulfillmentInboundV0_PrepDetails": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER" ] } }, "required": [ "PrepInstruction", "PrepOwner" ] }, "fulfillmentInboundV0_PrepDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER" ] } }, "required": [ "PrepInstruction", "PrepOwner" ] } }, "fulfillmentInboundV0_PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "fulfillmentInboundV0_PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "fulfillmentInboundV0_PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } }, "fulfillmentInboundV0_PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER" ] }, "fulfillmentInboundV0_Quantity": { "type": "number" }, "fulfillmentInboundV0_ShipmentStatus": { "type": "string", "enum": [ "WORKING", "SHIPPED", "RECEIVING", "CANCELLED", "DELETED", "CLOSED", "ERROR", "IN_TRANSIT", "DELIVERED", "CHECKED_IN" ] }, "fulfillmentInboundV0_SKUPrepInstructions": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } }, "AmazonPrepFeesDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } } } }, "fulfillmentInboundV0_SKUPrepInstructionsList": { "type": "array", "items": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } }, "AmazonPrepFeesDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } } } } }, "GenerateBoxLabelsParams": { "type": "object", "properties": { "PageType": { "type": "string", "enum": [ "PackageLabel_Letter_2", "PackageLabel_Letter_4", "PackageLabel_Letter_6", "PackageLabel_Letter_6_CarrierLeft", "PackageLabel_A4_2", "PackageLabel_A4_4", "PackageLabel_Plain_Paper", "PackageLabel_Plain_Paper_CarrierBottom", "PackageLabel_Thermal", "PackageLabel_Thermal_Unified", "PackageLabel_Thermal_NonPCP", "PackageLabel_Thermal_No_Carrier_Rotation" ] }, "LabelType": { "type": "string", "enum": [ "BARCODE_2D", "UNIQUE", "PALLET" ] }, "NumberOfPackages": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "NumberOfPallets": { "type": "object" }, "PageSize": { "type": "object" }, "PageStartIndex": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "shipmentId": { "type": "string" }, "PackageLabelsToPrint": { "type": "string", "description": "a comma separated list of box ranges (eg. 1-10,20-300)" } }, "required": [ "PackageLabelsToPrint" ] }, "GenerateBoxLabelsRequestHeaders": { "type": "object", "properties": { "accept": { "type": "string", "enum": [ "application/pdf" ] } } }, "GenerateCustomBoxLabelsParams": { "type": "object" }, "GenerateCustomPalletLabelsParams": { "type": "object" }, "GenerateDeliveryWindowOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "GenerateDeliveryWindowOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "GenerateDeliveryWindowOptionsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "GenerateItemLabelsItem": { "type": "object", "properties": { "plan_id": { "type": [ "string", "null" ] }, "sku": { "type": [ "string", "null" ] }, "barcode_value": { "type": [ "string", "null" ], "description": "Value that will be encoded into the barcode. If not provided, no barcode will be printed and text will start at the top margin." }, "copies": { "type": [ "number", "null" ], "description": "Number of copies to make. Default is 1." }, "lines": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The text that will be printed.", "nullable": false }, "opts": { "type": [ "object", "null" ], "properties": { "wrap": { "type": [ "boolean", "null" ], "description": "This technically works, but can cause spacing issues depending on the font size and line. Commented out to avoid confusion in the API docs." } }, "description": "The text that will be printed." } }, "required": [ "text" ] }, "description": "The lines of text to be printed below the barcode." } } }, "GenerateItemLabelsItemLine": { "type": "object", "properties": { "text": { "type": "string", "description": "The text that will be printed.", "nullable": false }, "opts": { "type": [ "object", "null" ], "properties": { "wrap": { "type": [ "boolean", "null" ], "description": "This technically works, but can cause spacing issues depending on the font size and line. Commented out to avoid confusion in the API docs." } }, "description": "The text that will be printed." } }, "required": [ "text" ] }, "GenerateItemLabelsItemLineOpts": { "type": "object", "properties": { "wrap": { "type": [ "boolean", "null" ], "description": "This technically works, but can cause spacing issues depending on the font size and line. Commented out to avoid confusion in the API docs." } } }, "GenerateItemLabelsOpts": { "type": "object", "properties": { "font_size": { "type": [ "number", "null" ], "description": "The default font size, unless provided in the line opts. Default is 8." }, "format": { "type": [ "string", "null" ], "enum": [ "pdf" ], "description": "The output format. If 'pdf', returns raw PDF data. Otherwise returns a data URI string. Default is data URI string." } } }, "GenerateItemLabelsParams": { "type": "object", "properties": { "width": { "type": "number", "description": "The width of the label.", "nullable": false }, "height": { "type": "number", "description": "The height of the label.", "nullable": false }, "unit": { "type": [ "string", "null" ], "enum": [ "in" ], "description": "Default is 'in' (inches)." }, "items": { "type": "array", "items": { "type": "object", "properties": { "plan_id": { "type": [ "string", "null" ] }, "sku": { "type": [ "string", "null" ] }, "barcode_value": { "type": [ "string", "null" ], "description": "Value that will be encoded into the barcode. If not provided, no barcode will be printed and text will start at the top margin." }, "copies": { "type": [ "number", "null" ], "description": "Number of copies to make. Default is 1." }, "lines": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The text that will be printed.", "nullable": false }, "opts": { "type": [ "object", "null" ], "properties": { "wrap": { "type": [ "boolean", "null" ], "description": "This technically works, but can cause spacing issues depending on the font size and line. Commented out to avoid confusion in the API docs." } }, "description": "The text that will be printed." } }, "required": [ "text" ] }, "description": "The lines of text to be printed below the barcode." } } }, "description": "The items to be printed on the label. Each item will be printed on a new label.", "nullable": false }, "opts": { "type": [ "object", "null" ], "properties": { "font_size": { "type": [ "number", "null" ], "description": "The default font size, unless provided in the line opts. Default is 8." }, "format": { "type": [ "string", "null" ], "enum": [ "pdf" ], "description": "The output format. If 'pdf', returns raw PDF data. Otherwise returns a data URI string. Default is data URI string." } }, "description": "Additional options." } }, "required": [ "width", "height", "items" ] }, "GenerateItemLabelsRequestHeaders": { "type": "object", "properties": { "accept": { "type": "string", "enum": [ "application/pdf", "text/plain" ] } } }, "GenerateItemLabelsResponse": { "oneOf": [ { "type": "string", "contentMediaType": "application/octet-stream" }, { "type": "string" } ] }, "GenerateLabelResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "status": { "type": "string", "enum": [ "OK" ] } }, "required": [ "status" ] }, "GenerateLabelSearchBody": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "shipmentId": { "type": "string", "description": "Unique identifier identifying each shipment.", "nullable": false }, "labelType": { "type": "string", "description": "Unique identifier identifying each shipment.", "nullable": false }, "shipDate": { "type": [ "string", "null" ], "format": "date-time" } } }, "GenerateLabelSearchParams": { "type": "object", "properties": { "mp": { "type": "string" } }, "required": [ "mp" ] }, "GenerateMarketplacePlanBody": { "type": "object", "properties": { "email": { "type": [ "string", "null" ], "description": "override sourceAddress.email when creating AZ inbound plans" }, "name": { "type": [ "string", "null" ], "description": "override sourceAddress.name when creating AZ inbound plans" }, "phoneNumber": { "type": [ "string", "null" ], "description": "override sourceAddress.phoneNumber when creating AZ inbound plans" }, "customPlacement": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "warehouseId": { "type": "string", "nullable": false }, "mskus": { "type": "array", "items": { "type": "string" }, "nullable": false } }, "required": [ "warehouseId", "mskus" ] }, "description": "optionally used when generating a plan for AZ" }, "delivery_date": { "type": [ "string", "null" ], "description": "required if generating plan for WM" }, "accept_first_packing_option": { "type": [ "boolean", "null" ], "description": "defaults to true, pass `false` to prevent auto-accept of first packing option" } } }, "GenerateMarketplacePlanParams": { "type": "object", "properties": { "plan_id": { "type": "string", "nullable": false }, "plan": { "type": [ "object", "null" ], "properties": { "plan_id": { "type": "string", "nullable": false }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "ship_from_id": { "type": "string", "nullable": false }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ], "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "errors": { "nullable": false, "description": "The method by which the plan was created" }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "archived": { "type": "string", "format": "date-time", "nullable": false }, "archived_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id", "nullable": false }, "flow": { "type": "string", "enum": [ "pack_first", "pack_later" ], "nullable": false, "description": "For Walmart plans, this is the inbound_order_id" }, "location_id": { "type": "string", "nullable": false }, "pick_list": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "location_name": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "location_id": { "type": [ "string", "null" ], "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] }, "nullable": false }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "nullable": false, "description": "When PO items are imported into a plan, this is a list of what locations in the warehouse contain the imported items." }, "status": { "type": "string", "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ], "nullable": false }, "prep_matrix_type": { "type": "string", "nullable": false }, "prep_matrix_price": { "type": "number", "nullable": false }, "prep_matrix_currency_code": { "type": "string", "nullable": false }, "expected_delivery_date": { "type": "string", "format": "date-time", "nullable": false }, "data": { "type": "object", "properties": { "email": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "phoneNumber": { "type": [ "string", "null" ] }, "customPlacement": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "warehouseId": { "type": "string", "nullable": false }, "mskus": { "type": "array", "items": { "type": "string" }, "nullable": false } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": [ "string", "null" ], "description": "Expected delivery date for shipment" } }, "nullable": false, "description": "Data used to generate WM Inbound Preview or AZ Inbound Plan" }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_id": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false } } } }, "wm_shipment_ids": { "type": [ "array", "null" ], "items": { "type": "string", "nullable": false }, "description": "A list of shipment ids in the Walmart marketplace created from this plan" }, "az_shipment_ids": { "type": [ "array", "null" ], "items": { "type": "string", "nullable": false }, "description": "A list of shipment ids in the Amazon marketplace created from this plan" }, "placement_options": { "type": [ "array", "null" ], "items": { "type": "object" }, "description": "present when `with_placement_options` option was passed; az shipments on this plan, grouped by placement option" }, "skus": { "type": "number", "description": "The total number of unique SKUs in the plan", "nullable": false }, "units": { "type": "number", "description": "The total quantity of all items in the plan", "nullable": false }, "inbound_previews": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "previewType": { "type": "string", "enum": [ "inbound", "selfMirroring" ], "nullable": false }, "preview": { "type": "array", "items": { "type": "object", "properties": { "shipNode": { "type": "string", "nullable": false }, "isSortable": { "type": "boolean", "nullable": false }, "isNonSortable": { "type": "boolean", "nullable": false }, "nodeType": { "type": "string", "nullable": false }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "nullable": false }, "addressLine2": { "type": [ "string", "null" ] }, "city": { "type": "string", "nullable": false }, "stateCode": { "type": "string", "nullable": false }, "postalCode": { "type": "string", "nullable": false }, "countryCode": { "type": "string", "nullable": false }, "fcName": { "type": "string", "nullable": false } }, "required": [ "fcName" ], "nullable": false }, "totalNetTransferCharge": { "type": "number", "nullable": false }, "currencyUnit": { "type": "string", "nullable": false }, "shipmentItems": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string", "nullable": false }, "productType": { "type": "string", "nullable": false }, "productId": { "type": "string", "nullable": false }, "itemQty": { "type": "number", "nullable": false }, "itemDesc": { "type": "string", "nullable": false }, "itemPrice": { "type": "number", "nullable": false }, "shpmentLineNo": { "type": "number", "nullable": false } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] }, "nullable": false }, "shippingSummary": { "type": "object", "properties": { "boxes": { "type": "array", "items": {}, "nullable": false } }, "required": [ "boxes" ], "nullable": false } }, "required": [ "shipNode", "isSortable", "isNonSortable", "nodeType", "shipToAddress", "totalNetTransferCharge", "currencyUnit", "shipmentItems", "shippingSummary" ] }, "nullable": false } }, "required": [ "previewType", "preview" ] }, "description": "A list of inbound previews for the plan" }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "plan_item_id": { "type": "string", "nullable": false }, "plan_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "sku": { "type": "string", "nullable": false }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "quantity": { "type": "number", "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false }, "errors": { "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "expires": { "type": "string", "format": "date-time", "nullable": false }, "cost": { "type": "number", "nullable": false }, "supplier_id": { "type": "string", "nullable": false }, "lot_code": { "type": "string", "nullable": false }, "packing_group_ids": { "type": "object", "additionalProperties": { "type": "number" }, "nullable": false }, "print_fnsku_label_quantity": { "type": "number", "nullable": false }, "quantity_in_case": { "type": "number", "nullable": false }, "item_prep": { "type": "object", "properties": { "addOnServices": { "type": [ "object", "null" ], "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": [ "object", "null" ] }, "prepOwner": { "type": [ "object", "null" ] }, "prepInstructions": { "type": [ "array", "null" ], "items": { "type": "object" } }, "label_type": { "type": [ "string", "null" ] }, "prep_category": { "type": [ "string", "null" ] } }, "nullable": false, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "gtin": { "type": "string", "nullable": false }, "title": { "type": "string", "nullable": false }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": [ "string", "null" ], "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": [ "string", "null" ], "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false }, "prepOwnerConstraint": { "type": [ "string", "null" ], "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category.", "nullable": false } }, "required": [ "msku", "prepCategory", "prepTypes" ] } }, "required": [ "gtin", "title" ] }, "description": "present if `with_items` option was passed" }, "ship_from": { "type": [ "object", "null" ], "properties": { "ship_from_id": { "type": "string", "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "ship_from_name": { "type": "string", "nullable": false }, "address_line_1": { "type": "string", "nullable": false }, "address_line_2": { "type": "string", "nullable": false }, "city": { "type": "string", "nullable": false }, "state_code": { "type": "string", "nullable": false }, "postal_code": { "type": "string", "nullable": false }, "country_code": { "type": "string", "nullable": false }, "contact_name": { "type": "string", "nullable": false }, "email": { "type": "string", "nullable": false }, "phone": { "type": "string", "nullable": false }, "place_id": { "type": "string", "nullable": false }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner", "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false, "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": "string", "nullable": false }, "archived": { "type": "string", "format": "date-time", "nullable": false }, "archived_by": { "type": "string", "nullable": false } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ], "description": "present if `with_ship_from` option was passed" } }, "required": [ "skus", "units" ] }, "email": { "type": [ "string", "null" ], "description": "override sourceAddress.email when creating AZ inbound plans" }, "name": { "type": [ "string", "null" ], "description": "override sourceAddress.name when creating AZ inbound plans" }, "phoneNumber": { "type": [ "string", "null" ], "description": "override sourceAddress.phoneNumber when creating AZ inbound plans" }, "customPlacement": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "warehouseId": { "type": "string", "nullable": false }, "mskus": { "type": "array", "items": { "type": "string" }, "nullable": false } }, "required": [ "warehouseId", "mskus" ] }, "description": "optionally used when generating a plan for AZ" }, "delivery_date": { "type": [ "string", "null" ], "description": "required if generating plan for WM" }, "accept_first_packing_option": { "type": [ "boolean", "null" ], "description": "defaults to true, pass `false` to prevent auto-accept of first packing option" } }, "required": [ "plan_id" ] }, "GenerateMarketplacePlanResponse": { "type": "object", "properties": {} }, "GeneratePlacementOptionsBody": { "type": "object", "properties": { "customPlacement": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped.", "nullable": false } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "Items included while creating Inbound Plan.", "nullable": false }, "warehouseId": { "type": "string", "description": "Warehouse Id.", "nullable": false } }, "required": [ "items", "warehouseId" ] }, "description": "Custom placement options you want to add to the plan. This is only used for the India (IN - A21TJRUUN4KGV) marketplace." } } }, "GeneratePlacementOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "GeneratePlacementOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } } }, "GeneratePlacementOptionsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "plan_id": { "type": "string" }, "operation_complete": { "type": "boolean", "description": "wait for operation to complete. defaults to true" }, "maybe_202": { "type": "boolean", "description": "return a 202 response if we have to wait for more than 5 seconds. defaults to true" } } }, "GenerateReportBody": { "type": "object", "properties": { "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the report type to return. For example, use ITEM to retrieve Item reports.", "nullable": false }, "reportVersion": { "type": [ "string", "null" ], "description": "Specifies the version of the report. For ITEM, supported values are v1 through v6. For all other reportType values, only v1 is supported." }, "rowFilters": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "values": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Specifies the enum filter values that must be included in the report." }, "columnName": { "type": "string", "description": "Specifies the column to which the filter should be applied.", "nullable": false }, "type": { "type": "string", "enum": [ "rangeFilter", "enumFilter", "multiValueFilter" ], "description": "Specifies the type of the filter.", "nullable": false } }, "required": [ "columnName", "type" ] }, "description": "Specifies the version of the report. For ITEM, supported values are v1 through v6. For all other reportType values, only v1 is supported." }, "excludeColumns": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "List of columns to exclude from the report." }, "dataStartTime": { "type": [ "string", "null" ], "format": "date-time", "description": "Start timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." }, "dataEndTime": { "type": [ "string", "null" ], "format": "date-time", "description": "End timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." } } }, "GenerateReportResponse": { "type": "object", "properties": { "requestId": { "type": "string", "description": "System-generated ID that uniquely identifies the report request." }, "requestStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ], "description": "Filters report requests by status." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated. Example: ITEM for Item Report." }, "reportVersion": { "type": "string", "description": "Version of report for which the request is created. Example, v1." }, "requestSubmissionDate": { "type": "string", "description": "Date and time on which the report request is submitted." }, "payload": { "type": "object", "properties": { "rowFilters": { "type": "array", "items": { "type": "object" } }, "excludeColumns": { "type": "array", "items": { "type": "string" }, "description": "List of columns to exclude from the report." }, "dataStartTime": { "type": "string", "format": "date-time", "description": "Start timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." }, "dataEndTime": { "type": "string", "format": "date-time", "description": "End timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." } }, "description": "Date and time on which the report request is submitted." } } }, "GenerateReportSeachParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "GenerateTransportationOptionsBody": { "type": "object", "properties": { "placementOptionId": { "type": "string", "description": "The placement option to generate transportation options for.", "nullable": false }, "shipmentTransportationConfigurations": { "type": "array", "items": { "type": "object", "properties": { "contactInformation": { "type": [ "object", "null" ], "properties": { "email": { "type": [ "string", "null" ], "description": "The email address." }, "name": { "type": "string", "description": "The contact's name.", "nullable": false }, "phoneNumber": { "type": "string", "description": "The phone number.", "nullable": false } }, "required": [ "name", "phoneNumber" ] }, "freightInformation": { "type": [ "object", "null" ], "properties": { "declaredValue": { "type": [ "object", "null" ], "properties": { "amount": { "type": "number", "description": "Decimal value of the currency.", "nullable": false }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code.", "nullable": false } }, "required": [ "amount", "code" ] }, "freightClass": { "type": [ "string", "null" ], "description": "Freight class. Possible values: `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`." } } }, "pallets": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "dimensions": { "type": [ "object", "null" ], "properties": { "height": { "type": "number", "description": "The height of a package.", "nullable": false }, "length": { "type": "number", "description": "The length of a package.", "nullable": false }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package.", "nullable": false }, "width": { "type": "number", "description": "The width of a package.", "nullable": false } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false }, "stackability": { "type": [ "string", "null" ], "enum": [ "STACKABLE", "NON_STACKABLE" ], "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": [ "object", "null" ], "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ], "nullable": false }, "value": { "type": "number", "description": "Value of a weight.", "nullable": false } }, "required": [ "unit", "value" ] } }, "required": [ "quantity" ] }, "description": "List of pallet configuration inputs." }, "readyToShipWindow": { "type": "object", "properties": { "start": { "type": "string", "description": "The start date of the window. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with minute precision. Supports patterns `yyyy-MM-ddTHH:mmZ`, `yyyy-MM-ddTHH:mm:ssZ`, or `yyyy-MM-ddTHH:mm:ss.sssZ`. Note that non-zero second and millisecond components are removed.", "nullable": false } }, "required": [ "start" ], "description": "List of pallet configuration inputs.", "nullable": false }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded.", "nullable": false } }, "required": [ "readyToShipWindow", "shipmentId" ] }, "description": "List of shipment transportation configurations.", "nullable": false } }, "required": [ "placementOptionId", "shipmentTransportationConfigurations" ] }, "GenerateTransportationOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "GenerateTransportationOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "GenerateTransportationOptionsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "GetAllFeedStatusesParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "feedId": { "type": "string", "description": "A unique ID returned from the Bulk Upload API, used for tracking the feed file. Special characters must be URL-escaped" }, "offset": { "type": "number", "description": "Zero-based index for pagination of detailed results." }, "limit": { "type": "number", "description": "Maximum number of entities to return per page. Defaults to 50. Cannot be greater than 50." } }, "required": [ "feedId", "offset", "limit" ] }, "GetAllFeedStatusesResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "totalResults": { "type": "number", "description": "Total number of feeds returned." }, "offset": { "type": "number", "description": "Zero-based index of the first feed returned in this page." }, "limit": { "type": "number", "description": "Maximum number of feeds returned in this page." }, "results": { "type": "object", "properties": { "feed": { "type": "array", "items": { "type": "object" }, "description": "Feed status records." } }, "description": "Feed status results." } } }, "GetAllReportRequestsParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the report type to return. For example, use ITEM to retrieve Item reports." }, "reportVersion": { "type": "string", "description": "Specifies the version of the report. For example, v1." }, "requestStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ], "description": "Filters report requests by status." }, "src": { "type": "string", "enum": [ "SC", "API", "Scheduler" ], "description": "Filters report requests by their creation source. Valid values are SC (Seller Center), API, or Scheduler." }, "requestSubmissionStartDate": { "type": "string", "format": "date-time", "description": "Returns report requests submitted on or after this timestamp. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." }, "requestSubmissionEndDate": { "type": "string", "format": "date-time", "description": "Returns report requests submitted on or before this timestamp. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." }, "nextCursor": { "type": "string" } }, "required": [ "reportType" ] }, "GetAllReportRequestsResponse": { "type": "object", "properties": { "page": { "type": "number", "description": "Current page" }, "totalCount": { "type": "number", "description": "Number of records fetched." }, "limit": { "type": "number", "description": "Number of records to be returned. Default is 10." }, "nextCursor": { "type": "string", "description": "Used for pagination when more than specified limit (or default 10) records are found. Use this param for next API call. Just have to use this value as query param. Need to pass only the cursor value and not the initial API call query params." }, "requests": { "type": "array", "items": { "type": "object", "properties": { "requestId": { "type": "string", "description": "System-generated ID that uniquely identifies the report request." }, "requestStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ], "description": "Filters report requests by status." }, "src": { "type": "string", "enum": [ "SC", "API", "Scheduler" ], "description": "Filters report requests by their creation source. Valid values are SC (Seller Center), API, or Scheduler." }, "requestSubmissionDate": { "type": "string", "description": "Date and time on which the report request is submitted." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated. Example: ITEM for Item Report." }, "reportVersion": { "type": "string", "description": "Version of report for which the request is created. Example, v1." } } }, "description": "Used for pagination when more than specified limit (or default 10) records are found. Use this param for next API call. Just have to use this value as query param. Need to pass only the cursor value and not the initial API call query params." } } }, "GetAllReportSchedulesParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated." }, "nextCursor": { "type": "string", "description": "Specifies the type of report to be generated." } }, "required": [ "reportType", "nextCursor" ] }, "GetAllReportSchedulesResponse": { "type": "object", "properties": { "page": { "type": "number", "description": "Current page" }, "totalCount": { "type": "number", "description": "Number of records fetched." }, "limit": { "type": "number", "description": "Number of records to be returned. Default is 10." }, "nextCursor": { "type": "string", "description": "Specifies pagination when records exceed the specified limit (or default of 10); pass this parameter for the next API call." }, "schedules": { "type": "array", "items": { "type": "object", "properties": { "scheduleId": { "type": "string", "description": "Unique identifier for the schedule." }, "requestSubmissionDate": { "type": "string", "format": "date-time", "description": "The timestamp (date and time) indicating when the report request was submitted." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated." }, "reportVersion": { "type": "string", "description": "Specifies the version of report for which the request is created. Example: v1." }, "reportSummary": { "type": "string", "description": "Provides a brief summary of the report." }, "scheduleStartDate": { "type": "string", "description": "Specifies the start date for the schedule. The date should be in a valid date format (Example: YYYY-MM-DD)." }, "nextScheduledTime": { "type": "string", "description": "The next scheduled time for the report." }, "payload": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ], "description": "Specifies the frequency at which the report should be generated. For example, if set to YEARLY, the report will be generated once every year." }, "repeatsEvery": { "type": "number", "description": "Defines the interval at which the report repeats based on the selected frequency." }, "hour": { "type": "number", "description": "Specifies the hour of the day at which the schedule will be triggered. Allowed values are from 0 to 23, where 0 corresponds to 12:00 AM UTC and 23 corresponds to 11:00 PM UTC. The hour selection is based on the UTC timezone." }, "dayOfMonth": { "type": "number", "description": "Specifies the day of the month on which the schedule will be triggered." }, "dayOfWeek": { "type": "number", "description": "Specifies the day of the week on which the schedule will be triggered. Allowed values are from 0 to 6, where 0 represents Monday and 6 represents Sunday." }, "monthOfYear": { "type": "number", "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." }, "filters": { "type": "object", "properties": { "email": { "type": "string" }, "rowFilters": { "type": "object", "properties": { "type": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } }, "columnName": { "type": "string" } }, "required": [ "type", "values", "columnName" ] } }, "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." } }, "description": "The next scheduled time for the report." }, "requestModifiedTime": { "type": "string", "description": "The date and time when the report schedule was last modified." } }, "required": [ "scheduleId", "requestSubmissionDate", "reportType", "reportVersion", "payload" ] }, "description": "Specifies pagination when records exceed the specified limit (or default of 10); pass this parameter for the next API call." } }, "required": [ "page", "totalCount", "limit", "nextCursor", "schedules" ] }, "GetAllSubscriptionsParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "subscriptionId": { "type": "string", "description": "Filter results to a specific subscription by its unique identifier." }, "eventType": { "type": "string", "description": "Filter results to a specific event type. Refer to the events section for the list of available event types." }, "resourceName": { "type": "string", "description": "Filter results to a specific resource (functional category) that the event type maps to. Refer to the events section for the list of available resource names." }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ], "description": "Filter results by subscription status." } } }, "GetAllSubscriptionsResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "events": { "type": "array", "items": { "type": "object", "properties": { "eventType": { "type": "string", "description": "Event type for which the subscription was created." }, "subscriptionId": { "type": "string", "description": "Unique identifier for the subscription that you can use to fetch details, edit, or delete the subscription." }, "partnerId": { "type": "string", "description": "Partner ID of the seller who created the subscription." }, "eventVersion": { "type": "string", "description": "Version of the event type for which the subscription was created." }, "resourceName": { "type": "string", "description": "Resource or functional category that the event type is mapped to (for example, ITEM, ORDER, PRICE)." }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ], "description": "Current state of the subscription." }, "eventUrl": { "type": "string", "description": "Destination URL where notifications for this subscription will be delivered." }, "authDetails": { "type": "object", "properties": { "authMethod": { "type": "string", "enum": [ "BASIC_AUTH", "OAUTH", "HMAC" ], "description": "Authentication method for the destination URL." }, "userName": { "type": "string", "description": "Username used to access the destination URL (required for BASIC_AUTH)." }, "password": { "type": "string", "description": "Password used to access the destination URL (required for BASIC_AUTH)." }, "authHeaderName": { "type": "string", "description": "Header name used to pass the authorization value to the destination URL (for example, Authorization)." }, "authUrl": { "type": "string", "description": "OAuth server or token URL used when the authentication method is OAUTH." }, "clientSecret": { "type": "string", "description": "Client secret used with the OAuth server (OAUTH) or as key material for HMAC." }, "clientId": { "type": "string", "description": "Client ID used with the OAuth server when the authentication method is OAUTH." } }, "required": [ "authMethod", "userName", "password", "authHeaderName", "authUrl", "clientSecret", "clientId" ], "description": "Destination URL where notifications for this subscription will be delivered." }, "headers": { "type": "object", "properties": { "content-type": { "type": "string" } }, "required": [ "content-type" ], "description": "Headers required for accessing the destination URL." } }, "required": [ "eventType", "subscriptionId", "partnerId", "eventVersion", "resourceName", "status", "eventUrl", "authDetails", "headers" ] }, "description": "List of subscriptions that match the request filters." } } }, "GetAnItemParams": { "type": "object", "properties": { "id": { "type": "string" }, "productIdType": { "type": "string", "enum": [ "EAN", "GTIN", "ISBN", "SKU", "ITEM_ID" ] }, "condition": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "New" ] }, { "type": "string", "enum": [ "New with defects" ] }, { "type": "string", "enum": [ "New without box" ] }, { "type": "string", "enum": [ "New without tags" ] }, { "type": "string", "enum": [ "Open Box" ] }, { "type": "string", "enum": [ "Pre-Owned: Fair" ] }, { "type": "string", "enum": [ "Pre-Owned: Good" ] }, { "type": "string", "enum": [ "Pre-Owned: Like New" ] }, { "type": "string", "enum": [ "Remanufactured" ] }, { "type": "string", "enum": [ "Restored Premium" ] }, { "type": "string", "enum": [ "Restored" ] } ] }, "availability": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "In_stock" ] }, { "type": "string", "enum": [ "Out_of_stock" ] }, { "type": "string", "enum": [ "Preorder" ] } ] }, "showDuplicateItemDetails": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "includeCustomerFavoritesStatus": { "type": "object" }, "itemId": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "save": { "oneOf": [ { "type": "object" }, { "type": "string" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "id", "productIdType", "mp" ] }, "GetAnItemResponse": { "type": "object", "properties": { "ItemResponse": { "type": "array", "items": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } }, "required": [ "sku" ] } } }, "required": [ "ItemResponse" ] }, "GetCarrierRateQuoteParams": { "type": "object", "properties": { "quoteType": { "type": "string", "enum": [ "LTL", "FTL", "Parcel" ] }, "shipmentId": { "type": "string" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "quoteType", "shipmentId", "mp" ] }, "GetCarrierRateQuoteResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "payload": { "oneOf": [ { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Unique identifier identifying each shipment" }, "shipmentPackages": { "type": "array", "items": { "type": "object", "properties": { "packageSequenceNumber": { "type": "number", "description": "Package Sequence Number" }, "isStackable": { "type": "boolean", "description": "Package Sequence Number" }, "width": { "type": "number", "description": "Width. ≥ -1" }, "length": { "type": "number", "description": "Length. ≥ -1" }, "weightUOM": { "type": "string", "enum": [ "lb" ], "description": "Weight unit of measurement, should always be \"lb\"" }, "lengthUOM": { "type": "string", "enum": [ "in" ], "description": "Length unit of measurement, should always be \"in\"" }, "height": { "type": "number", "description": "Height. ≥ -1" }, "noOfPackages": { "type": "number", "description": "Number of Packages" }, "weight": { "type": "number", "description": "Weight. -1 to 150" }, "volume": { "type": "number", "description": "Weight. -1 to 150" }, "totalMasterCases": { "type": "number" }, "totalUnitsPerMasterCases": { "type": "number" }, "totalUnits": { "type": "number" }, "billingWeight": { "type": "number", "description": "Billing Weight" }, "netCharge": { "type": "number", "description": "Billing Weight" }, "nominalCharge": { "type": "number" }, "assessorialCharge": { "type": "number" }, "serviceCharge": { "type": "number" }, "fedExFreightCharge": { "type": "number" }, "discountCharge": { "type": "number" } }, "required": [ "packageSequenceNumber", "width", "length", "weightUOM", "lengthUOM", "height", "weight" ] }, "description": "List of packages being shipped" }, "quoteType": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ], "description": "List of packages being shipped" }, "quoteId": { "type": "string", "description": "Unique identifier identifying each quote" }, "quoteCreationDate": { "type": "string", "format": "date-time", "description": "Creation date of quote" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } }, "description": "Creation date of quote" }, "originLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] } }, "required": [ "locationName", "address" ] }, "destinationLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] } }, "required": [ "locationName", "address" ] }, "rateQuote": { "type": "object", "properties": { "assessorialCharge": { "type": "number" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "declaredValue": { "type": "string" }, "discountCharge": { "type": "number" }, "effectiveDate": { "type": "string" }, "equipmentTypeCode": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string" }, "expiryDate": { "type": "string" }, "freightCharge": { "type": "number" }, "freightReadyDate": { "type": "string" }, "fuelCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "mixedSKUs": { "type": "number" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "netCharge": { "type": "number" }, "nominalCharge": { "type": "number" }, "numberOfPallets": { "type": "number" }, "quoteId": { "type": "string" }, "sellerFreightClassCode": { "type": "string" }, "serviceCharge": { "type": "number" }, "serviceCode": { "type": "string" }, "singleSKUs": { "type": "number" }, "status": { "type": "string" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "totalWeight": { "type": "number" }, "transitDays": { "type": "string" }, "sp_status": { "type": "string" } } }, "aggregates": { "type": "object", "properties": { "totalCharge": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalDiscount": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalBillingWeight": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalWeight": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalVolume": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } } } }, "netCharge": { "type": "number" }, "fedExFreightCharge": { "type": "number" }, "serviceCharge": { "type": "number" }, "quoteStatus": { "type": "string" }, "mpsShipment": { "type": "boolean" }, "estimatedDeliveryDateTime": { "type": "string", "format": "date-time" }, "eligibleForITS": { "type": "boolean" }, "status": { "type": "string", "enum": [ "OK", "ERROR" ] } }, "required": [ "shipmentId", "shipmentPackages", "status" ] }, { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Unique identifier identifying each shipment" }, "shipmentPackages": { "type": "array", "items": { "type": "object", "properties": { "packageSequenceNumber": { "type": "number", "description": "Package Sequence Number" }, "isStackable": { "type": "boolean", "description": "Package Sequence Number" }, "width": { "type": "number", "description": "Width. ≥ -1" }, "length": { "type": "number", "description": "Length. ≥ -1" }, "weightUOM": { "type": "string", "enum": [ "lb" ], "description": "Weight unit of measurement, should always be \"lb\"" }, "lengthUOM": { "type": "string", "enum": [ "in" ], "description": "Length unit of measurement, should always be \"in\"" }, "height": { "type": "number", "description": "Height. ≥ -1" }, "noOfPackages": { "type": "number", "description": "Number of Packages" }, "weight": { "type": "number", "description": "Weight. -1 to 150" }, "volume": { "type": "number", "description": "Weight. -1 to 150" }, "totalMasterCases": { "type": "number" }, "totalUnitsPerMasterCases": { "type": "number" }, "totalUnits": { "type": "number" }, "billingWeight": { "type": "number", "description": "Billing Weight" }, "netCharge": { "type": "number", "description": "Billing Weight" }, "nominalCharge": { "type": "number" }, "assessorialCharge": { "type": "number" }, "serviceCharge": { "type": "number" }, "fedExFreightCharge": { "type": "number" }, "discountCharge": { "type": "number" } }, "required": [ "packageSequenceNumber", "width", "length", "weightUOM", "lengthUOM", "height", "weight" ] }, "description": "List of packages being shipped" }, "quoteType": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ], "description": "List of packages being shipped" }, "quoteId": { "type": "string", "description": "Unique identifier identifying each quote" }, "quoteCreationDate": { "type": "string", "format": "date-time", "description": "Creation date of quote" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } }, "description": "Creation date of quote" }, "originLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] } }, "required": [ "locationName", "address" ] }, "destinationLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] } }, "required": [ "locationName", "address" ] }, "rateQuote": { "type": "object", "properties": { "assessorialCharge": { "type": "number" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "declaredValue": { "type": "string" }, "discountCharge": { "type": "number" }, "effectiveDate": { "type": "string" }, "equipmentTypeCode": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string" }, "expiryDate": { "type": "string" }, "freightCharge": { "type": "number" }, "freightReadyDate": { "type": "string" }, "fuelCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "mixedSKUs": { "type": "number" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "netCharge": { "type": "number" }, "nominalCharge": { "type": "number" }, "numberOfPallets": { "type": "number" }, "quoteId": { "type": "string" }, "sellerFreightClassCode": { "type": "string" }, "serviceCharge": { "type": "number" }, "serviceCode": { "type": "string" }, "singleSKUs": { "type": "number" }, "status": { "type": "string" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "totalWeight": { "type": "number" }, "transitDays": { "type": "string" }, "sp_status": { "type": "string" } } }, "aggregates": { "type": "object", "properties": { "totalCharge": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalDiscount": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalBillingWeight": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalWeight": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalVolume": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } } } }, "netCharge": { "type": "number" }, "fedExFreightCharge": { "type": "number" }, "serviceCharge": { "type": "number" }, "quoteStatus": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "OK", "ERROR" ] } } }, { "type": "object", "properties": { "quoteId": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "aggregates": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "totalCharge": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "unitOfMeasure": { "type": "object" }, "measurementValue": { "oneOf": [ { "type": "object" }, { "type": "number" } ] } } } ] }, "totalDiscount": { "type": "object" }, "totalBillingWeight": { "type": "object" }, "totalWeight": { "type": "object" }, "totalVolume": { "type": "object" } } } ] }, "netCharge": { "type": "object" }, "fedExFreightCharge": { "type": "object" }, "serviceCharge": { "type": "object" }, "quoteStatus": { "type": "object" }, "mpsShipment": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "eligibleForITS": { "type": "object" }, "transitDetails": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "stopOrigin": { "type": "object" }, "stopDestination": { "type": "object" }, "type": { "type": "object" }, "transitTime": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "unitOfMeasure": { "type": "object" }, "measurementValue": { "type": "object" }, "length": { "type": "number" }, "toString": { "type": "object" }, "toLocaleString": { "type": "object" }, "pop": { "type": "object" }, "push": { "type": "object" }, "concat": { "type": "object" }, "join": { "type": "object" }, "reverse": { "type": "object" }, "shift": { "type": "object" }, "slice": { "type": "object" }, "sort": { "type": "object" }, "splice": { "type": "object" }, "unshift": { "type": "object" }, "indexOf": { "type": "object" }, "lastIndexOf": { "type": "object" }, "every": { "type": "object" }, "some": { "type": "object" }, "forEach": { "type": "object" }, "map": { "type": "object" }, "filter": { "type": "object" }, "reduce": { "type": "object" }, "reduceRight": { "type": "object" }, "find": { "type": "object" }, "findIndex": { "type": "object" }, "fill": { "type": "object" }, "copyWithin": { "type": "object" }, "entries": { "type": "object" }, "keys": { "type": "object" }, "values": { "type": "object" }, "includes": { "type": "object" }, "flatMap": { "type": "object" }, "flat": { "type": "object" }, "at": { "type": "object" }, "findLast": { "type": "object" }, "findLastIndex": { "type": "object" }, "toReversed": { "type": "object" }, "toSorted": { "type": "object" }, "toSpliced": { "type": "object" }, "with": { "type": "object" }, "__@iterator@894": { "type": "object" }, "__@unscopables@896": { "type": "object", "properties": { "length": { "type": "object" }, "toString": { "type": "object" }, "toLocaleString": { "type": "object" }, "pop": { "type": "object" }, "push": { "type": "object" }, "concat": { "type": "object" }, "join": { "type": "object" }, "reverse": { "type": "object" }, "shift": { "type": "object" }, "slice": { "type": "object" }, "sort": { "type": "object" }, "splice": { "type": "object" }, "unshift": { "type": "object" }, "indexOf": { "type": "object" }, "lastIndexOf": { "type": "object" }, "every": { "type": "object" }, "some": { "type": "object" }, "forEach": { "type": "object" }, "map": { "type": "object" }, "filter": { "type": "object" }, "reduce": { "type": "object" }, "reduceRight": { "type": "object" }, "find": { "type": "object" }, "findIndex": { "type": "object" }, "fill": { "type": "object" }, "copyWithin": { "type": "object" }, "entries": { "type": "object" }, "keys": { "type": "object" }, "values": { "type": "object" }, "includes": { "type": "object" }, "flatMap": { "type": "object" }, "flat": { "type": "object" }, "at": { "type": "object" }, "findLast": { "type": "object" }, "findLastIndex": { "type": "object" }, "toReversed": { "type": "object" }, "toSorted": { "type": "object" }, "toSpliced": { "type": "object" }, "with": { "type": "object" }, "__@iterator@894": { "type": "object" }, "__@unscopables@896": { "type": "object" } } } }, "required": [ "length", "toString", "toLocaleString", "pop", "push", "concat", "join", "reverse", "shift", "slice", "sort", "splice", "unshift", "indexOf", "lastIndexOf", "every", "some", "forEach", "map", "filter", "reduce", "reduceRight", "find", "findIndex", "fill", "copyWithin", "entries", "keys", "values", "includes", "flatMap", "flat", "at", "findLast", "findLastIndex", "toReversed", "toSorted", "toSpliced", "with", "__@iterator@894", "__@unscopables@896" ] } ] } } } } ] }, "mode": { "type": "object" }, "effectiveDate": { "oneOf": [ { "type": "object" }, { "type": "string", "format": "date-time" } ] }, "expiryDate": { "type": "object" }, "schedule": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "minPickupTs": { "type": "object" }, "maxPickupTs": { "type": "object" }, "minDueTs": { "type": "object" }, "maxDueTs": { "type": "object" } } } ] } } } ] }, "status": { "type": "string", "enum": [ "OK", "ERROR" ] } } }, "GetFeedItemStatusResponse": { "type": "object", "properties": { "feedId": { "type": "string", "description": "Unique ID used for tracking the feed file." }, "feedType": { "type": "string", "enum": [ "MP_ITEM_MATCH", "MP_ITEM", "inventory", "PRICE_AND_PROMOTION", "OMNI_WFS", "price" ], "description": "Type of feed submitted" }, "feedStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "PROCESSED", "ERROR", "Submitted" ], "description": "Current feed processing state." }, "itemsReceived": { "type": "number", "description": "Number of items received in the feed." }, "itemsSucceeded": { "type": "number", "description": "Number of items that processed successfully." }, "itemsFailed": { "type": "number", "description": "Number of items that failed due to a data or system error." }, "itemsProcessing": { "type": "number", "description": "Number of items still processing." }, "ingestionErrors": { "type": "object", "properties": { "ingestionError": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ], "description": "Error type for the item-level failure." }, "code": { "type": "string", "description": "Item-level error code." }, "description": { "type": "string", "description": "Item-level error description." } }, "required": [ "type", "code" ] } } }, "description": "List of ingestion errors at the feed level." }, "offset": { "type": "number", "description": "Zero-based index of the first item detail returned in this page." }, "limit": { "type": "number", "description": "Number of item detail records returned in this page. Cannot be greater than 1000." }, "itemDetails": { "type": "object", "properties": { "itemIngestionStatus": { "type": "array", "items": { "type": "object", "properties": { "martId": { "type": "number", "description": "Mart identifier associated with the marketplace." }, "wpid": { "type": "string", "description": "Walmart product identifier assigned after item creation." }, "index": { "type": "number", "description": "Item position within the original feed payload." }, "ingestionStatus": { "type": "string", "enum": [ "INPROGRESS", "SUCCESS", "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ], "description": "Item ingestion status." }, "sku": { "type": "string", "description": "Seller-defined unique Stock Keeping Unit (SKU) for the item." }, "ingestionErrors": { "type": "object", "properties": { "ingestionError": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ] }, "code": { "type": "string", "description": "Item-level error code." }, "field": { "type": "string", "description": "Item-level error code." }, "description": { "type": "string", "description": "Item-level error description." } }, "required": [ "type", "code" ] } } }, "description": "List of errors for the item." } } }, "description": "Ingestion status entries for individual items in the feed." } }, "description": "Item-level ingestion status details in the feed." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } } } }, "GetFeedItemStatusSearchParams": { "type": "object", "properties": { "includeDetails": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "offset": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "limit": { "type": "object" }, "feedType": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "price" ] }, { "type": "string", "enum": [ "inventory" ] }, { "type": "string", "enum": [ "MP_ITEM_MATCH" ] }, { "type": "string", "enum": [ "MP_ITEM" ] }, { "type": "string", "enum": [ "PRICE_AND_PROMOTION" ] }, { "type": "string", "enum": [ "OMNI_WFS" ] } ] }, "saveAllItems": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "GetInboundShipmentErrorsParams": { "type": "object", "properties": { "offset": { "type": "number", "description": "The number of records you wish to skip before selecting records. Defaults to 0" }, "limit": { "type": "number", "description": "The number of Purchase Orders to be returned. Defaults to 10" }, "inboundOrderId": { "type": "string", "description": "Unique ID identifying inbound shipment request." }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "Unique ID identifying inbound shipment request." } }, "required": [ "inboundOrderId", "mp" ] }, "GetInboundShipmentErrorsResponse": { "type": "object", "properties": { "headers": { "type": "object", "properties": { "totalCount": { "type": "number", "description": "Total number of POs for provided GET request." }, "limit": { "type": "number", "description": "Provided limit value in the request" }, "offset": { "type": "number", "description": "Provided offset value in the request." } }, "required": [ "totalCount" ] }, "payload": { "type": "array", "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string", "description": "Unique ID identifying inbound shipment requests" }, "createdDate": { "type": "string", "format": "date-time", "description": "Created date for the request" }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ], "description": "Return address of seller" }, "orderItems": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "description": "Unique ID identifying product" }, "productType": { "type": "string", "enum": [ "GTIN" ], "description": "Supported product types are GTIN" }, "sku": { "type": "string", "description": "Seller Item ID" }, "itemDesc": { "type": "string", "description": "Item description" }, "itemQty": { "type": "number", "description": "Total number of sellable units. ≥ 1" }, "vendorPackQty": { "type": "number", "description": "Total number of cases. ≥ 1" }, "innerPackQty": { "type": "number", "description": "Total number of sellable units per case. ≥ 1" }, "expectedDeliveryDate": { "type": "string", "description": "Expected delivery date for shipment" }, "addOnServices": { "type": "array", "items": { "type": "object", "properties": { "serviceType": { "type": "string", "enum": [ "LABEL", "BAG", "TAPE", "WRAP" ] } } }, "description": "Indicate whether add-on services (e.g. item labeling or poly bagging) are needed" }, "itemNbr": { "type": "number", "description": "Indicate whether add-on services (e.g. item labeling or poly bagging) are needed" }, "dimensions": { "type": "array", "items": { "type": "number" } }, "itemWeightQty": { "type": "number" }, "nonSortItem": { "type": "boolean" }, "shipNode": { "type": "string" } }, "required": [ "productId", "productType", "sku", "itemDesc", "itemQty", "vendorPackQty", "innerPackQty", "expectedDeliveryDate" ] }, "description": "Inbound shipment request line items" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Inbound shipment request line items" } }, "required": [ "inboundOrderId", "createdDate", "returnAddress" ] }, "description": "response payload" } }, "required": [ "headers", "payload" ] }, "GetInboundShipmentItemsParams": { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Unique ID identifying each shipment." }, "limit": { "type": "number", "description": "The number of items to be returned." }, "offset": { "type": "number", "description": "offset is the number of records you wish to skip before selecting records." }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "offset is the number of records you wish to skip before selecting records." } }, "required": [ "shipmentId", "limit", "offset", "mp" ] }, "GetInboundShipmentItemsResponse": { "type": "object", "properties": { "headers": { "type": "object", "properties": { "totalCount": { "type": "number", "description": "total number of items for provided GET request." }, "limit": { "type": "number", "description": "provided limit value in the request" }, "offset": { "type": "number", "description": "provided offset value in the request." } }, "required": [ "totalCount", "limit", "offset" ] }, "payload": { "type": "array", "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string", "description": "Unique ID identifying inbound shipment request" }, "shipmentId": { "type": "string", "description": "Unique ID identifying each shipment" }, "gtin": { "type": "string", "description": "Item barcode" }, "sku": { "type": "string", "description": "Seller Item ID" }, "itemDesc": { "type": "string", "description": "Item description" }, "itemQty": { "type": "number", "description": "Total number of sellable units" }, "vendorPackQty": { "type": "number", "description": "Total number of cases" }, "innerPackQty": { "type": "number", "description": "Total number of sellable units per case" }, "receivedQty": { "type": "number", "description": "Qty received in FC" }, "damagedQty": { "type": "number", "description": "Qty damaged while receiving in FC" }, "fillRate": { "type": "number", "description": "Fill rate for this shipment item" }, "expectedDeliveryDate": { "type": "string", "format": "date-time", "description": "expected delivery date provided by seller" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time", "description": "update expected delivery date based on network capacity" }, "shipNodeName": { "type": "string", "description": "FC name" } }, "required": [ "inboundOrderId", "shipmentId", "gtin", "sku", "itemDesc", "itemQty", "vendorPackQty", "innerPackQty", "receivedQty", "damagedQty", "fillRate", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "shipNodeName" ] } } }, "required": [ "headers", "payload" ] }, "GetInboundShipmentsParams": { "type": "object", "properties": { "offset": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "limit": { "type": "object" }, "inboundOrderId": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "shipmentId": { "type": "object" }, "status": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "CANCELLED" ] }, { "type": "string", "enum": [ "CLOSED" ] }, { "type": "string", "enum": [ "RECEIVED" ] }, { "type": "string", "enum": [ "PROCESSED" ] }, { "type": "string", "enum": [ "SUBMITTED" ] }, { "type": "string", "enum": [ "FAILED_GDM" ] }, { "type": "string", "enum": [ "ENRICHMENT_FAILED_GDM" ] }, { "type": "string", "enum": [ "AWAITING_DELIVERY" ] }, { "type": "string", "enum": [ "CANCELLED_GDM" ] }, { "type": "string", "enum": [ "MOVED" ] }, { "type": "string", "enum": [ "CANCELLED_INIT" ] }, { "type": "string", "enum": [ "FAILED" ] }, { "type": "string", "enum": [ "FINALIZED" ] }, { "type": "string", "enum": [ "FAILED_AND_CANCELED" ] }, { "type": "string", "enum": [ "PROCESSED_GDM" ] }, { "type": "string", "enum": [ "ALLOCATED" ] }, { "type": "string", "enum": [ "RECEIVING_IN_PROGRESS" ] }, { "type": "string", "enum": [ "CREATE_GDM_PUBLISH_FAILED" ] }, { "type": "string", "enum": [ "TRANSFER_IN_PROGRESS" ] }, { "type": "string", "enum": [ "CANCELED" ] } ] }, "fromCreateDate": { "oneOf": [ { "type": "object" }, { "type": "string", "format": "date-time" } ] }, "toCreateDate": { "type": "object" }, "import": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "sync": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "GetInboundShipmentsResponse": { "type": "object", "properties": { "headers": { "type": "object", "properties": { "totalCount": { "type": "number" }, "limit": { "type": "number" }, "offset": { "type": "number" } }, "required": [ "totalCount" ] }, "payload": { "type": "array", "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } } }, "required": [ "headers", "payload" ] }, "GetInventoryParams": { "type": "object", "properties": { "sku": { "type": "string" }, "shipNode": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "sku", "mp" ] }, "GetInventorySummariesErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "granularity": { "type": "object", "properties": { "granularityType": { "type": "string", "description": "The granularity type for the inventory aggregation level." }, "granularityId": { "type": "string", "description": "The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId." } } }, "inventorySummaries": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } } } } }, "required": [ "granularity", "inventorySummaries" ] }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "GetInventorySummariesResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "granularity": { "type": "object", "properties": { "granularityType": { "type": "string", "description": "The granularity type for the inventory aggregation level." }, "granularityId": { "type": "string", "description": "The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId." } } }, "inventorySummaries": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } } } } }, "required": [ "granularity", "inventorySummaries" ] }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "GetInventorySummariesSearchParams": { "type": "object", "properties": { "details": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "startDateTime": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "sellerSkus": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "sellerSku": { "type": "object" }, "nextToken": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "granularityType": { "type": "string", "enum": [ "Marketplace" ] }, "granularityId": { "type": "string" }, "marketplaceIds": { "type": "object" } } }, "GetLabelsErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "DownloadURL": { "type": "string", "description": "URL to download the label for the package. Note: The URL will only be valid for 15 seconds" } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "GetLabelsResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "DownloadURL": { "type": "string", "description": "URL to download the label for the package. Note: The URL will only be valid for 15 seconds" } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "GetLabelsSearchParams": { "type": "object", "properties": { "PageType": { "type": "string", "enum": [ "PackageLabel_Letter_2", "PackageLabel_Letter_4", "PackageLabel_Letter_6", "PackageLabel_Letter_6_CarrierLeft", "PackageLabel_A4_2", "PackageLabel_A4_4", "PackageLabel_Plain_Paper", "PackageLabel_Plain_Paper_CarrierBottom", "PackageLabel_Thermal", "PackageLabel_Thermal_Unified", "PackageLabel_Thermal_NonPCP", "PackageLabel_Thermal_No_Carrier_Rotation" ] }, "LabelType": { "type": "string", "enum": [ "BARCODE_2D", "UNIQUE", "PALLET" ] }, "NumberOfPackages": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "PackageLabelsToPrint": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "NumberOfPallets": { "type": "object" }, "PageSize": { "type": "object" }, "PageStartIndex": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "PageType", "LabelType", "mp" ] }, "GetListingsItemErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses." } }, "required": [ "errors" ] }, "GetListingsItemResponse": { "type": "object", "properties": { "sku": { "type": "string", "description": "A selling partner-provided identifier for an Amazon listing." }, "summaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "A marketplace identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." }, "productType": { "type": "string", "description": "The listings item's Amazon product type." }, "conditionType": { "type": "string", "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" ], "description": "Identifies the condition of the listings item." }, "status": { "type": "array", "items": { "type": "object" }, "description": "Statuses that apply to the listings item." }, "fnSku": { "type": "string", "description": "Fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item." }, "itemName": { "type": "string", "description": "Name, or title, associated with an Amazon catalog item." }, "createdDate": { "type": "string", "description": "Date the listings item was created, in ISO 8601 format." }, "lastUpdatedDate": { "type": "string", "description": "Date the listings item was last updated, in ISO 8601 format." }, "mainImage": { "type": "object", "properties": { "link": { "type": "string", "description": "The image's link or URL." }, "height": { "type": "number", "description": "The image's height, in pixels." }, "width": { "type": "number", "description": "The image's width, in pixels." } }, "required": [ "link", "height", "width" ], "description": "Date the listings item was last updated, in ISO 8601 format." } }, "required": [ "marketplaceId", "productType", "status", "createdDate", "lastUpdatedDate" ] }, "description": "A selling partner-provided identifier for an Amazon listing." }, "attributes": {}, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] } }, "offers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "offerType": { "type": "string", "enum": [ "B2C", "B2B" ], "description": "The listings item's offer type." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ], "description": "The listings item's offer type." }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points offered with the purchase of an item, and their monetary value." } }, "required": [ "pointsNumber" ] }, "audience": { "type": "object", "properties": { "value": { "type": "string", "description": "Name of the audience an offer is applicable to. Common values: * 'ALL' - Standard offer audience for buyers on Amazon retail websites. * 'B2B' - Offer audience for Amazon Business website buyers." }, "displayName": { "type": "string", "description": "Localized display name for the audience." } } } }, "required": [ "marketplaceId", "offerType", "price" ] } }, "fulfillmentAvailability": { "type": "array", "items": { "type": "object", "properties": { "fulfillmentChannelCode": { "type": "string", "description": "Designates which fulfillment network is used." }, "quantity": { "type": "number", "description": "The item quantity that you're making available for sale." } }, "required": [ "fulfillmentChannelCode" ] }, "description": "The listings item's fulfillment availability." }, "procurement": { "type": "array", "items": { "type": "object", "properties": { "costPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ] } }, "required": [ "costPrice" ] }, "description": "The listings item's vendor procurement information." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are children of this listing item." }, "parentSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "The names of the listing item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "The variation theme that indicates the combination of listing item attributes that define the variation family." } }, "required": [ "attributes", "theme" ], "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "The type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the listing item." } }, "required": [ "marketplaceId", "relationships" ] }, "description": "The listings item's vendor procurement information." }, "productTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "productType": { "type": "string", "description": "The name of the product type that is submitted by the Selling Partner." } }, "required": [ "marketplaceId", "productType" ] } } }, "required": [ "sku" ] }, "GetListingsItemSearchParams": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" } }, "issueLocale": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "includedData": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "attributes", "productTypes", "relationships", "summaries", "issues", "offers", "fulfillmentAvailability", "procurement" ] } } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceIds", "mp" ] }, "GetPickupSellerScheduleParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "shipmentId": { "type": "string", "description": "Unique identifier identifying each shipment." }, "quoteType": { "type": "string", "description": "Specifies the transportation quote." }, "quoteId": { "type": "string", "description": "Unique identifier identifying each quote." } }, "required": [ "shipmentId", "quoteType", "quoteId" ] }, "GetPickupSellerScheduleResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "status": { "type": "string", "enum": [ "OK" ] }, "payload": { "type": "object", "properties": { "pickupConfirmationNumber": { "type": "string", "description": "pickup confirmation number." }, "pickupDate": { "type": "string", "description": "Scheduled pickup date in YYYY-MM-DD format." }, "readyTime": { "type": "string", "description": "Facility ready time when the carrier can arrive in HH:MM:SS format." }, "closeTime": { "type": "string", "description": "Facility close time for pickup in 24-hour HH:MM:SS format." }, "status": { "type": "string", "description": "Pickup scheduling status." } }, "required": [ "pickupConfirmationNumber", "pickupDate", "readyTime", "closeTime", "status" ] } }, "required": [ "status" ] }, "GetSearchResultResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } } } }, "required": [ "items" ] }, "GetSearchResultSearchParams": { "type": "object", "properties": { "query": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "item_id": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "GetShipmentErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "GetShipmentResponse": { "type": "object", "properties": { "amazonReferenceId": { "type": "string", "description": "A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment." }, "contactInformation": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The contact's name." }, "phoneNumber": { "type": "string", "description": "The phone number." } }, "required": [ "name", "phoneNumber" ], "description": "A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment." }, "dates": { "type": "object", "properties": { "readyToShipWindow": { "type": "object", "properties": { "editableUntil": { "type": "string", "description": "The timestamp at which this Window can no longer be edited." }, "end": { "type": "string", "description": "The end timestamp of the window." }, "start": { "type": "string", "description": "The start timestamp of the window." } }, "required": [ "end", "start" ] } } }, "destination": { "type": "object", "properties": { "address": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ] }, "destinationType": { "type": "string", "description": "The type of destination for this shipment. Possible values: `AMAZON_OPTIMIZED`, `AMAZON_WAREHOUSE`." }, "warehouseId": { "type": "string", "description": "The warehouse that the shipment should be sent to. This can be empty if the destination type is `AMAZON_OPTIMIZED`." } }, "required": [ "destinationType" ] }, "freightInformation": { "type": "object", "properties": { "declaredValue": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "freightClass": { "type": "string", "description": "Freight class. Possible values: `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", "description": "The name of the shipment." }, "placementOptionId": { "type": "string", "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "selectedDeliveryWindow": { "type": "object", "properties": { "availabilityType": { "type": "string", "description": "The type of delivery window availability. Values: `AVAILABLE`, `BLOCKED`, `CONGESTED`, `DISCOUNTED`" }, "deliveryWindowOptionId": { "type": "string", "description": "Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered." }, "editableUntil": { "type": "string", "description": "The timestamp at which this Window can no longer be edited." }, "endDate": { "type": "string", "description": "The end timestamp of the window." }, "startDate": { "type": "string", "description": "The start timestamp of the window." } }, "required": [ "availabilityType", "deliveryWindowOptionId", "endDate", "startDate" ], "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "selectedTransportationOptionId": { "type": "string", "description": "Identifier of a transportation option. A transportation option represent one option for how to send a shipment." }, "selfShipAppointmentDetails": { "type": "array", "items": { "type": "object", "properties": { "appointmentId": { "type": "number", "description": "Identifier for appointment." }, "appointmentSlotTime": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ], "description": "Identifier for appointment." }, "appointmentStatus": { "type": "string", "description": "Status of the appointment." } } }, "description": "List of self ship appointment details." }, "shipmentConfirmationId": { "type": "string", "description": "The confirmed shipment ID which shows up on labels (for example, `FBA1234ABCD`)." }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "source": { "type": "object", "properties": { "address": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ] }, "sourceType": { "type": "string", "description": "The type of source for this shipment. Possible values: `SELLER_FACILITY`." } }, "required": [ "sourceType" ], "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "status": { "type": "string", "description": "The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`" }, "trackingDetails": { "type": "object", "properties": { "ltlTrackingDetail": { "type": "object", "properties": { "billOfLadingNumber": { "type": "string", "description": "The number of the carrier shipment acknowledgement document." }, "freightBillNumber": { "type": "array", "items": { "type": "string" }, "description": "The number associated with the freight bill." } } }, "spdTrackingDetail": { "type": "object", "properties": { "spdTrackingItems": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "trackingId": { "type": "string", "description": "The tracking ID associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment." }, "trackingNumberValidationStatus": { "type": "string", "description": "Indicates whether Amazon has validated the tracking number. Because shipment validation is asynchronous, tracking IDs might not be validated immediately, and the status might change after a few hours. If more than 24 hours have passed and the status is not yet 'VALIDATED' or `NOT_SUPPORTED`, verify the number and update it if necessary. **Possible values:** `VALIDATED`, `NOT_VALIDATED`, `NOT_SUPPORTED` (Amazon is unable to find tracking information for the provided tracking ID)." } } }, "description": "List of Small Parcel Delivery (SPD) tracking items." } } } }, "description": "The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`" } }, "required": [ "destination", "placementOptionId", "shipmentId", "source" ] }, "GetShipmentSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "GetSingleReportScheduleParams": { "type": "object", "properties": { "scheduleId": { "type": "string" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "scheduleId", "mp" ] }, "GetSingleReportScheduleResponse": { "type": "object", "properties": { "scheduleId": { "type": "string", "description": "Unique identifier for the schedule." }, "requestSubmissionDate": { "type": "string", "format": "date-time", "description": "The timestamp (date and time) indicating when the report request was submitted." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated." }, "reportVersion": { "type": "string", "description": "Specifies the version of report for which the request is created. Example: v1." }, "reportSummary": { "type": "string", "description": "Provides a brief summary of the report." }, "scheduleStartDate": { "type": "string", "description": "Specifies the start date for the schedule. The date should be in a valid date format (Example: YYYY-MM-DD)." }, "nextScheduledTime": { "type": "string", "description": "The next scheduled time for the report." }, "payload": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ], "description": "Specifies the frequency at which the report should be generated. For example, if set to YEARLY, the report will be generated once every year." }, "repeatsEvery": { "type": "number", "description": "Defines the interval at which the report repeats based on the selected frequency." }, "hour": { "type": "number", "description": "Specifies the hour of the day at which the schedule will be triggered. Allowed values are from 0 to 23, where 0 corresponds to 12:00 AM UTC and 23 corresponds to 11:00 PM UTC. The hour selection is based on the UTC timezone." }, "dayOfMonth": { "type": "number", "description": "Specifies the day of the month on which the schedule will be triggered." }, "dayOfWeek": { "type": "number", "description": "Specifies the day of the week on which the schedule will be triggered. Allowed values are from 0 to 6, where 0 represents Monday and 6 represents Sunday." }, "monthOfYear": { "type": "number", "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." }, "filters": { "type": "object", "properties": { "email": { "type": "string" }, "rowFilters": { "type": "object", "properties": { "type": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } }, "columnName": { "type": "string" } }, "required": [ "type", "values", "columnName" ] } }, "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." } }, "description": "The next scheduled time for the report." }, "requestModifiedTime": { "type": "string", "description": "The date and time when the report schedule was last modified." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } } } }, "GetSingleRequestStatusResponse": { "type": "object", "properties": { "requestId": { "type": "string", "description": "System-generated ID that uniquely identifies the report request." }, "requestStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ], "description": "Filters report requests by status." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated. Example: ITEM for Item Report." }, "reportVersion": { "type": "string", "description": "Version of report for which the request is created. Example, v1." }, "requestSubmissionDate": { "type": "string", "description": "Date and time on which the report request is submitted." }, "payload": { "type": "object", "properties": { "rowFilters": { "type": "array", "items": { "type": "object" } }, "excludeColumns": { "type": "array", "items": { "type": "string" }, "description": "List of columns to exclude from the report." }, "dataStartTime": { "type": "string", "format": "date-time", "description": "Start timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." }, "dataEndTime": { "type": "string", "format": "date-time", "description": "End timestamp for the report data range. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." } }, "description": "Date and time on which the report request is submitted." }, "reportGenerationDate": { "type": "string", "description": "Date and time on which the report is generated. Attribute is available only if report is generated." } }, "required": [ "reportGenerationDate" ] }, "GetSingleRequestStatusSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "GetTaxonomyParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "categories": { "type": "array", "items": { "type": "string" } }, "feedType": { "type": "string", "enum": [ "MP_ITEM_MATCH", "MP_ITEM", "inventory", "PRICE_AND_PROMOTION", "OMNI_WFS", "price" ] }, "version": { "type": "string" } }, "required": [ "categories", "feedType", "version" ] }, "GetTaxonomyResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "itemTaxonomy": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "The name of the Product Category." }, "description": { "type": "string", "description": "The description of the Category." }, "productTypeGroup": { "type": "array", "items": { "type": "object", "properties": { "productTypeGroupName": { "type": "string", "description": "The name of the specific Product Type Group." }, "description": { "type": "string", "description": "The description of the Product Type Group." }, "productType": { "type": "array", "items": { "type": "object", "properties": { "productTypeName": { "type": "string", "description": "The name of the specific Product Type." }, "description": { "type": "string", "description": "The description of the Product Type." } }, "required": [ "productTypeName" ] }, "description": "List of Product Types in a Product Type Group." }, "department": { "type": "array", "items": { "type": "object", "properties": { "departmentName": { "type": "string", "description": "The name of the department." }, "departmentNumber": { "type": "string", "description": "Specifies the number assigned to the department." } } }, "description": "List of departments in a Product Type Group." } }, "required": [ "productTypeGroupName", "productType" ] }, "description": "List of Product Type Groups in a Category." } }, "required": [ "category", "productTypeGroup" ] }, "description": "This contains the Item Taxonomy." }, "status": { "type": "string", "description": "The value SUCCESS is returned when the hierarchy data is retrieved successfully." }, "payload": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "The name of the main item category." }, "subcategory": { "type": "array", "items": { "type": "object", "properties": { "subCategoryName": { "type": "string", "description": "The name of the subcategory." }, "subCategoryId": { "type": "string", "description": "The unique identifier for the subcategory." } } }, "description": "A list of subcategories within the main category." } } }, "description": "The value SUCCESS is returned when the hierarchy data is retrieved successfully." } } }, "GetWfsInventoryDetailsParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "offset": { "type": "number", "description": "Defaults to 0" }, "limit": { "type": "number", "description": "Defaults to 10" }, "sku": { "type": "string", "description": "Defaults to 10" }, "gtin": { "type": "string" } } }, "Id": { "type": "string" }, "ImportedPlan": { "type": "object", "properties": { "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id" }, "plan_id": { "type": "string" }, "flow": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ], "description": "For Walmart plans, this is the inbound_order_id" }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ] }, "ship_from": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "place_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "gtin": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "prep_details": { "type": "object", "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] } }, "required": [ "gtin", "title" ] } }, "pick_list": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "location_name": { "type": "string" }, "quantity": { "type": "number" }, "location_id": { "type": "string", "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] } } }, "required": [ "ship_from", "items" ] }, "ImportedPlanItem": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "gtin": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "prep_details": { "type": "object", "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] } }, "required": [ "gtin", "title" ] }, "ImportInboundPlanParams": { "type": "object", "properties": { "inbound_plan": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "The time at which the inbound plan was created. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`.", "nullable": false }, "inboundPlanId": { "type": "string", "description": "Identifier of an inbound plan.", "nullable": false }, "lastUpdatedAt": { "type": "string", "description": "The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`.", "nullable": false }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace IDs.", "nullable": false }, "name": { "type": "string", "description": "Human-readable name of the inbound plan.", "nullable": false }, "sourceAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information.", "nullable": false }, "addressLine2": { "type": [ "string", "null" ], "description": "Additional street address information." }, "city": { "type": "string", "description": "The city.", "nullable": false }, "companyName": { "type": [ "string", "null" ], "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format.", "nullable": false }, "districtOrCounty": { "type": [ "string", "null" ], "description": "The district or county." }, "email": { "type": [ "string", "null" ], "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact.", "nullable": false }, "phoneNumber": { "type": [ "string", "null" ], "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code.", "nullable": false }, "stateOrProvinceCode": { "type": [ "string", "null" ], "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ], "description": "Human-readable name of the inbound plan.", "nullable": false }, "status": { "type": "string", "description": "The current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`.", "nullable": false } }, "required": [ "createdAt", "inboundPlanId", "lastUpdatedAt", "marketplaceIds", "name", "sourceAddress", "status" ], "nullable": false }, "ship_from_id": { "type": "string", "nullable": false }, "name": { "type": [ "string", "null" ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false } }, "required": [ "inbound_plan", "ship_from_id", "mp" ] }, "ImportInboundPlanResponse": { "type": "object", "properties": { "plan_id": { "type": "string" }, "item_count": { "type": "number" }, "flow": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ], "description": "For Walmart plans, this is the inbound_order_id" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] } } } }, "ImportIntoPlanBody": { "type": "object", "properties": { "from": { "type": "object", "properties": { "purchase_order": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "purchase_order_id": { "type": "string", "nullable": false, "description": "the PO to import items from" }, "skus": { "type": [ "array", "null" ], "items": { "type": "string", "nullable": false }, "description": "omit to import received quantity of all items, otherwise import received quantity of specified skus" } }, "required": [ "purchase_order_id" ] }, "description": "the source of the items" }, "location": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "location_id": { "type": "string", "nullable": false, "description": "the location to import items from" }, "skus": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": [ "number", "null" ], "description": "omit to import all fulfillable quantity" } }, "required": [ "sku" ] }, "description": "omit to import all items from location, otherwise pass specific skus to import" } }, "required": [ "location_id" ] } } }, "description": "required if generating plan for WM", "nullable": false } } }, "ImportIntoPlanResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": {} }, "plans": { "type": "array", "items": { "type": "object", "properties": { "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id" }, "plan_id": { "type": "string" }, "flow": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ], "description": "For Walmart plans, this is the inbound_order_id" }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ] }, "ship_from": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "place_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "gtin": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "prep_details": { "type": "object", "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] } }, "required": [ "gtin", "title" ] } }, "pick_list": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "location_name": { "type": "string" }, "quantity": { "type": "number" }, "location_id": { "type": "string", "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] } } }, "required": [ "ship_from", "items" ] } } } }, "ImportIntoPlanSearchParams": { "type": "object", "properties": { "plan_id": { "type": "string", "description": "pass `plan_id` to add items to an existing plan" }, "plan_name": { "type": "string", "description": "pass `plan_name`, `marketplace_id`, and `ship_from_id` to create a new plan" }, "ship_from_id": { "type": "string", "description": "pass `plan_name`, `marketplace_id`, and `ship_from_id` to create a new plan" }, "location_id": { "type": [ "string", "null" ], "description": "optionally pass this when creating a new plan" }, "delivery_date": { "type": "string", "description": "required if generating plan for WM" }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ] }, "email": { "type": "string", "description": "override sourceAddress.email when creating AZ inbound plans" }, "name": { "type": "string", "description": "override sourceAddress.name when creating AZ inbound plans" }, "phoneNumber": { "type": "string", "description": "override sourceAddress.phoneNumber when creating AZ inbound plans" }, "flow": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ], "description": "override sourceAddress.phoneNumber when creating AZ inbound plans" }, "customPlacement": { "type": "array", "items": { "type": "object", "properties": { "warehouseId": { "type": "string" }, "mskus": { "type": "array", "items": { "type": "string" } } }, "required": [ "warehouseId", "mskus" ] } }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "pass `plan_name`, `marketplace_id`, and `ship_from_id` to create a new plan" } }, "required": [ "mp" ] }, "inbound_plan_flow": { "type": "string", "enum": [ "pack_first", "pack_later" ] }, "inbound_plan_status": { "type": "string", "enum": [ "ACTIVE", "ERRORED", "SHIPPED", "VOIDED" ] }, "InboundPlan": { "type": "object", "properties": { "inbound_plan_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "plan_id": { "type": "string", "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "name": { "type": "string", "nullable": false }, "ship_from_id": { "type": "string", "nullable": false }, "status": { "type": "string", "enum": [ "ACTIVE", "ERRORED", "SHIPPED", "VOIDED" ], "nullable": false }, "operation_id": { "type": "string", "nullable": false }, "operation_status": { "type": "string", "enum": [ "FAILED", "IN_PROGRESS", "SUCCESS" ], "nullable": false }, "operation_problems": { "nullable": false }, "set_packing_information_operation": { "nullable": false }, "generate_packing_options_operation": { "nullable": false }, "generate_placement_options_operation": { "nullable": false }, "generate_shipment_content_update_previews_operation": { "nullable": false }, "generate_delivery_window_options_operation": { "nullable": false }, "generate_self_ship_appointment_slots_operation": { "nullable": false }, "generate_transportation_options_operation": { "nullable": false }, "confirm_transportation_options_operation": { "nullable": false }, "cancel_inbound_plan_operation": { "nullable": false }, "flow": { "type": "string", "enum": [ "pack_first", "pack_later" ], "nullable": false }, "synced": { "type": "string", "format": "date-time", "nullable": false } }, "required": [ "inbound_plan_id", "user_id", "plan_id", "created", "created_by", "updated", "updated_by", "marketplace_id", "name", "ship_from_id", "status", "operation_id", "operation_status", "operation_problems", "set_packing_information_operation", "generate_packing_options_operation", "generate_placement_options_operation", "generate_shipment_content_update_previews_operation", "generate_delivery_window_options_operation", "generate_self_ship_appointment_slots_operation", "generate_transportation_options_operation", "confirm_transportation_options_operation", "cancel_inbound_plan_operation", "flow", "synced" ] }, "InboundPreviewParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "header": { "type": "object", "properties": { "headerAttributes": { "type": "object", "properties": { "buId": { "type": "string", "enum": [ "0" ], "description": "Business unit identifier and must be 0 for US market.", "nullable": false }, "martId": { "type": "string", "enum": [ "0" ], "description": "Market identifier and must be 0 for US market.", "nullable": false } }, "required": [ "buId", "martId" ], "description": "Multi Tenant header attributes", "nullable": false } }, "required": [ "headerAttributes" ], "description": "Request Multi Tenant Header Wrapper", "nullable": false }, "payload": { "type": "object", "properties": { "inboundOrderId": { "type": "string", "description": "Unique identifier used for shipments. Length between 0 and 50", "nullable": false }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "nullable": false }, "addressLine2": { "type": [ "string", "null" ] }, "city": { "type": "string", "nullable": false }, "stateCode": { "type": "string", "nullable": false }, "postalCode": { "type": "string", "nullable": false }, "countryCode": { "type": "string", "nullable": false } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ], "description": "Return address of seller", "nullable": false }, "orderItems": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "description": "Unique ID identifying product", "nullable": false }, "productType": { "type": "string", "enum": [ "GTIN" ], "description": "Supported product types are GTIN", "nullable": false }, "sku": { "type": "string", "description": "Seller Item ID", "nullable": false }, "itemDesc": { "type": "string", "description": "Item description", "nullable": false }, "itemQty": { "type": "number", "description": "Total number of sellable units. ≥ 1", "nullable": false }, "vendorPackQty": { "type": "number", "description": "Total number of cases. ≥ 1", "nullable": false }, "innerPackQty": { "type": "number", "description": "Total number of sellable units per case. ≥ 1", "nullable": false }, "expectedDeliveryDate": { "type": "string", "description": "Expected delivery date for shipment", "nullable": false }, "addOnServices": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "serviceType": { "type": [ "string", "null" ], "enum": [ "LABEL", "BAG", "TAPE", "WRAP" ] } } }, "description": "Indicate whether add-on services (e.g. item labeling or poly bagging) are needed" }, "itemNbr": { "type": [ "number", "null" ], "description": "Indicate whether add-on services (e.g. item labeling or poly bagging) are needed" }, "dimensions": { "type": [ "array", "null" ], "items": { "type": "number" } }, "itemWeightQty": { "type": [ "number", "null" ] }, "nonSortItem": { "type": [ "boolean", "null" ] }, "shipNode": { "type": [ "string", "null" ] } }, "required": [ "productId", "productType", "sku", "itemDesc", "itemQty", "vendorPackQty", "innerPackQty", "expectedDeliveryDate" ] }, "description": "List of Order Items. Length between 1 and 5000", "nullable": false } }, "required": [ "inboundOrderId", "returnAddress", "orderItems" ], "description": "Request Payload", "nullable": false }, "plan_id": { "type": [ "string", "null" ], "description": "Request Payload" } }, "required": [ "header", "payload" ] }, "InboundPreviewResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "payload": { "type": "array", "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "correlationId": { "type": "string" }, "previews": { "type": "array", "items": { "type": "object", "properties": { "previewType": { "type": "string", "enum": [ "inbound", "selfMirroring" ] }, "preview": { "type": "array", "items": { "type": "object", "properties": { "shipNode": { "type": "string" }, "isSortable": { "type": "boolean" }, "isNonSortable": { "type": "boolean" }, "nodeType": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "totalNetTransferCharge": { "type": "number" }, "currencyUnit": { "type": "string" }, "shipmentItems": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] } }, "shippingSummary": { "type": "object", "properties": { "boxes": { "type": "array", "items": {} } }, "required": [ "boxes" ] } }, "required": [ "shipNode", "isSortable", "isNonSortable", "nodeType", "shipToAddress", "totalNetTransferCharge", "currencyUnit", "shipmentItems", "shippingSummary" ] } } }, "required": [ "previewType", "preview" ] } } }, "required": [ "inboundOrderId", "correlationId", "previews" ] } } } }, "InboundPreviewSearchParams": { "type": "object", "properties": { "mp": { "type": "string" } }, "required": [ "mp" ] }, "InsertAttachment": { "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the attached file", "nullable": false }, "content_type": { "type": "string", "nullable": false, "description": "The name of the attached file" }, "file_uri": { "type": "string", "nullable": false, "description": "The MIME type of the attached file" }, "file_data": { "type": "string", "nullable": false, "description": "If the file is hosted externally, this will be a link to that file" }, "file_size": { "type": "number", "nullable": false, "description": "Small files may be stored here" } } }, "InsertAttachmentsParams": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the attached file", "nullable": false }, "content_type": { "type": "string", "nullable": false, "description": "The name of the attached file" }, "file_uri": { "type": "string", "nullable": false, "description": "The MIME type of the attached file" }, "file_data": { "type": "string", "nullable": false, "description": "If the file is hosted externally, this will be a link to that file" }, "file_size": { "type": "number", "nullable": false, "description": "Small files may be stored here" } } }, "nullable": false } }, "required": [ "attachments" ] }, "InsertAttachmentsResponse": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "type": "object", "properties": { "attachment_id": { "type": "string" }, "user_id": { "type": "string" }, "file_name": { "type": "string", "description": "The name of the attached file" }, "content_type": { "type": [ "string", "null" ], "description": "The name of the attached file" }, "file_uri": { "type": [ "string", "null" ], "description": "The MIME type of the attached file" }, "file_data": { "type": [ "string", "null" ], "description": "If the file is hosted externally, this will be a link to that file" }, "file_size": { "type": [ "number", "null" ], "description": "Small files may be stored here" }, "created": { "type": "string", "format": "date-time", "description": "The size of the attached file in bytes" }, "created_by": { "type": [ "string", "null" ] } }, "required": [ "attachment_id", "user_id", "file_name", "content_type", "file_uri", "file_data", "file_size", "created", "created_by" ] } } }, "required": [ "attachments" ] }, "InsertAzBox": { "type": "object", "properties": { "box_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "shipment_id": { "type": "string", "nullable": false }, "plan_id": { "type": "string", "nullable": false }, "pallet_id": { "type": "number", "nullable": false }, "index": { "type": "number", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "tracking_id": { "type": "string", "nullable": false }, "inbound_plan_id": { "type": "string", "nullable": false }, "packing_option_id": { "type": "string", "nullable": false }, "packing_group_id": { "type": "string", "nullable": false }, "package_id": { "type": "string", "nullable": false }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "nullable": false }, "print_box_label_quantity": { "type": "number", "nullable": false }, "length": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ], "nullable": false }, "weight": { "type": "number", "nullable": false }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ], "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "pack_template_id": { "type": [ "string", "null" ] }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "box_item_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "box_id": { "type": "number", "nullable": false }, "expires": { "type": "string", "format": "date-time", "nullable": false }, "external_id": { "type": "string", "nullable": false }, "sku": { "type": "string", "nullable": false }, "fnsku": { "type": "string", "nullable": false }, "label_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ], "nullable": false }, "prep_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ], "nullable": false }, "manufacturing_lot_code": { "type": "string", "nullable": false }, "prep_instructions": { "nullable": false }, "quantity": { "type": "number", "nullable": false }, "packing_group_id": { "type": "string", "nullable": false }, "plan_item_id": { "type": "number", "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "archived": { "type": "string", "format": "date-time", "nullable": false }, "archived_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false } } } } } }, "InsertAzBoxesParams": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "box_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "shipment_id": { "type": "string", "nullable": false }, "plan_id": { "type": "string", "nullable": false }, "pallet_id": { "type": "number", "nullable": false }, "index": { "type": "number", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "tracking_id": { "type": "string", "nullable": false }, "inbound_plan_id": { "type": "string", "nullable": false }, "packing_option_id": { "type": "string", "nullable": false }, "packing_group_id": { "type": "string", "nullable": false }, "package_id": { "type": "string", "nullable": false }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "nullable": false }, "print_box_label_quantity": { "type": "number", "nullable": false }, "length": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ], "nullable": false }, "weight": { "type": "number", "nullable": false }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ], "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "pack_template_id": { "type": [ "string", "null" ] }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "box_item_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "box_id": { "type": "number", "nullable": false }, "expires": { "type": "string", "format": "date-time", "nullable": false }, "external_id": { "type": "string", "nullable": false }, "sku": { "type": "string", "nullable": false }, "fnsku": { "type": "string", "nullable": false }, "label_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ], "nullable": false }, "prep_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ], "nullable": false }, "manufacturing_lot_code": { "type": "string", "nullable": false }, "prep_instructions": { "nullable": false }, "quantity": { "type": "number", "nullable": false }, "packing_group_id": { "type": "string", "nullable": false }, "plan_item_id": { "type": "number", "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "archived": { "type": "string", "format": "date-time", "nullable": false }, "archived_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false } } } } } }, "nullable": false } }, "required": [ "boxes" ] }, "InsertAzBoxesResponse": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "box_id": { "type": "string" }, "user_id": { "type": "string" }, "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "pallet_id": { "type": [ "number", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "tracking_id": { "type": [ "string", "null" ] }, "inbound_plan_id": { "type": [ "string", "null" ] }, "packing_option_id": { "type": [ "string", "null" ] }, "packing_group_id": { "type": [ "string", "null" ] }, "package_id": { "type": [ "string", "null" ] }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ] }, "print_box_label_quantity": { "type": "number" }, "length": { "type": [ "number", "null" ] }, "width": { "type": [ "number", "null" ] }, "height": { "type": [ "number", "null" ] }, "unit_of_measurement": { "type": [ "string", "null" ], "enum": [ "CM", "IN" ] }, "weight": { "type": [ "number", "null" ] }, "unit_of_weight": { "type": [ "string", "null" ], "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "box_id", "user_id", "shipment_id", "plan_id", "pallet_id", "index", "quantity", "tracking_id", "inbound_plan_id", "packing_option_id", "packing_group_id", "package_id", "content_information_source", "print_box_label_quantity", "length", "width", "height", "unit_of_measurement", "weight", "unit_of_weight", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by" ] } } }, "required": [ "boxes" ] }, "InsertAzPalletsParams": { "type": "object", "properties": { "pallets": { "type": "array", "items": { "type": "object", "properties": { "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ] }, "inbound_plan_id": { "type": "string" }, "placement_option_id": { "type": [ "string", "null" ] }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": "number" }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ] }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] } } } }, "shipment_id": { "type": [ "string", "null" ] }, "placement_option_id": { "type": [ "string", "null" ] }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ] }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ] } }, "required": [ "pallets" ] }, "InsertAzPalletsResponse": { "type": "object", "properties": { "pallets": { "type": "array", "items": { "type": "object", "properties": { "pallet_id": { "type": "number" }, "user_id": { "type": "string" }, "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ] }, "inbound_plan_id": { "type": "string" }, "placement_option_id": { "type": [ "string", "null" ] }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": "number" }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "pallet_id", "user_id", "shipment_id", "plan_id", "index", "quantity", "stackability", "inbound_plan_id", "placement_option_id", "length", "width", "height", "unit_of_measurement", "weight", "unit_of_weight", "created", "created_by", "creation_source", "updated", "updated_by", "deleted", "deleted_by" ] } } }, "required": [ "pallets" ] }, "InsertBundleParams": { "type": "object", "properties": { "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "input_sku": { "type": "string", "nullable": false }, "output_sku": { "type": "string", "nullable": false }, "input_quantity": { "type": "number", "nullable": false }, "output_quantity": { "type": "number", "nullable": false } } }, "nullable": false } }, "required": [ "items" ] }, "InsertBundleResponse": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "bundle_item_id": { "type": "string" }, "bundle_id": { "type": "string" }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } } } } } } } }, "InsertBundlesBody": { "type": "object", "properties": { "bundles": { "type": "array", "items": { "type": "object", "properties": { "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "input_sku": { "type": "string", "nullable": false }, "output_sku": { "type": "string", "nullable": false }, "input_quantity": { "type": "number", "nullable": false }, "output_quantity": { "type": "number", "nullable": false } } }, "nullable": false } } }, "nullable": false } }, "required": [ "bundles" ] }, "InsertBundlesResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "number" }, "data": {}, "message": { "type": "string" } }, "required": [ "message" ] } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "bundle_item_id": { "type": "string" }, "bundle_id": { "type": "string" }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } } } } } } } } } } }, "InsertedPackTemplate": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "owner": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": [ "number", "null" ] }, "unit_of_weight": { "type": [ "string", "null" ], "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } } } } } }, "InsertLocation": { "type": "object", "properties": { "location_name": { "type": "string", "nullable": false }, "location_type": { "type": "string", "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ], "nullable": false }, "description": { "type": [ "string", "null" ] }, "ship_from_id": { "type": [ "string", "null" ], "description": "Required if ship_from_id is not specified in params" } } }, "InsertLocationsParams": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "location_name": { "type": "string", "nullable": false }, "location_type": { "type": "string", "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ], "nullable": false }, "description": { "type": [ "string", "null" ] }, "ship_from_id": { "type": [ "string", "null" ], "description": "Required if ship_from_id is not specified in params" } } }, "nullable": false }, "ship_from_id": { "type": [ "string", "null" ], "description": "Required if ship_from_id is not specified per location" } }, "required": [ "locations" ] }, "InsertLocationsResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "number" }, "data": {}, "message": { "type": "string" } }, "required": [ "message" ] } }, "locations": { "type": "array", "items": { "type": "object", "properties": { "location_id": { "type": "string" }, "user_id": { "type": "string" }, "location_name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "location_type": { "type": "string", "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ] }, "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "location_id", "user_id", "location_name", "description", "location_type", "ship_from_id", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by" ] } } } }, "InsertMapping": { "type": "object", "properties": { "bundle_id": { "type": [ "string", "null" ], "description": "Set if the input_value refers to a SKU from a bundle" }, "input_value": { "type": "string", "description": "Set if the input_value refers to a SKU from a bundle" }, "output_value": { "type": "string", "description": "When mapping_type = inventory, this is the internal sku, otherwise it is an arbitrary string" }, "mapping_type": { "type": "string", "enum": [ "inventory", "product" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)" } } }, "InsertMappingsParams": { "type": "object", "properties": { "mapping_type": { "type": "string", "enum": [ "inventory", "product" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)" }, "mappings": { "type": "array", "items": { "type": "object", "properties": { "bundle_id": { "type": [ "string", "null" ], "description": "Set if the input_value refers to a SKU from a bundle" }, "input_value": { "type": "string", "description": "Set if the input_value refers to a SKU from a bundle" }, "output_value": { "type": "string", "description": "When mapping_type = inventory, this is the internal sku, otherwise it is an arbitrary string" }, "mapping_type": { "type": "string", "enum": [ "inventory", "product" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)" } } } } }, "required": [ "mappings" ] }, "InsertMappingsResponse": { "type": "array", "items": { "type": "object", "properties": { "mapping_id": { "type": "string" }, "user_id": { "type": "string" }, "mapping_type": { "type": "string", "enum": [ "inventory", "product" ] }, "bundle_id": { "type": [ "string", "null" ], "description": "Set if the input_value refers to a SKU from a bundle" }, "input_value": { "type": "string", "description": "Set if the input_value refers to a SKU from a bundle" }, "output_value": { "type": "string", "description": "When mapping_type = inventory, this is the internal sku, otherwise it is an arbitrary string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)" } }, "required": [ "mapping_id", "user_id", "mapping_type", "bundle_id", "input_value", "output_value", "marketplace_id" ] } }, "InsertMappingsSearchParams": { "type": "object", "properties": { "mapping_type": { "type": "string", "enum": [ "inventory", "product" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)" } } }, "InsertPackTemplate": { "type": "object", "properties": { "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center", "nullable": false }, "length": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ], "nullable": false }, "weight": { "type": "number", "nullable": false }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ], "nullable": false }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false } } } } } }, "InsertPackTemplateItem": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false } } }, "InsertPackTemplateItemBody": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false } } }, "nullable": false } } }, "InsertPackTemplateItemsParams": { "type": "object", "properties": { "pack_template_id": { "type": "string", "nullable": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false } } }, "nullable": false } }, "required": [ "pack_template_id", "items" ] }, "InsertPackTemplateItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "quantity": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "pack_template_id", "user_id", "sku", "quantity", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by" ] } } }, "required": [ "items" ] }, "InsertPackTemplatesParams": { "type": "object", "properties": { "pack_templates": { "type": "array", "items": { "type": "object", "properties": { "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center", "nullable": false }, "length": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ], "nullable": false }, "weight": { "type": "number", "nullable": false }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ], "nullable": false }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false } } } } } }, "nullable": false } }, "required": [ "pack_templates" ] }, "InsertPackTemplatesResponse": { "type": "object", "properties": { "pack_templates": { "type": "array", "items": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "owner": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": [ "number", "null" ] }, "unit_of_weight": { "type": [ "string", "null" ], "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } } } } } } } }, "required": [ "pack_templates" ] }, "InsertPlanItem": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "quantity_in_case": { "type": "number", "nullable": false }, "item_prep": { "type": "object", "properties": { "addOnServices": { "type": [ "object", "null" ], "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": [ "object", "null" ] }, "prepOwner": { "type": [ "object", "null" ] }, "prepInstructions": { "type": [ "array", "null" ], "items": { "type": "object" } }, "label_type": { "type": [ "string", "null" ] }, "prep_category": { "type": [ "string", "null" ] } }, "nullable": false, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false } }, "required": [ "tag_name" ] } } } }, "InsertPlanItemsBody": { "type": "object", "properties": { "plan_items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "quantity_in_case": { "type": "number", "nullable": false }, "item_prep": { "type": "object", "properties": { "addOnServices": { "type": [ "object", "null" ], "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": [ "object", "null" ] }, "prepOwner": { "type": [ "object", "null" ] }, "prepInstructions": { "type": [ "array", "null" ], "items": { "type": "object" } }, "label_type": { "type": [ "string", "null" ] }, "prep_category": { "type": [ "string", "null" ] } }, "nullable": false, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false } }, "required": [ "tag_name" ] } } } }, "nullable": false } }, "required": [ "plan_items" ] }, "InsertPlanItemsResponse": { "type": "object", "properties": { "plan_items": { "type": "array", "items": { "type": "object", "properties": {} } } }, "required": [ "plan_items" ] }, "InsertPlanItemsSearchParams": { "type": "object", "properties": { "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] } } }, "InsertPlanParams": { "type": "object", "properties": { "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "ship_from_id": { "type": "string", "nullable": false }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ], "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false, "description": "The method by which the plan was created" }, "errors": { "nullable": false, "description": "The method by which the plan was created" }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id", "nullable": false }, "flow": { "type": "string", "enum": [ "pack_first", "pack_later" ], "nullable": false, "description": "For Walmart plans, this is the inbound_order_id" }, "location_id": { "type": "string", "nullable": false }, "pick_list": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "location_name": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "location_id": { "type": [ "string", "null" ], "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] }, "nullable": false }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "nullable": false, "description": "When PO items are imported into a plan, this is a list of what locations in the warehouse contain the imported items." }, "prep_matrix_type": { "type": "string", "nullable": false }, "prep_matrix_price": { "type": "number", "nullable": false }, "prep_matrix_currency_code": { "type": "string", "nullable": false }, "expected_delivery_date": { "type": "string", "format": "date-time", "nullable": false }, "data": { "type": "object", "properties": { "email": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "phoneNumber": { "type": [ "string", "null" ] }, "customPlacement": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "warehouseId": { "type": "string", "nullable": false }, "mskus": { "type": "array", "items": { "type": "string" }, "nullable": false } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": [ "string", "null" ], "description": "Expected delivery date for shipment" } }, "nullable": false, "description": "Data used to generate WM Inbound Preview or AZ Inbound Plan" }, "plan_items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "quantity_in_case": { "type": "number", "nullable": false }, "item_prep": { "type": "object", "properties": { "addOnServices": { "type": [ "object", "null" ], "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": [ "object", "null" ] }, "prepOwner": { "type": [ "object", "null" ] }, "prepInstructions": { "type": [ "array", "null" ], "items": { "type": "object" } }, "label_type": { "type": [ "string", "null" ] }, "prep_category": { "type": [ "string", "null" ] } }, "nullable": false, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false } }, "required": [ "tag_name" ] } } } } } }, "required": [ "marketplace_id", "ship_from_id" ] }, "InsertPlanResponse": { "type": "object", "properties": { "plan_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": "string" }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the plan was created" }, "errors": { "anyOf": [ { "description": "The method by which the plan was created" }, { "type": "null" } ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id" }, "flow": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ], "description": "For Walmart plans, this is the inbound_order_id" }, "location_id": { "type": [ "string", "null" ] }, "pick_list": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string" }, "location_name": { "type": "string" }, "quantity": { "type": "number" }, "location_id": { "type": "string", "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] } }, "content_information_source": { "type": [ "string", "null" ], "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "description": "When PO items are imported into a plan, this is a list of what locations in the warehouse contain the imported items." }, "status": { "type": "string", "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ] }, "prep_matrix_type": { "type": [ "string", "null" ] }, "prep_matrix_price": { "type": [ "number", "null" ] }, "prep_matrix_currency_code": { "type": [ "string", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "type": [ "object", "null" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "customPlacement": { "type": "array", "items": { "type": "object", "properties": { "warehouseId": { "type": "string" }, "mskus": { "type": "array", "items": { "type": "string" } } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": "string", "description": "Expected delivery date for shipment" } }, "description": "Data used to generate WM Inbound Preview or AZ Inbound Plan" }, "skus": { "type": "number" }, "units": { "type": "number" }, "ship_from": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "place_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" } }, "required": [ "plan_item_id", "plan_id", "user_id", "sku", "marketplace_id", "quantity", "creation_source", "errors", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by", "expires", "cost", "supplier_id", "lot_code", "packing_group_ids", "print_fnsku_label_quantity", "quantity_in_case", "item_prep" ] } } }, "required": [ "skus", "units", "ship_from" ] }, "InsertPlansParams": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "ship_from_id": { "type": "string", "nullable": false }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ], "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false, "description": "The method by which the plan was created" }, "errors": { "nullable": false, "description": "The method by which the plan was created" }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id", "nullable": false }, "flow": { "type": "string", "enum": [ "pack_first", "pack_later" ], "nullable": false, "description": "For Walmart plans, this is the inbound_order_id" }, "location_id": { "type": "string", "nullable": false }, "pick_list": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "location_name": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "location_id": { "type": [ "string", "null" ], "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] }, "nullable": false }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "nullable": false, "description": "When PO items are imported into a plan, this is a list of what locations in the warehouse contain the imported items." }, "prep_matrix_type": { "type": "string", "nullable": false }, "prep_matrix_price": { "type": "number", "nullable": false }, "prep_matrix_currency_code": { "type": "string", "nullable": false }, "expected_delivery_date": { "type": "string", "format": "date-time", "nullable": false }, "data": { "type": "object", "properties": { "email": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "phoneNumber": { "type": [ "string", "null" ] }, "customPlacement": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "warehouseId": { "type": "string", "nullable": false }, "mskus": { "type": "array", "items": { "type": "string" }, "nullable": false } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": [ "string", "null" ], "description": "Expected delivery date for shipment" } }, "nullable": false, "description": "Data used to generate WM Inbound Preview or AZ Inbound Plan" }, "plan_items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "quantity_in_case": { "type": "number", "nullable": false }, "item_prep": { "type": "object", "properties": { "addOnServices": { "type": [ "object", "null" ], "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": [ "object", "null" ] }, "prepOwner": { "type": [ "object", "null" ] }, "prepInstructions": { "type": [ "array", "null" ], "items": { "type": "object" } }, "label_type": { "type": [ "string", "null" ] }, "prep_category": { "type": [ "string", "null" ] } }, "nullable": false, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false } }, "required": [ "tag_name" ] } } } } } }, "required": [ "marketplace_id", "ship_from_id" ] }, "nullable": false } }, "required": [ "plans" ] }, "InsertPlansResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "number" }, "data": {}, "message": { "type": "string" } }, "required": [ "message" ] } }, "plans": { "type": "array", "items": { "type": "object", "properties": { "plan_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": "string" }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the plan was created" }, "errors": { "anyOf": [ { "description": "The method by which the plan was created" }, { "type": "null" } ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id" }, "flow": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ], "description": "For Walmart plans, this is the inbound_order_id" }, "location_id": { "type": [ "string", "null" ] }, "pick_list": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string" }, "location_name": { "type": "string" }, "quantity": { "type": "number" }, "location_id": { "type": "string", "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] } }, "content_information_source": { "type": [ "string", "null" ], "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "description": "When PO items are imported into a plan, this is a list of what locations in the warehouse contain the imported items." }, "status": { "type": "string", "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ] }, "prep_matrix_type": { "type": [ "string", "null" ] }, "prep_matrix_price": { "type": [ "number", "null" ] }, "prep_matrix_currency_code": { "type": [ "string", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "type": [ "object", "null" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "customPlacement": { "type": "array", "items": { "type": "object", "properties": { "warehouseId": { "type": "string" }, "mskus": { "type": "array", "items": { "type": "string" } } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": "string", "description": "Expected delivery date for shipment" } }, "description": "Data used to generate WM Inbound Preview or AZ Inbound Plan" }, "skus": { "type": "number" }, "units": { "type": "number" }, "ship_from": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "place_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" } }, "required": [ "plan_item_id", "plan_id", "user_id", "sku", "marketplace_id", "quantity", "creation_source", "errors", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by", "expires", "cost", "supplier_id", "lot_code", "packing_group_ids", "print_fnsku_label_quantity", "quantity_in_case", "item_prep" ] } } }, "required": [ "skus", "units", "ship_from" ] } } } }, "InsertProxyeesParams": { "type": "object", "properties": { "client_ids": { "type": "array", "items": { "type": "string", "nullable": false }, "nullable": false } }, "required": [ "client_ids" ] }, "InsertPurchaseOrderItemsBody": { "type": "object", "properties": { "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "gtin": { "type": "string", "nullable": false }, "condition_id": { "type": "number", "description": "The GTIN of the item", "nullable": false }, "notes": { "type": "string", "nullable": false }, "shopper": { "type": "string", "nullable": false }, "supplier_id": { "type": "number", "nullable": false }, "purchased": { "type": "string", "format": "date-time", "nullable": false }, "price": { "type": "number", "nullable": false }, "cost": { "type": "number", "nullable": false }, "expires": { "type": "string", "format": "date-time", "nullable": false }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received.", "nullable": false }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received.", "nullable": false }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item.", "nullable": false }, "missing": { "type": "number", "description": "Any damaged quantity", "nullable": false }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities", "nullable": false }, "lot_code": { "type": "string", "nullable": false }, "intent": { "type": "object", "properties": { "marketplace": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "external_id": { "type": [ "string", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "quantity": { "type": [ "number", "null" ] } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": [ "array", "null" ], "items": { "type": "object" } } }, "nullable": false, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_id": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false } } } }, "sku": { "type": "string", "nullable": false }, "condition_name": { "type": [ "string", "null" ] }, "supplier": { "type": [ "string", "null" ] }, "set_ordered": { "type": [ "number", "null" ] }, "set_received": { "type": [ "number", "null" ] }, "set_damaged": { "type": [ "number", "null" ] }, "set_missing": { "type": [ "number", "null" ] }, "set_not_ordered": { "type": [ "number", "null" ] }, "delete": { "type": [ "boolean", "null" ] } }, "required": [ "sku" ] }, "nullable": false } }, "required": [ "purchase_order_items" ] }, "InsertPurchaseOrderItemsSearchParams": { "type": "object", "properties": { "purchased": { "type": "string", "format": "date-time" } } }, "InsertPurchaseOrderParams": { "type": "object", "properties": { "purchase_order_id": { "type": "string", "nullable": false }, "purchase_order_name": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "ship_from_id": { "type": "string", "description": "The ID of the supplier.", "nullable": false }, "created": { "type": "string", "format": "date-time", "description": "The ID of the supplier.", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_status": { "type": [ "string", "null" ], "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "archived": { "type": "string", "format": "date-time", "nullable": false }, "archived_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view", "nullable": false }, "expected_delivery_date": { "type": "string", "format": "date-time", "nullable": false, "description": "A transitional column marking this PO created in the WFS plan view" }, "supplier": { "type": [ "string", "null" ] }, "attachment": { "type": [ "object", "null" ], "properties": { "attachment_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "file_name": { "type": "string", "description": "The name of the attached file", "nullable": false }, "content_type": { "type": "string", "nullable": false, "description": "The name of the attached file" }, "file_uri": { "type": "string", "nullable": false, "description": "The MIME type of the attached file" }, "file_data": { "type": "string", "nullable": false, "description": "If the file is hosted externally, this will be a link to that file" }, "file_size": { "type": "number", "nullable": false, "description": "Small files may be stored here" }, "created": { "type": "string", "format": "date-time", "description": "The size of the attached file in bytes", "nullable": false }, "created_by": { "type": "string", "nullable": false } }, "required": [ "attachment_id", "user_id", "file_name", "content_type", "file_uri", "file_data", "file_size", "created", "created_by" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false } }, "required": [ "tag_name" ] } }, "purchase_order_items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "gtin": { "type": "string", "nullable": false }, "condition_id": { "type": "number", "description": "The GTIN of the item", "nullable": false }, "notes": { "type": "string", "nullable": false }, "shopper": { "type": "string", "nullable": false }, "supplier_id": { "type": "number", "nullable": false }, "purchased": { "type": "string", "format": "date-time", "nullable": false }, "price": { "type": "number", "nullable": false }, "cost": { "type": "number", "nullable": false }, "expires": { "type": "string", "format": "date-time", "nullable": false }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received.", "nullable": false }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received.", "nullable": false }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item.", "nullable": false }, "missing": { "type": "number", "description": "Any damaged quantity", "nullable": false }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities", "nullable": false }, "lot_code": { "type": "string", "nullable": false }, "intent": { "type": "object", "properties": { "marketplace": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "external_id": { "type": [ "string", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "quantity": { "type": [ "number", "null" ] } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": [ "array", "null" ], "items": { "type": "object" } } }, "nullable": false, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_id": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false } } } }, "sku": { "type": "string", "nullable": false }, "condition_name": { "type": [ "string", "null" ] }, "supplier": { "type": [ "string", "null" ] }, "set_ordered": { "type": [ "number", "null" ] }, "set_received": { "type": [ "number", "null" ] }, "set_damaged": { "type": [ "number", "null" ] }, "set_missing": { "type": [ "number", "null" ] }, "set_not_ordered": { "type": [ "number", "null" ] }, "delete": { "type": [ "boolean", "null" ] } }, "required": [ "sku" ] } } }, "required": [ "purchase_order_name", "ship_from_id" ] }, "InsertPurchaseOrderResponse": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "purchase_order_name": { "type": "string" }, "user_id": { "type": "string" }, "ship_from_id": { "type": "string", "description": "The ID of the supplier." }, "created": { "type": "string", "format": "date-time", "description": "The ID of the supplier." }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_status": { "type": "string", "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view" }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time", "description": "A transitional column marking this PO created in the WFS plan view" }, "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_item_id": { "type": "string" }, "user_id": { "type": "string" }, "purchase_order_id": { "type": "string" }, "gtin": { "type": "string" }, "condition_id": { "type": "number", "description": "The GTIN of the item" }, "sku": { "type": "string" }, "notes": { "type": [ "string", "null" ] }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item." }, "missing": { "type": "number", "description": "Any damaged quantity" }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities" }, "intent": { "type": [ "object", "null" ], "properties": { "marketplace": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": "array", "items": { "type": "object" } } }, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "shopper": { "type": [ "string", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "purchased": { "type": "string", "format": "date-time" }, "price": { "type": [ "number", "null" ] }, "cost": { "type": [ "number", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "product_tax_code": { "type": [ "string", "null" ], "enum": [ "A_AUTOMOTIVE_MOTOROIL", "A_BABY_BRSTPUMP", "A_BABY_CARSEAT", "A_BABY_CLOTH", "A_BABY_DIAPER", "A_BOOKS_GEN", "A_BOOKS_RELIG", "A_BOOKS_RENTAL", "A_BUNDLE_PERDCL", "A_CLSFD_52W-4Q", "A_CLSFD_52WKLY", "A_CLSFD_ANNUAL", "A_CLSFD_SEMIANNL", "A_CLTH_ATHL", "A_CLTH_BATH", "A_CLTH_BOOKBAG", "A_CLTH_BUCKLS", "A_CLTH_COMPON", "A_CLTH_CSTUMS", "A_CLTH_FORMAL", "A_CLTH_FUR", "A_CLTH_GEN", "A_CLTH_HAIRACCESSORIES", "A_CLTH_HANDKE", "A_CLTH_HBAGS", "A_CLTH_IFUR", "A_CLTH_PROTECTIVE", "A_CLTH_UMBRELLA", "A_COLLECTIBLE_COIN", "A_COMP_COMPUTER", "A_COMP_EDUSOFT", "A_COMP_GAMPER", "A_COMP_PDA", "A_COMP_PERIPH", "A_COMP_PRINT", "A_COMP_PRTSUP", "A_COMP_SCANNER", "A_COMP_SOFTOP", "A_COMP_SOFTRC", "A_COMP_STORAGEMEDIA", "A_EGOODS_DIGITALAUDIOBOOKS", "A_EGOODS_DIGITALBOOKS", "A_EGOODS_DIGITALBOOK_RENTAL", "A_EGOODS_DIGITALGAMES", "A_EGOODS_DIGITALMUSIC", "A_EGOODS_DIGITALNEWS", "A_EGOODS_DIGITALNEWSSUBS", "A_EGOODS_DIGITALPERDCL", "A_EGOODS_DIGITALPERDCLSUBS", "A_EGOODS_MISC1", "A_EGOODS_ONLINEGAMINGSUBS", "A_EGOODS_SOFT", "A_EMERGENCY_SUPPLIES", "A_FOOD_BKTCDY50-90", "A_FOOD_BKTGN50-75", "A_FOOD_BKTGN76-90", "A_FOOD_CARBSFTDK", "A_FOOD_CARBWTR", "A_FOOD_CNDY", "A_FOOD_CNDYFL", "A_FOOD_GEN", "A_FOOD_JUICE0-50", "A_FOOD_JUICE51-99", "A_FOOD_NCARBWTR", "A_FOOD_PETFOOD", "A_FOOD_WINE", "A_GEN_NOTAX", "A_GEN_RENTAL", "A_GEN_TAX", "A_HLTH_BABYSUPPLS", "A_HLTH_BANDKIT", "A_HLTH_CONTACTSOLN", "A_HLTH_CONTRCEPV", "A_HLTH_COSMETIC", "A_HLTH_DIABSUPPLS", "A_HLTH_DIETSUPMT", "A_HLTH_DISPOSABLE_PACK", "A_HLTH_FAMPLANTEST", "A_HLTH_FEMHYG", "A_HLTH_HEARINGAID_BATT", "A_HLTH_INCONT", "A_HLTH_MEDHAIRLOSS", "A_HLTH_MOBILITY", "A_HLTH_MONITOR", "A_HLTH_OTCMED", "A_HLTH_PROSTHETIC", "A_HLTH_SPFCORALHYG", "A_HLTH_SPFCOTCMED", "A_HLTH_SUNSCRN", "A_HLTH_THRMTR", "A_HLTH_TISSUETOW", "A_HLTH_TOOTHPASTEFL", "A_HOUSEHOLD_LINEN", "A_HOUSEHOLD_PAPERPRODS", "A_NEWS_104PLUS", "A_NEWS_12MTHLY", "A_NEWS_26BIWKLY", "A_NEWS_4QTLY", "A_NEWS_52WKLY", "A_PERDCL_104PLUS", "A_PERDCL_52W-4Q", "A_PERDCL_52WKLY", "A_PERDCL_ANNUAL", "A_PERDCL_SEMIANNL", "A_SCHL_GRAPHCALC", "A_SCHL_INSTRUMENT", "A_SCHL_SUPPLS", "A_SERV_INSTALL", "A_SPORT_ASUPPORT", "A_SPORT_ATHLSHOES", "A_SPORT_BIKEHLMT", "A_SPORT_MISCSPORTS1", "A_SPORT_SKISUIT", "A_SPORT_WINTERSPORTBOOTS", "A_WARR_PARTSNSRVC", "A_WARR_PARTSNSVCE" ], "description": "Amazon's product tax code identifier" }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "Amazon's product tax code identifier" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "condition_name": { "type": "string" } }, "required": [ "condition_name" ] } } } }, "InsertPurchaseOrdersBody": { "type": "object", "properties": { "purchase_orders": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_id": { "type": "string", "nullable": false }, "purchase_order_name": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "ship_from_id": { "type": "string", "description": "The ID of the supplier.", "nullable": false }, "created": { "type": "string", "format": "date-time", "description": "The ID of the supplier.", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_status": { "type": [ "string", "null" ], "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "archived": { "type": "string", "format": "date-time", "nullable": false }, "archived_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view", "nullable": false }, "expected_delivery_date": { "type": "string", "format": "date-time", "nullable": false, "description": "A transitional column marking this PO created in the WFS plan view" }, "supplier": { "type": [ "string", "null" ] }, "attachment": { "type": [ "object", "null" ], "properties": { "attachment_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "file_name": { "type": "string", "description": "The name of the attached file", "nullable": false }, "content_type": { "type": "string", "nullable": false, "description": "The name of the attached file" }, "file_uri": { "type": "string", "nullable": false, "description": "The MIME type of the attached file" }, "file_data": { "type": "string", "nullable": false, "description": "If the file is hosted externally, this will be a link to that file" }, "file_size": { "type": "number", "nullable": false, "description": "Small files may be stored here" }, "created": { "type": "string", "format": "date-time", "description": "The size of the attached file in bytes", "nullable": false }, "created_by": { "type": "string", "nullable": false } }, "required": [ "attachment_id", "user_id", "file_name", "content_type", "file_uri", "file_data", "file_size", "created", "created_by" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false } }, "required": [ "tag_name" ] } }, "purchase_order_items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "gtin": { "type": "string", "nullable": false }, "condition_id": { "type": "number", "description": "The GTIN of the item", "nullable": false }, "notes": { "type": "string", "nullable": false }, "shopper": { "type": "string", "nullable": false }, "supplier_id": { "type": "number", "nullable": false }, "purchased": { "type": "string", "format": "date-time", "nullable": false }, "price": { "type": "number", "nullable": false }, "cost": { "type": "number", "nullable": false }, "expires": { "type": "string", "format": "date-time", "nullable": false }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received.", "nullable": false }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received.", "nullable": false }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item.", "nullable": false }, "missing": { "type": "number", "description": "Any damaged quantity", "nullable": false }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities", "nullable": false }, "lot_code": { "type": "string", "nullable": false }, "intent": { "type": "object", "properties": { "marketplace": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "external_id": { "type": [ "string", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "quantity": { "type": [ "number", "null" ] } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": [ "array", "null" ], "items": { "type": "object" } } }, "nullable": false, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_id": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false } } } }, "sku": { "type": "string", "nullable": false }, "condition_name": { "type": [ "string", "null" ] }, "supplier": { "type": [ "string", "null" ] }, "set_ordered": { "type": [ "number", "null" ] }, "set_received": { "type": [ "number", "null" ] }, "set_damaged": { "type": [ "number", "null" ] }, "set_missing": { "type": [ "number", "null" ] }, "set_not_ordered": { "type": [ "number", "null" ] }, "delete": { "type": [ "boolean", "null" ] } }, "required": [ "sku" ] } } }, "required": [ "purchase_order_name", "ship_from_id" ] }, "nullable": false } }, "required": [ "purchase_orders" ] }, "InsertPurchaseOrdersResponse": { "type": "object", "properties": { "purchase_orders": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "purchase_order_name": { "type": "string" }, "user_id": { "type": "string" }, "ship_from_id": { "type": "string", "description": "The ID of the supplier." }, "created": { "type": "string", "format": "date-time", "description": "The ID of the supplier." }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_status": { "type": "string", "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view" }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time", "description": "A transitional column marking this PO created in the WFS plan view" }, "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_item_id": { "type": "string" }, "user_id": { "type": "string" }, "purchase_order_id": { "type": "string" }, "gtin": { "type": "string" }, "condition_id": { "type": "number", "description": "The GTIN of the item" }, "sku": { "type": "string" }, "notes": { "type": [ "string", "null" ] }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item." }, "missing": { "type": "number", "description": "Any damaged quantity" }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities" }, "intent": { "type": [ "object", "null" ], "properties": { "marketplace": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": "array", "items": { "type": "object" } } }, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "shopper": { "type": [ "string", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "purchased": { "type": "string", "format": "date-time" }, "price": { "type": [ "number", "null" ] }, "cost": { "type": [ "number", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "product_tax_code": { "type": [ "string", "null" ], "enum": [ "A_AUTOMOTIVE_MOTOROIL", "A_BABY_BRSTPUMP", "A_BABY_CARSEAT", "A_BABY_CLOTH", "A_BABY_DIAPER", "A_BOOKS_GEN", "A_BOOKS_RELIG", "A_BOOKS_RENTAL", "A_BUNDLE_PERDCL", "A_CLSFD_52W-4Q", "A_CLSFD_52WKLY", "A_CLSFD_ANNUAL", "A_CLSFD_SEMIANNL", "A_CLTH_ATHL", "A_CLTH_BATH", "A_CLTH_BOOKBAG", "A_CLTH_BUCKLS", "A_CLTH_COMPON", "A_CLTH_CSTUMS", "A_CLTH_FORMAL", "A_CLTH_FUR", "A_CLTH_GEN", "A_CLTH_HAIRACCESSORIES", "A_CLTH_HANDKE", "A_CLTH_HBAGS", "A_CLTH_IFUR", "A_CLTH_PROTECTIVE", "A_CLTH_UMBRELLA", "A_COLLECTIBLE_COIN", "A_COMP_COMPUTER", "A_COMP_EDUSOFT", "A_COMP_GAMPER", "A_COMP_PDA", "A_COMP_PERIPH", "A_COMP_PRINT", "A_COMP_PRTSUP", "A_COMP_SCANNER", "A_COMP_SOFTOP", "A_COMP_SOFTRC", "A_COMP_STORAGEMEDIA", "A_EGOODS_DIGITALAUDIOBOOKS", "A_EGOODS_DIGITALBOOKS", "A_EGOODS_DIGITALBOOK_RENTAL", "A_EGOODS_DIGITALGAMES", "A_EGOODS_DIGITALMUSIC", "A_EGOODS_DIGITALNEWS", "A_EGOODS_DIGITALNEWSSUBS", "A_EGOODS_DIGITALPERDCL", "A_EGOODS_DIGITALPERDCLSUBS", "A_EGOODS_MISC1", "A_EGOODS_ONLINEGAMINGSUBS", "A_EGOODS_SOFT", "A_EMERGENCY_SUPPLIES", "A_FOOD_BKTCDY50-90", "A_FOOD_BKTGN50-75", "A_FOOD_BKTGN76-90", "A_FOOD_CARBSFTDK", "A_FOOD_CARBWTR", "A_FOOD_CNDY", "A_FOOD_CNDYFL", "A_FOOD_GEN", "A_FOOD_JUICE0-50", "A_FOOD_JUICE51-99", "A_FOOD_NCARBWTR", "A_FOOD_PETFOOD", "A_FOOD_WINE", "A_GEN_NOTAX", "A_GEN_RENTAL", "A_GEN_TAX", "A_HLTH_BABYSUPPLS", "A_HLTH_BANDKIT", "A_HLTH_CONTACTSOLN", "A_HLTH_CONTRCEPV", "A_HLTH_COSMETIC", "A_HLTH_DIABSUPPLS", "A_HLTH_DIETSUPMT", "A_HLTH_DISPOSABLE_PACK", "A_HLTH_FAMPLANTEST", "A_HLTH_FEMHYG", "A_HLTH_HEARINGAID_BATT", "A_HLTH_INCONT", "A_HLTH_MEDHAIRLOSS", "A_HLTH_MOBILITY", "A_HLTH_MONITOR", "A_HLTH_OTCMED", "A_HLTH_PROSTHETIC", "A_HLTH_SPFCORALHYG", "A_HLTH_SPFCOTCMED", "A_HLTH_SUNSCRN", "A_HLTH_THRMTR", "A_HLTH_TISSUETOW", "A_HLTH_TOOTHPASTEFL", "A_HOUSEHOLD_LINEN", "A_HOUSEHOLD_PAPERPRODS", "A_NEWS_104PLUS", "A_NEWS_12MTHLY", "A_NEWS_26BIWKLY", "A_NEWS_4QTLY", "A_NEWS_52WKLY", "A_PERDCL_104PLUS", "A_PERDCL_52W-4Q", "A_PERDCL_52WKLY", "A_PERDCL_ANNUAL", "A_PERDCL_SEMIANNL", "A_SCHL_GRAPHCALC", "A_SCHL_INSTRUMENT", "A_SCHL_SUPPLS", "A_SERV_INSTALL", "A_SPORT_ASUPPORT", "A_SPORT_ATHLSHOES", "A_SPORT_BIKEHLMT", "A_SPORT_MISCSPORTS1", "A_SPORT_SKISUIT", "A_SPORT_WINTERSPORTBOOTS", "A_WARR_PARTSNSRVC", "A_WARR_PARTSNSVCE" ], "description": "Amazon's product tax code identifier" }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "Amazon's product tax code identifier" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "condition_name": { "type": "string" } }, "required": [ "condition_name" ] } } } } } }, "required": [ "purchase_orders" ] }, "InsertPurchaseOrdersSearchParams": { "type": "object", "properties": { "create_listings": { "type": "boolean", "description": "for new marketplace SKUs, automatically initiate the process of creating listings" }, "convert": { "type": "boolean", "description": "for any seller fulfilled SKUs, convert them to be Walmart or Amazon fulfilled" } } }, "InsertShipFromBody": { "type": "object", "properties": { "ship_from": { "type": "object", "properties": { "ship_from_name": { "type": "string", "nullable": false }, "address_line_1": { "type": "string", "nullable": false }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string", "nullable": false }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string", "nullable": false }, "country_code": { "type": "string", "nullable": false }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] } }, "required": [ "ship_from_name", "address_line_1", "city", "postal_code", "country_code" ], "nullable": false } }, "required": [ "ship_from" ] }, "InsertShipFromParams": { "type": "object", "properties": { "ship_from_name": { "type": "string", "nullable": false }, "address_line_1": { "type": "string", "nullable": false }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string", "nullable": false }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string", "nullable": false }, "country_code": { "type": "string", "nullable": false }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] } }, "required": [ "ship_from_name", "address_line_1", "city", "postal_code", "country_code" ] }, "InsertShipFromRouteResponse": { "type": "object", "properties": { "ship_from": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "place_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ] } }, "required": [ "ship_from" ] }, "InsertSupplier": { "type": "object", "properties": { "supplier_name": { "type": "string", "nullable": false } }, "required": [ "supplier_name" ] }, "InsertSuppliersParams": { "type": "object", "properties": { "suppliers": { "type": "array", "items": { "type": "object", "properties": { "supplier_name": { "type": "string", "nullable": false } }, "required": [ "supplier_name" ] }, "nullable": false } }, "required": [ "suppliers" ] }, "InsertSuppliersResponse": { "type": "object", "properties": { "suppliers": { "type": "array", "items": { "type": "object", "properties": { "supplier_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "supplier_name": { "type": "string" }, "user_id": { "type": "string" }, "created_by": { "type": [ "string", "null" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "supplier_id", "created", "supplier_name", "user_id", "created_by", "updated", "updated_by", "archived", "archived_by" ] } } }, "required": [ "suppliers" ] }, "InsertTag": { "type": "object", "properties": { "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false } }, "required": [ "tag_name" ] }, "InsertTagsParams": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false } }, "required": [ "tag_name" ] }, "nullable": false }, "tag_type": { "type": [ "string", "null" ], "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] } }, "required": [ "tags" ] }, "InsertTagsResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "user_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } }, "required": [ "tag_id", "user_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } }, "required": [ "tags" ] }, "InsertUserFunctionResponse": { "type": "object", "properties": { "user_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "user_name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" }, "business_name": { "type": [ "string", "null" ], "description": "The name of the user" }, "email": { "type": "string" }, "last_ip": { "type": [ "string", "null" ], "description": "Most recent IP address user logged in from" }, "last_login": { "type": [ "string", "null" ], "format": "date-time", "description": "Most recent IP address user logged in from" }, "last_proxy": { "type": [ "string", "null" ], "format": "date-time" }, "last_instance": { "type": [ "string", "null" ], "description": "The last instance the user logged in from" }, "referred_by_id": { "type": [ "string", "null" ], "description": "The last instance the user logged in from" }, "parent_id": { "type": [ "string", "null" ] }, "next_auto": { "type": [ "number", "null" ] }, "abbreviated_business": { "type": [ "string", "null" ], "description": "The user provided abbreviated version of their business name" }, "abbreviated_name": { "type": [ "string", "null" ], "description": "The user provided abbreviated version of their business name" }, "sync_orders": { "type": "boolean", "description": "The user provided abbreviated version of their name" }, "save_inventory_value": { "type": "boolean", "description": "Whether or not to sync the user's orders" }, "attach_unshipped_cogs": { "type": "boolean", "description": "Whether or not to save the user's inventory value" }, "region": { "type": "string", "enum": [ "eu-west-1", "us-east-1", "us-west-1" ], "description": "Whether or not to attach the user's unshipped COGS to their orders" }, "active": { "type": "boolean", "description": "Whether or not the user is active. Generally used for toggling sub user access" }, "otp_type": { "type": [ "string", "null" ], "enum": [ "app", "email" ] }, "locked": { "type": "boolean" }, "locked_until": { "type": [ "string", "null" ], "format": "date-time" }, "wfs_inventory_report_schedule_id": { "type": [ "string", "null" ] }, "shiphero_refresh_token": { "type": [ "string", "null" ] }, "subscription_id": { "type": [ "string", "null" ] }, "subscription_start": { "type": [ "string", "null" ], "format": "date-time" }, "subscription_valid_thru": { "type": [ "string", "null" ], "format": "date-time" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "rate_limit": { "type": [ "string", "null" ], "enum": [ "fast", "medium", "slow", "ui" ], "description": "Number of requests per second the user is allowed to make" } } }, "InsertUserResponse": { "type": "object", "properties": { "user": { "type": "object", "properties": { "user_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "user_name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" }, "business_name": { "type": [ "string", "null" ], "description": "The name of the user" }, "email": { "type": "string" }, "last_ip": { "type": [ "string", "null" ], "description": "Most recent IP address user logged in from" }, "last_login": { "type": [ "string", "null" ], "format": "date-time", "description": "Most recent IP address user logged in from" }, "last_proxy": { "type": [ "string", "null" ], "format": "date-time" }, "last_instance": { "type": [ "string", "null" ], "description": "The last instance the user logged in from" }, "referred_by_id": { "type": [ "string", "null" ], "description": "The last instance the user logged in from" }, "parent_id": { "type": [ "string", "null" ] }, "next_auto": { "type": [ "number", "null" ] }, "abbreviated_business": { "type": [ "string", "null" ], "description": "The user provided abbreviated version of their business name" }, "abbreviated_name": { "type": [ "string", "null" ], "description": "The user provided abbreviated version of their business name" }, "sync_orders": { "type": "boolean", "description": "The user provided abbreviated version of their name" }, "save_inventory_value": { "type": "boolean", "description": "Whether or not to sync the user's orders" }, "attach_unshipped_cogs": { "type": "boolean", "description": "Whether or not to save the user's inventory value" }, "region": { "type": "string", "enum": [ "eu-west-1", "us-east-1", "us-west-1" ], "description": "Whether or not to attach the user's unshipped COGS to their orders" }, "active": { "type": "boolean", "description": "Whether or not the user is active. Generally used for toggling sub user access" }, "otp_type": { "type": [ "string", "null" ], "enum": [ "app", "email" ] }, "locked": { "type": "boolean" }, "locked_until": { "type": [ "string", "null" ], "format": "date-time" }, "wfs_inventory_report_schedule_id": { "type": [ "string", "null" ] }, "shiphero_refresh_token": { "type": [ "string", "null" ] }, "subscription_id": { "type": [ "string", "null" ] }, "subscription_start": { "type": [ "string", "null" ], "format": "date-time" }, "subscription_valid_thru": { "type": [ "string", "null" ], "format": "date-time" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "rate_limit": { "type": [ "string", "null" ], "enum": [ "fast", "medium", "slow", "ui" ], "description": "Number of requests per second the user is allowed to make" } } } }, "required": [ "user" ] }, "InsertWebHookBody": { "type": "object", "properties": { "endpoint": { "type": "string", "nullable": false }, "secret_key": { "type": [ "boolean", "null" ] }, "enabled": { "type": "boolean", "nullable": false } } }, "InsertWebHookParams": { "type": "object", "properties": { "endpoint": { "type": "string", "nullable": false }, "options": { "nullable": false }, "enabled": { "type": "boolean", "nullable": false }, "name": { "type": "string", "nullable": false }, "secret_key": { "type": [ "boolean", "null" ] } } }, "InsertWebHookResponse": {}, "InsertWmPalletsBody": { "type": "object", "properties": { "pallets": { "type": "array", "items": { "type": "object", "properties": { "pallet_id": { "type": "string", "nullable": false }, "shipment_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "package_sequence_number": { "type": "number", "nullable": false }, "weight": { "type": "number", "nullable": false }, "weight_uom": { "type": "string", "enum": [ "lb" ], "nullable": false }, "length": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "length_uom": { "type": "string", "enum": [ "in" ], "nullable": false }, "no_of_packages": { "type": "number", "nullable": false }, "stackable": { "type": "boolean", "nullable": false } } }, "nullable": false } } }, "InsertWmPalletsResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "number" }, "data": {}, "message": { "type": "string" } }, "required": [ "message" ] } }, "pallets": { "type": "array", "items": { "type": "object", "properties": { "pallet_id": { "type": "string" }, "shipment_id": { "type": "string" }, "user_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "package_sequence_number": { "type": "number" }, "weight": { "type": "number" }, "weight_uom": { "type": "string", "enum": [ "lb" ] }, "length": { "type": "number" }, "height": { "type": "number" }, "width": { "type": "number" }, "length_uom": { "type": "string", "enum": [ "in" ] }, "no_of_packages": { "type": [ "number", "null" ] }, "stackable": { "type": [ "boolean", "null" ] } }, "required": [ "pallet_id", "shipment_id", "user_id", "created", "created_by", "creation_source", "updated", "updated_by", "deleted", "deleted_by", "package_sequence_number", "weight", "weight_uom", "length", "height", "width", "length_uom", "no_of_packages", "stackable" ] } } } }, "InventoryColumn": { "type": "object", "properties": { "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "product": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "value" ] } }, { "type": "object" } ] }, "data": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sku": { "type": "object" }, "condition": { "type": "object" }, "wpid": { "type": "object" }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "productName": { "type": "object" }, "shelf": { "type": "object" }, "productType": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } ] }, "publishedStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PUBLISHED" ] }, { "type": "string", "enum": [ "READY_TO_PUBLISH" ] }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "UNPUBLISHED" ] }, { "type": "string", "enum": [ "STAGE" ] }, { "type": "string", "enum": [ "SYSTEM_PROBLEM." ] } ] }, "additionalAttributes": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "nameValueAttribute": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "variantResourceType": { "type": "object" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "object" }, "source": { "type": "object" }, "rank": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "isVariant": { "type": "object" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } ] } } } ] }, "unpublishedReasons": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "reason": { "oneOf": [ { "type": "object" }, { "type": "object" } ] } } } ] }, "lifecycleStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "ARCHIVED" ] }, { "type": "string", "enum": [ "RETIRED" ] } ] }, "isDuplicate": { "type": "object" }, "isCustomerFavorite": { "type": "object" }, "duplicateItemdetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "status": { "type": "object" }, "lastUpdatedDate": { "type": "object" }, "identifiedDate": { "type": "object" }, "destinationItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "type": "object" }, "wpid": { "type": "object" }, "gtin": { "type": "object" }, "upc": { "type": "object" }, "itemId": { "type": "object" }, "productName": { "type": "object" }, "productType": { "type": "object" }, "additionalAttributes": { "type": "object" } } } ] } } } ] } } } ] }, "getSearchResult": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "condition": { "type": "object" }, "isMarketPlaceItem": { "type": "object" }, "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } ] }, "customerRating": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } ] }, "description": { "type": "object" }, "title": { "type": "object" }, "brand": { "type": "object" }, "productType": { "type": "object" }, "properties": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variant_items_num": { "type": "object" }, "num_reviews": { "type": "object" }, "categories": { "type": "object" }, "variants": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variantMeta": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } ] }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "object" }, "itemId": { "type": "object" }, "isAvailable": { "type": "object" }, "title": { "type": "object" }, "variantValues": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "object" }, "value": { "type": "object" } } } } ] } } } } }, "required": [ "variantData" ] } ] }, "next_day_eligible": { "type": "object" } } } ] }, "parent": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } ] } } } ] } } }, { "type": "object" } ] }, "meltable": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "expiration_required": { "type": "object" }, "hazmat": { "type": "object" }, "size": { "type": "object" }, "category": { "type": "object" }, "dims": { "type": "object" }, "feed_data": { "type": "object" }, "gtins": { "type": "object" }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": "object" }, "icon": { "type": "object" } }, "required": [ "tag_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data", "gtins" ] }, "condition": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } } } }, "ItemTaxonomy": { "type": "object", "properties": { "category": { "type": "string", "description": "The name of the Product Category." }, "description": { "type": "string", "description": "The description of the Category." }, "productTypeGroup": { "type": "array", "items": { "type": "object", "properties": { "productTypeGroupName": { "type": "string", "description": "The name of the specific Product Type Group." }, "description": { "type": "string", "description": "The description of the Product Type Group." }, "productType": { "type": "array", "items": { "type": "object", "properties": { "productTypeName": { "type": "string", "description": "The name of the specific Product Type." }, "description": { "type": "string", "description": "The description of the Product Type." } }, "required": [ "productTypeName" ] }, "description": "List of Product Types in a Product Type Group." }, "department": { "type": "array", "items": { "type": "object", "properties": { "departmentName": { "type": "string", "description": "The name of the department." }, "departmentNumber": { "type": "string", "description": "Specifies the number assigned to the department." } } }, "description": "List of departments in a Product Type Group." } }, "required": [ "productTypeGroupName", "productType" ] }, "description": "List of Product Type Groups in a Category." } }, "required": [ "category", "productTypeGroup" ] }, "ItemToReceive": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "gtin": { "type": "string" }, "received": { "type": "number", "description": "Either this or `damaged` must be supplied" }, "damaged": { "type": "number", "description": "Either this or `received` must be supplied" }, "lot_code": { "type": [ "string", "null" ], "description": "Either this or `received` must be supplied" }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "by_intent": { "type": "boolean", "description": "true if this should be bundled by the PO item intent.bundle array" } } }, "LatestReportsParams": { "type": "object", "properties": { "since": { "type": "string", "format": "date-time" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "report_type": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] } } }, "LatestReportsResponse": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "properties": { "status": { "oneOf": [ { "type": "string", "enum": [ "WAIT", "PREPARING", "QUEUEING", "SUBMITTED", "IN_PROGRESS", "CANCELLED", "DONE", "DONE_NO_DATA", "ERROR", "FATAL" ] }, { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ] } ], "description": "the status of the last report" }, "can_submit": { "type": "string", "format": "date-time", "description": "when the next report can be requested" }, "created": { "type": "string", "format": "date-time", "description": "when the latest report was created" } }, "required": [ "status", "can_submit", "created" ] } } }, "ListDeliveryWindowOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "ListDeliveryWindowOptionsResponse": { "type": "object", "properties": { "deliveryWindowOptions": { "type": "array", "items": { "type": "object", "properties": { "availabilityType": { "type": "string", "description": "The type of delivery window availability. Values: `AVAILABLE`, `BLOCKED`, `CONGESTED`, `DISCOUNTED`" }, "deliveryWindowOptionId": { "type": "string", "description": "Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered." }, "discounts": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Discounts for the offered option." }, "endDate": { "type": "string", "description": "The time at which this delivery window option ends. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." }, "startDate": { "type": "string", "description": "The time at which this delivery window option starts. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." }, "validUntil": { "type": "string", "description": "The time at which this window delivery option is no longer valid. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." } }, "required": [ "availabilityType", "deliveryWindowOptionId", "endDate", "startDate", "validUntil" ] }, "description": "Delivery window options generated for the placement option." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "Delivery window options generated for the placement option." } }, "required": [ "deliveryWindowOptions" ] }, "ListDeliveryWindowOptionsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "ListInboundPlansToImportParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "status": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "SHIPPED" ] }, { "type": "string", "enum": [ "VOIDED" ] } ] }, "sortBy": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "LAST_UPDATED_TIME" ] }, { "type": "string", "enum": [ "CREATION_TIME" ] } ] }, "sortOrder": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ASC" ] }, { "type": "string", "enum": [ "DESC" ] } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "ListInboundPlansToImportResponse": { "type": "object", "properties": { "inboundPlans": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "The time at which the inbound plan was created. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "inboundPlanId": { "type": "string", "description": "Identifier of an inbound plan." }, "lastUpdatedAt": { "type": "string", "description": "The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace IDs." }, "name": { "type": "string", "description": "Human-readable name of the inbound plan." }, "sourceAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ], "description": "Human-readable name of the inbound plan." }, "status": { "type": "string", "description": "The current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`." } }, "required": [ "createdAt", "inboundPlanId", "lastUpdatedAt", "marketplaceIds", "name", "sourceAddress", "status" ] }, "description": "A list of inbound plans with minimal information." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "A list of inbound plans with minimal information." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } } }, "listingsItems_2021_08_01_Audience": { "type": "object", "properties": { "value": { "type": "string", "description": "Name of the audience an offer is applicable to. Common values: * 'ALL' - Standard offer audience for buyers on Amazon retail websites. * 'B2B' - Offer audience for Amazon Business website buyers." }, "displayName": { "type": "string", "description": "Localized display name for the audience." } } }, "listingsItems_2021_08_01_Decimal": { "type": "string" }, "listingsItems_2021_08_01_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "listingsItems_2021_08_01_FulfillmentAvailability": { "type": "object", "properties": { "fulfillmentChannelCode": { "type": "string", "description": "Designates which fulfillment network is used." }, "quantity": { "type": "number", "description": "The item quantity that you're making available for sale." } }, "required": [ "fulfillmentChannelCode" ] }, "listingsItems_2021_08_01_Issue": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] }, "listingsItems_2021_08_01_IssueEnforcementAction": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "listingsItems_2021_08_01_IssueEnforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ] }, "listingsItems_2021_08_01_IssueExemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ] }, "listingsItems_2021_08_01_Item": { "type": "object", "properties": { "sku": { "type": "string", "description": "A selling partner-provided identifier for an Amazon listing." }, "summaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "A marketplace identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." }, "productType": { "type": "string", "description": "The listings item's Amazon product type." }, "conditionType": { "type": "string", "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" ], "description": "Identifies the condition of the listings item." }, "status": { "type": "array", "items": { "type": "object" }, "description": "Statuses that apply to the listings item." }, "fnSku": { "type": "string", "description": "Fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item." }, "itemName": { "type": "string", "description": "Name, or title, associated with an Amazon catalog item." }, "createdDate": { "type": "string", "description": "Date the listings item was created, in ISO 8601 format." }, "lastUpdatedDate": { "type": "string", "description": "Date the listings item was last updated, in ISO 8601 format." }, "mainImage": { "type": "object", "properties": { "link": { "type": "string", "description": "The image's link or URL." }, "height": { "type": "number", "description": "The image's height, in pixels." }, "width": { "type": "number", "description": "The image's width, in pixels." } }, "required": [ "link", "height", "width" ], "description": "Date the listings item was last updated, in ISO 8601 format." } }, "required": [ "marketplaceId", "productType", "status", "createdDate", "lastUpdatedDate" ] }, "description": "A selling partner-provided identifier for an Amazon listing." }, "attributes": {}, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] } }, "offers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "offerType": { "type": "string", "enum": [ "B2C", "B2B" ], "description": "The listings item's offer type." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ], "description": "The listings item's offer type." }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points offered with the purchase of an item, and their monetary value." } }, "required": [ "pointsNumber" ] }, "audience": { "type": "object", "properties": { "value": { "type": "string", "description": "Name of the audience an offer is applicable to. Common values: * 'ALL' - Standard offer audience for buyers on Amazon retail websites. * 'B2B' - Offer audience for Amazon Business website buyers." }, "displayName": { "type": "string", "description": "Localized display name for the audience." } } } }, "required": [ "marketplaceId", "offerType", "price" ] } }, "fulfillmentAvailability": { "type": "array", "items": { "type": "object", "properties": { "fulfillmentChannelCode": { "type": "string", "description": "Designates which fulfillment network is used." }, "quantity": { "type": "number", "description": "The item quantity that you're making available for sale." } }, "required": [ "fulfillmentChannelCode" ] }, "description": "The listings item's fulfillment availability." }, "procurement": { "type": "array", "items": { "type": "object", "properties": { "costPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ] } }, "required": [ "costPrice" ] }, "description": "The listings item's vendor procurement information." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are children of this listing item." }, "parentSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "The names of the listing item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "The variation theme that indicates the combination of listing item attributes that define the variation family." } }, "required": [ "attributes", "theme" ], "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "The type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the listing item." } }, "required": [ "marketplaceId", "relationships" ] }, "description": "The listings item's vendor procurement information." }, "productTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "productType": { "type": "string", "description": "The name of the product type that is submitted by the Selling Partner." } }, "required": [ "marketplaceId", "productType" ] } } }, "required": [ "sku" ] }, "listingsItems_2021_08_01_ItemAttributes": {}, "listingsItems_2021_08_01_ItemIdentifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." } } } }, "listingsItems_2021_08_01_ItemIdentifiersByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." } } }, "listingsItems_2021_08_01_ItemImage": { "type": "object", "properties": { "link": { "type": "string", "description": "The image's link or URL." }, "height": { "type": "number", "description": "The image's height, in pixels." }, "width": { "type": "number", "description": "The image's width, in pixels." } }, "required": [ "link", "height", "width" ] }, "listingsItems_2021_08_01_ItemIssues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] } }, "listingsItems_2021_08_01_ItemOfferByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "offerType": { "type": "string", "enum": [ "B2C", "B2B" ], "description": "The listings item's offer type." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ], "description": "The listings item's offer type." }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points offered with the purchase of an item, and their monetary value." } }, "required": [ "pointsNumber" ] }, "audience": { "type": "object", "properties": { "value": { "type": "string", "description": "Name of the audience an offer is applicable to. Common values: * 'ALL' - Standard offer audience for buyers on Amazon retail websites. * 'B2B' - Offer audience for Amazon Business website buyers." }, "displayName": { "type": "string", "description": "Localized display name for the audience." } } } }, "required": [ "marketplaceId", "offerType", "price" ] }, "listingsItems_2021_08_01_ItemOffers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "offerType": { "type": "string", "enum": [ "B2C", "B2B" ], "description": "The listings item's offer type." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ], "description": "The listings item's offer type." }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points offered with the purchase of an item, and their monetary value." } }, "required": [ "pointsNumber" ] }, "audience": { "type": "object", "properties": { "value": { "type": "string", "description": "Name of the audience an offer is applicable to. Common values: * 'ALL' - Standard offer audience for buyers on Amazon retail websites. * 'B2B' - Offer audience for Amazon Business website buyers." }, "displayName": { "type": "string", "description": "Localized display name for the audience." } } } }, "required": [ "marketplaceId", "offerType", "price" ] } }, "listingsItems_2021_08_01_ItemProcurement": { "type": "object", "properties": { "costPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ] } }, "required": [ "costPrice" ] }, "listingsItems_2021_08_01_ItemProductTypeByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "productType": { "type": "string", "description": "The name of the product type that is submitted by the Selling Partner." } }, "required": [ "marketplaceId", "productType" ] }, "listingsItems_2021_08_01_ItemProductTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "productType": { "type": "string", "description": "The name of the product type that is submitted by the Selling Partner." } }, "required": [ "marketplaceId", "productType" ] } }, "listingsItems_2021_08_01_ItemRelationship": { "type": "object", "properties": { "childSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are children of this listing item." }, "parentSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "The names of the listing item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "The variation theme that indicates the combination of listing item attributes that define the variation family." } }, "required": [ "attributes", "theme" ], "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "The type of relationship." } }, "required": [ "type" ] }, "listingsItems_2021_08_01_ItemRelationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are children of this listing item." }, "parentSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "The names of the listing item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "The variation theme that indicates the combination of listing item attributes that define the variation family." } }, "required": [ "attributes", "theme" ], "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "The type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the listing item." } }, "required": [ "marketplaceId", "relationships" ] } }, "listingsItems_2021_08_01_ItemRelationshipsByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are children of this listing item." }, "parentSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "The names of the listing item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "The variation theme that indicates the combination of listing item attributes that define the variation family." } }, "required": [ "attributes", "theme" ], "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "The type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the listing item." } }, "required": [ "marketplaceId", "relationships" ] }, "listingsItems_2021_08_01_ItemSearchResults": { "type": "object", "properties": { "numberOfResults": { "type": "number", "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." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that can be used to fetch the next page." }, "previousToken": { "type": "string", "description": "A token that can be used to fetch the previous page." } }, "description": "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." }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "description": "A selling partner-provided identifier for an Amazon listing." }, "summaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "A marketplace identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." }, "productType": { "type": "string", "description": "The listings item's Amazon product type." }, "conditionType": { "type": "string", "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" ], "description": "Identifies the condition of the listings item." }, "status": { "type": "array", "items": { "type": "object" }, "description": "Statuses that apply to the listings item." }, "fnSku": { "type": "string", "description": "Fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item." }, "itemName": { "type": "string", "description": "Name, or title, associated with an Amazon catalog item." }, "createdDate": { "type": "string", "description": "Date the listings item was created, in ISO 8601 format." }, "lastUpdatedDate": { "type": "string", "description": "Date the listings item was last updated, in ISO 8601 format." }, "mainImage": { "type": "object", "properties": { "link": { "type": "string", "description": "The image's link or URL." }, "height": { "type": "number", "description": "The image's height, in pixels." }, "width": { "type": "number", "description": "The image's width, in pixels." } }, "required": [ "link", "height", "width" ], "description": "Date the listings item was last updated, in ISO 8601 format." } }, "required": [ "marketplaceId", "productType", "status", "createdDate", "lastUpdatedDate" ] }, "description": "A selling partner-provided identifier for an Amazon listing." }, "attributes": {}, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] } }, "offers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "offerType": { "type": "string", "enum": [ "B2C", "B2B" ], "description": "The listings item's offer type." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ], "description": "The listings item's offer type." }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points offered with the purchase of an item, and their monetary value." } }, "required": [ "pointsNumber" ] }, "audience": { "type": "object", "properties": { "value": { "type": "string", "description": "Name of the audience an offer is applicable to. Common values: * 'ALL' - Standard offer audience for buyers on Amazon retail websites. * 'B2B' - Offer audience for Amazon Business website buyers." }, "displayName": { "type": "string", "description": "Localized display name for the audience." } } } }, "required": [ "marketplaceId", "offerType", "price" ] } }, "fulfillmentAvailability": { "type": "array", "items": { "type": "object", "properties": { "fulfillmentChannelCode": { "type": "string", "description": "Designates which fulfillment network is used." }, "quantity": { "type": "number", "description": "The item quantity that you're making available for sale." } }, "required": [ "fulfillmentChannelCode" ] }, "description": "The listings item's fulfillment availability." }, "procurement": { "type": "array", "items": { "type": "object", "properties": { "costPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ] } }, "required": [ "costPrice" ] }, "description": "The listings item's vendor procurement information." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are children of this listing item." }, "parentSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "The names of the listing item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "The variation theme that indicates the combination of listing item attributes that define the variation family." } }, "required": [ "attributes", "theme" ], "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "The type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the listing item." } }, "required": [ "marketplaceId", "relationships" ] }, "description": "The listings item's vendor procurement information." }, "productTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "productType": { "type": "string", "description": "The name of the product type that is submitted by the Selling Partner." } }, "required": [ "marketplaceId", "productType" ] } } }, "required": [ "sku" ] }, "description": "A list of listings items." } }, "required": [ "numberOfResults", "items" ] }, "listingsItems_2021_08_01_ItemSummaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "A marketplace identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." }, "productType": { "type": "string", "description": "The listings item's Amazon product type." }, "conditionType": { "type": "string", "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" ], "description": "Identifies the condition of the listings item." }, "status": { "type": "array", "items": { "type": "object" }, "description": "Statuses that apply to the listings item." }, "fnSku": { "type": "string", "description": "Fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item." }, "itemName": { "type": "string", "description": "Name, or title, associated with an Amazon catalog item." }, "createdDate": { "type": "string", "description": "Date the listings item was created, in ISO 8601 format." }, "lastUpdatedDate": { "type": "string", "description": "Date the listings item was last updated, in ISO 8601 format." }, "mainImage": { "type": "object", "properties": { "link": { "type": "string", "description": "The image's link or URL." }, "height": { "type": "number", "description": "The image's height, in pixels." }, "width": { "type": "number", "description": "The image's width, in pixels." } }, "required": [ "link", "height", "width" ], "description": "Date the listings item was last updated, in ISO 8601 format." } }, "required": [ "marketplaceId", "productType", "status", "createdDate", "lastUpdatedDate" ] } }, "listingsItems_2021_08_01_ItemSummaryByMarketplace": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "A marketplace identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." }, "productType": { "type": "string", "description": "The listings item's Amazon product type." }, "conditionType": { "type": "string", "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" ], "description": "Identifies the condition of the listings item." }, "status": { "type": "array", "items": { "type": "object" }, "description": "Statuses that apply to the listings item." }, "fnSku": { "type": "string", "description": "Fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item." }, "itemName": { "type": "string", "description": "Name, or title, associated with an Amazon catalog item." }, "createdDate": { "type": "string", "description": "Date the listings item was created, in ISO 8601 format." }, "lastUpdatedDate": { "type": "string", "description": "Date the listings item was last updated, in ISO 8601 format." }, "mainImage": { "type": "object", "properties": { "link": { "type": "string", "description": "The image's link or URL." }, "height": { "type": "number", "description": "The image's height, in pixels." }, "width": { "type": "number", "description": "The image's width, in pixels." } }, "required": [ "link", "height", "width" ], "description": "Date the listings item was last updated, in ISO 8601 format." } }, "required": [ "marketplaceId", "productType", "status", "createdDate", "lastUpdatedDate" ] }, "listingsItems_2021_08_01_ItemVariationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "The names of the listing item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "The variation theme that indicates the combination of listing item attributes that define the variation family." } }, "required": [ "attributes", "theme" ] }, "listingsItems_2021_08_01_ListingsItemSubmissionResponse": { "type": "object", "properties": { "sku": { "type": "string", "description": "A selling partner-provided identifier for an Amazon listing." }, "status": { "type": "string", "enum": [ "ACCEPTED", "INVALID", "VALID" ], "description": "The status of the listings item submission." }, "submissionId": { "type": "string", "description": "The unique identifier of the listings item submission." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] }, "description": "Listings item issues related to the listings item submission." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." } } }, "description": "Listings item issues related to the listings item submission." } }, "required": [ "sku", "status", "submissionId" ] }, "listingsItems_2021_08_01_Money": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ] }, "listingsItems_2021_08_01_Pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that can be used to fetch the next page." }, "previousToken": { "type": "string", "description": "A token that can be used to fetch the previous page." } } }, "listingsItems_2021_08_01_PatchOperation": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "replace", "merge", "delete" ], "description": "Type of JSON Patch operation. Supported JSON Patch operations include `add`, `replace`, `merge` and `delete`. Refer to .", "nullable": false }, "path": { "type": "string", "description": "JSON Pointer path of the element to patch. Refer to [JavaScript Object Notation (JSON) Patch](https://tools.ietf.org/html/rfc6902) for more information.", "nullable": false }, "value": { "type": [ "array", "null" ], "items": {}, "description": "JSON value to `add`, `replace`, `merge` or `delete`." } }, "required": [ "op", "path" ] }, "listingsItems_2021_08_01_Points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points offered with the purchase of an item, and their monetary value." } }, "required": [ "pointsNumber" ] }, "listingsRestrictions_2021_08_01_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "listingsRestrictions_2021_08_01_Link": { "type": "object", "properties": { "resource": { "type": "string", "description": "The URI of the related resource." }, "verb": { "type": "string", "enum": [ "GET" ], "description": "The HTTP verb used to interact with the related resource." }, "title": { "type": "string", "description": "The title of the related resource." }, "type": { "type": "string", "description": "The media type of the related resource." } }, "required": [ "resource", "verb" ] }, "listingsRestrictions_2021_08_01_Reason": { "type": "object", "properties": { "message": { "type": "string", "description": "A message describing the reason for the restriction." }, "reasonCode": { "type": "string", "enum": [ "APPROVAL_REQUIRED", "ASIN_NOT_FOUND", "NOT_ELIGIBLE" ], "description": "A code indicating why the listing is restricted." }, "links": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string", "description": "The URI of the related resource." }, "verb": { "type": "string", "enum": [ "GET" ], "description": "The HTTP verb used to interact with the related resource." }, "title": { "type": "string", "description": "The title of the related resource." }, "type": { "type": "string", "description": "The media type of the related resource." } }, "required": [ "resource", "verb" ] }, "description": "A list of path forward links that may allow Selling Partners to remove the restriction." } }, "required": [ "message" ] }, "listingsRestrictions_2021_08_01_Restriction": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "A marketplace identifier. Identifies the Amazon marketplace where the restriction is enforced." }, "conditionType": { "type": "string", "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" ], "description": "The condition that applies to the restriction." }, "reasons": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "description": "A message describing the reason for the restriction." }, "reasonCode": { "type": "string", "enum": [ "APPROVAL_REQUIRED", "ASIN_NOT_FOUND", "NOT_ELIGIBLE" ], "description": "A code indicating why the listing is restricted." }, "links": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string", "description": "The URI of the related resource." }, "verb": { "type": "string", "enum": [ "GET" ], "description": "The HTTP verb used to interact with the related resource." }, "title": { "type": "string", "description": "The title of the related resource." }, "type": { "type": "string", "description": "The media type of the related resource." } }, "required": [ "resource", "verb" ] }, "description": "A list of path forward links that may allow Selling Partners to remove the restriction." } }, "required": [ "message" ] }, "description": "A list of reasons for the restriction." } }, "required": [ "marketplaceId" ] }, "listingsRestrictions_2021_08_01_RestrictionList": { "type": "object", "properties": { "restrictions": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "A marketplace identifier. Identifies the Amazon marketplace where the restriction is enforced." }, "conditionType": { "type": "string", "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" ], "description": "The condition that applies to the restriction." }, "reasons": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "description": "A message describing the reason for the restriction." }, "reasonCode": { "type": "string", "enum": [ "APPROVAL_REQUIRED", "ASIN_NOT_FOUND", "NOT_ELIGIBLE" ], "description": "A code indicating why the listing is restricted." }, "links": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string", "description": "The URI of the related resource." }, "verb": { "type": "string", "enum": [ "GET" ], "description": "The HTTP verb used to interact with the related resource." }, "title": { "type": "string", "description": "The title of the related resource." }, "type": { "type": "string", "description": "The media type of the related resource." } }, "required": [ "resource", "verb" ] }, "description": "A list of path forward links that may allow Selling Partners to remove the restriction." } }, "required": [ "message" ] }, "description": "A list of reasons for the restriction." } }, "required": [ "marketplaceId" ] }, "description": "A list of restrictions." } }, "required": [ "restrictions" ] }, "ListPackingGroupItemsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "ListPackingGroupItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Provides the information about the list of items in the packing group." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "Provides the information about the list of items in the packing group." } }, "required": [ "items" ] }, "ListPackingGroupItemsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "all_pages": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "maybe_202": { "type": "object" }, "sleepMs": { "type": "object" } }, "required": [ "mp" ] }, "ListPackingOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "ListPackingOptionsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "List of packing options." }, "packingOptions": { "type": "array", "items": { "type": "object", "properties": { "discounts": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Discount for the offered option." }, "expiration": { "type": "string", "description": "The time at which this packing option is no longer valid. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "fees": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Fee for the offered option." }, "packingOptionId": { "type": "string", "description": "Identifier of a packing option." }, "status": { "type": "string", "description": "The status of the packing option. Possible values: `OFFERED`, `ACCEPTED`, `EXPIRED`." }, "supportedConfigurations": { "type": "array", "items": { "type": "object", "properties": { "boxPackingMethods": { "type": "array", "items": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ] }, "description": "The box content information sources that are allowed." }, "boxRequirements": { "type": "object", "properties": { "weight": { "type": "object", "properties": { "maximum": { "type": "number", "description": "Maximum allowed weight." }, "minimum": { "type": "number", "description": "Minimum allowed weight." }, "unit": { "type": "string", "enum": [ "LB", "KG" ], "description": "Minimum allowed weight." } }, "required": [ "maximum", "minimum", "unit" ] } }, "required": [ "weight" ], "description": "The box content information sources that are allowed." }, "shippingRequirements": { "type": "array", "items": { "type": "object", "properties": { "modes": { "type": "array", "items": { "type": "string" }, "description": "Available shipment modes for this shipping program." }, "solution": { "type": "string", "description": "Shipping program for the option. Can be: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." } }, "required": [ "modes", "solution" ] }, "description": "A list of supported shipping requirements for this packing configuration." } } }, "description": "A list of possible configurations for this option." }, "supportedShippingConfigurations": { "type": "array", "items": { "type": "object", "properties": { "shippingMode": { "type": "string", "description": "Mode of shipment transportation that this option will provide. Possible values: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`." }, "shippingSolution": { "type": "string", "description": "Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." } } }, "description": "*This field is deprecated**. Use the `shippingRequirements` property under `supportedConfigurations` instead. List of supported shipping modes." }, "packingGroups": { "type": "array", "items": { "type": "object", "properties": { "packingGroupId": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] } } }, "required": [ "packingGroupId" ] } } }, "required": [ "packingGroups" ] } } } }, "ListPackingOptionsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "all_pages": { "type": "boolean", "description": "loop through all pages. defaults to true" }, "maybe_202": { "type": "boolean", "description": "return a 202 response if we have to wait for more than 5 seconds. defaults to true" }, "sleepMs": { "type": "number", "description": "how long to sleep between pages. defaults to 500ms" }, "accept_first_packing_option": { "type": "boolean", "description": "defaults to true, pass `false` to prevent auto-accept of first packing option" } } }, "ListPlacementOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "ListPlacementOptionsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "placementOptions": { "type": "array", "items": { "type": "object", "properties": { "discounts": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Discount for the offered option." }, "expiration": { "type": "string", "description": "The expiration date of the placement option. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "fees": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "The fee for the offered option." }, "placementOptionId": { "type": "string", "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "shipmentIds": { "type": "array", "items": { "type": "string" }, "description": "Shipment ids." }, "status": { "type": "string", "description": "The status of a placement option. Possible values: `OFFERED`, `ACCEPTED`, `EXPIRED`." } }, "required": [ "discounts", "fees", "placementOptionId", "shipmentIds", "status" ] }, "description": "Placement options generated for the inbound plan." } }, "required": [ "placementOptions" ] }, "ListPlacementOptionsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "all_pages": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "maybe_202": { "type": "object" }, "sleepMs": { "type": "object" } }, "required": [ "mp" ] }, "ListShipmentBoxesErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "ListShipmentBoxesResponse": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": "string", "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": "string", "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": "string", "description": "Template name of the box." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] }, "description": "A list of boxes in a shipment." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "A list of boxes in a shipment." } }, "required": [ "boxes" ] }, "ListShipmentBoxesSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "ListShipmentItemsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "ListShipmentItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "The items in a shipment." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "The items in a shipment." } }, "required": [ "items" ] }, "ListShipmentItemsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "ListTransportationOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "ListTransportationOptionsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "transportationOptions": { "type": "array", "items": { "type": "object", "properties": { "carrier": { "type": "object", "properties": { "alphaCode": { "type": "string", "description": "The carrier code. For example, USPS or DHLEX." }, "name": { "type": "string", "description": "The name of the carrier." } } }, "carrierAppointment": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ] }, "preconditions": { "type": "array", "items": { "type": "string" }, "description": "Identifies a list of preconditions for confirming the transportation option." }, "quote": { "type": "object", "properties": { "cost": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "expiration": { "type": "string", "description": "The time at which this transportation option quote expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "voidableUntil": { "type": "string", "description": "Voidable until timestamp." } }, "required": [ "cost" ], "description": "Identifies a list of preconditions for confirming the transportation option." }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "shippingMode": { "type": "string", "description": "Mode of shipment transportation that this option will provide. Possible values: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`." }, "shippingSolution": { "type": "string", "description": "Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." }, "transportationOptionId": { "type": "string", "description": "Identifier of a transportation option. A transportation option represent one option for how to send a shipment." } }, "required": [ "carrier", "preconditions", "shipmentId", "shippingMode", "shippingSolution", "transportationOptionId" ] }, "description": "Transportation options generated for the placement option." } }, "required": [ "transportationOptions" ] }, "ListTransportationOptionsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "placementOptionId": { "type": "object" }, "shipmentId": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "Location": { "type": "object", "properties": { "location_id": { "type": "string" }, "user_id": { "type": "string" }, "location_name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "location_type": { "type": "string", "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ] }, "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "location_id", "user_id", "location_name", "description", "location_type", "ship_from_id", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by" ] }, "location_type": { "type": "string", "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ] }, "MarketplaceReportStatus": { "oneOf": [ { "type": "string", "enum": [ "WAIT", "PREPARING", "QUEUEING", "SUBMITTED", "IN_PROGRESS", "CANCELLED", "DONE", "DONE_NO_DATA", "ERROR", "FATAL" ] }, { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ] } ] }, "MarketplaceReportType": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] }, "MergeAzBoxItem": { "type": "object", "properties": { "box_item_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "external_id": { "type": "string", "nullable": false }, "fnsku": { "type": "string", "nullable": false }, "label_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ], "nullable": false }, "prep_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ], "nullable": false }, "manufacturing_lot_code": { "type": "string", "nullable": false }, "prep_instructions": { "nullable": false }, "packing_group_id": { "type": "string", "nullable": false }, "plan_item_id": { "type": "number", "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "archived": { "type": "string", "format": "date-time", "nullable": false }, "archived_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "box_id": { "type": "number", "nullable": false }, "sku": { "type": "string", "nullable": false }, "delete": { "type": [ "boolean", "null" ] }, "clear_expires": { "type": [ "boolean", "null" ] }, "set_quantity": { "type": [ "number", "null" ] }, "add_quantity": { "type": [ "number", "null" ] } }, "required": [ "box_id", "sku" ] }, "MergeAzBoxItemsParams": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "box_item_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "external_id": { "type": "string", "nullable": false }, "fnsku": { "type": "string", "nullable": false }, "label_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ], "nullable": false }, "prep_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ], "nullable": false }, "manufacturing_lot_code": { "type": "string", "nullable": false }, "prep_instructions": { "nullable": false }, "packing_group_id": { "type": "string", "nullable": false }, "plan_item_id": { "type": "number", "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "archived": { "type": "string", "format": "date-time", "nullable": false }, "archived_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "box_id": { "type": "number", "nullable": false }, "sku": { "type": "string", "nullable": false }, "delete": { "type": [ "boolean", "null" ] }, "clear_expires": { "type": [ "boolean", "null" ] }, "set_quantity": { "type": [ "number", "null" ] }, "add_quantity": { "type": [ "number", "null" ] } }, "required": [ "box_id", "sku" ] }, "nullable": false } }, "required": [ "items" ] }, "MergeAzBoxItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "box_item_id": { "type": "string" }, "user_id": { "type": "string" }, "box_id": { "type": "number" }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "external_id": { "type": "string" }, "sku": { "type": "string" }, "fnsku": { "type": [ "string", "null" ] }, "label_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ] }, "prep_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ] }, "manufacturing_lot_code": { "type": [ "string", "null" ] }, "prep_instructions": { "anyOf": [ {}, { "type": "null" } ] }, "quantity": { "type": "number" }, "packing_group_id": { "type": [ "string", "null" ] }, "plan_item_id": { "type": [ "number", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "box_item_id", "user_id", "box_id", "expires", "external_id", "sku", "fnsku", "label_owner", "prep_owner", "manufacturing_lot_code", "prep_instructions", "quantity", "packing_group_id", "plan_item_id", "created", "created_by", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by" ] } } }, "required": [ "items" ] }, "MkFetch": { "type": "object" }, "MpParam": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "notifications_CreateDestinationResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } }, "description": "The destination identifier generated when you created the destination." } }, "required": [ "name", "destinationId", "resource" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "notifications_CreateSubscriptionResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier generated when the subscription is created." }, "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "type": "object", "properties": { "eventFilter": { "type": "object", "properties": {} }, "filterExpression": { "type": "string", "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } }, "description": "The identifier for the destination where notifications will be delivered." } }, "required": [ "subscriptionId", "payloadVersion", "destinationId" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "notifications_DeleteDestinationResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "notifications_DeleteSubscriptionByIdResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "notifications_Destination": { "type": "object", "properties": { "name": { "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } }, "description": "The destination identifier generated when you created the destination." } }, "required": [ "name", "destinationId", "resource" ] }, "notifications_DestinationList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } }, "description": "The destination identifier generated when you created the destination." } }, "required": [ "name", "destinationId", "resource" ] } }, "notifications_DestinationResource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } } }, "notifications_DestinationResourceSpecification": { "type": "object", "properties": { "sqs": { "type": [ "object", "null" ], "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue.", "nullable": false } }, "required": [ "arn" ] }, "eventBridge": { "type": [ "object", "null" ], "properties": { "region": { "type": "string", "description": "The AWS region in which you will be receiving the notifications.", "nullable": false }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications.", "nullable": false } }, "required": [ "region", "accountId" ] } } }, "notifications_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "notifications_ErrorList": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } }, "notifications_EventBridgeResource": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] }, "notifications_EventBridgeResourceSpecification": { "type": "object", "properties": { "region": { "type": "string", "description": "The AWS region in which you will be receiving the notifications.", "nullable": false }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications.", "nullable": false } }, "required": [ "region", "accountId" ] }, "notifications_EventFilter": { "type": "object", "properties": {} }, "notifications_GetDestinationResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } }, "description": "The destination identifier generated when you created the destination." } }, "required": [ "name", "destinationId", "resource" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "notifications_GetDestinationsResponse": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } }, "description": "The destination identifier generated when you created the destination." } }, "required": [ "name", "destinationId", "resource" ] } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "notifications_GetSubscriptionByIdResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier generated when the subscription is created." }, "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "type": "object", "properties": { "eventFilter": { "type": "object", "properties": {} }, "filterExpression": { "type": "string", "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } }, "description": "The identifier for the destination where notifications will be delivered." } }, "required": [ "subscriptionId", "payloadVersion", "destinationId" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "notifications_GetSubscriptionResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier generated when the subscription is created." }, "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "type": "object", "properties": { "eventFilter": { "type": "object", "properties": {} }, "filterExpression": { "type": "string", "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } }, "description": "The identifier for the destination where notifications will be delivered." } }, "required": [ "subscriptionId", "payloadVersion", "destinationId" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "notifications_ProcessingDirective": { "type": "object", "properties": { "eventFilter": { "type": "object", "properties": {} }, "filterExpression": { "type": "string", "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } } }, "notifications_SendTestNotificationResponse": { "type": "object", "properties": { "payload": { "description": "The payload for the `sendTestNotification` operation." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "The payload for the `sendTestNotification` operation." } } }, "notifications_SqsResource": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "notifications_Subscription": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier generated when the subscription is created." }, "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "type": "object", "properties": { "eventFilter": { "type": "object", "properties": {} }, "filterExpression": { "type": "string", "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } }, "description": "The identifier for the destination where notifications will be delivered." } }, "required": [ "subscriptionId", "payloadVersion", "destinationId" ] }, "notifications_TestNotification": { "type": "object", "properties": { "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification.", "nullable": false }, "testScenario": { "type": [ "string", "null" ], "description": "The scenario of the specified notification to be used in the notification payload. If testScenario is empty, a 400 response will be returned back to the developer. The scenarios supported for each notification type can be found in the Selling Partner API Developer Guide." } }, "required": [ "payloadVersion" ] }, "OAuthRequest": { "type": "object", "properties": { "grant_type": { "type": "string", "enum": [ "refresh_token", "client_credentials" ], "nullable": false }, "refresh_token": { "type": [ "string", "null" ], "description": "Required if `grant_type` is `'refresh_token'`" } }, "required": [ "grant_type" ] }, "OAuthSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "the marketplace you wish to connect to" }, "redir": { "type": "string", "description": "url to redirect to after the connection has been established, defaults to `/account/`" } }, "required": [ "mp" ] }, "operation_status": { "type": "string", "enum": [ "FAILED", "IN_PROGRESS", "SUCCESS" ] }, "OperationOpts": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "operation_complete": { "type": "boolean", "description": "wait for operation to complete. defaults to true" }, "maybe_202": { "type": "boolean", "description": "return a 202 response if we have to wait for more than 5 seconds. defaults to true" } } }, "orders_2026_01_01_AddressExtendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } } }, "orders_2026_01_01_Alias": { "type": "object", "properties": { "aliasId": { "type": "string", "description": "The alternative identifier value that can be used to reference this order." }, "aliasType": { "type": "string", "description": "The kind of alternative identifier this represents. **Possible values**: `SELLER_ORDER_ID`" } }, "required": [ "aliasId", "aliasType" ] }, "orders_2026_01_01_Asin": { "type": "string" }, "orders_2026_01_01_AssociatedOrder": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The unique identifier of the related order that is associated with the current order." }, "associationType": { "type": "string", "description": "The relationship between the current order and the associated order. **Possible values**: `REPLACEMENT_ORIGINAL_ID`, `EXCHANGE_ORIGINAL_ID`" } } }, "orders_2026_01_01_AssociatedOrderItem": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The order identifier of the associated order item." }, "orderItemId": { "type": "string", "description": "The order item identifier of the associated order item." }, "associationType": { "type": "string", "description": "The type of association between the order items. **Possible values**: - `VALUE_ADD_SERVICE` (The associated item is a service order)" } } }, "orders_2026_01_01_BusinessHour": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "enum": [ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" ], "description": "Specific day of the week for which operating hours are being defined." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Collection of time windows during which the location is available for deliveries on the specified day." } } }, "orders_2026_01_01_Buyer": { "type": "object", "properties": { "buyerName": { "type": "string", "description": "The full name of the customer who placed the order." }, "buyerEmail": { "type": "string", "description": "The anonymized email address of the buyer. **Note:** Only available for merchant-fulfilled (FBM) orders." }, "buyerCompanyName": { "type": "string", "description": "The name of the company or organization for a business order." }, "buyerPurchaseOrderNumber": { "type": "string", "description": "The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } } }, "orders_2026_01_01_ConstraintType": { "type": "string", "enum": [ "MANDATORY" ] }, "orders_2026_01_01_CustomerAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } } }, "orders_2026_01_01_DateTimeRange": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "orders_2026_01_01_Decimal": { "type": "string" }, "orders_2026_01_01_DeliveryPreference": { "type": "object", "properties": { "dropOffLocation": { "type": "string", "description": "The drop-off location selected by the customer." }, "addressInstruction": { "type": "string", "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryTime": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "enum": [ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" ], "description": "Specific day of the week for which operating hours are being defined." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Collection of time windows during which the location is available for deliveries on the specified day." } } }, "description": "Business hours when the business is open for deliveries." }, "exceptionDates": { "type": "array", "items": { "type": "object", "properties": { "exceptionDate": { "type": "string", "description": "Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity." }, "exceptionDateType": { "type": "string", "enum": [ "CLOSED", "OPEN" ], "description": "Operational status of the business on the specified exception date." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Alternative operating hours that apply specifically to this exception date." } } }, "description": "Specific dates within the next 30 days when normal business hours do not apply." } }, "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryCapabilities": { "type": "array", "items": { "type": "string" }, "description": "A list of miscellaneous delivery capabilities associated with the shipping address." } } }, "orders_2026_01_01_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "orders_2026_01_01_ExceptionDate": { "type": "object", "properties": { "exceptionDate": { "type": "string", "description": "Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity." }, "exceptionDateType": { "type": "string", "enum": [ "CLOSED", "OPEN" ], "description": "Operational status of the business on the specified exception date." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Alternative operating hours that apply specifically to this exception date." } } }, "orders_2026_01_01_FulfillmentOrder": { "type": "object", "properties": { "fulfillmentOrderId": { "type": "string", "description": "The Fulfillment Order ID assigned by Amazon after fulfillment planning. This identifier is identical to the Shipment ID required by External Fulfillment APIs." } }, "required": [ "fulfillmentOrderId" ] }, "orders_2026_01_01_FulfillmentStatus": { "type": "string", "enum": [ "PENDING_AVAILABILITY", "PENDING", "UNSHIPPED", "PARTIALLY_SHIPPED", "SHIPPED", "CANCELLED", "UNFULFILLABLE" ] }, "orders_2026_01_01_GetOrderResponse": { "type": "object", "properties": { "order": { "type": "object", "properties": { "orderId": { "type": "string", "description": "An Amazon-defined order identifier." }, "orderAliases": { "type": "array", "items": { "type": "object", "properties": { "aliasId": { "type": "string", "description": "The alternative identifier value that can be used to reference this order." }, "aliasType": { "type": "string", "description": "The kind of alternative identifier this represents. **Possible values**: `SELLER_ORDER_ID`" } }, "required": [ "aliasId", "aliasType" ] }, "description": "Alternative identifiers that can be used to reference this order, such as seller-defined order numbers." }, "createdTime": { "type": "string", "description": "The time when the customer placed the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "lastUpdatedTime": { "type": "string", "description": "The most recent time when any aspect of this order was modified by Amazon or the seller. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "programs": { "type": "array", "items": { "type": "string" }, "description": "Special programs associated with this order that may affect fulfillment or customer experience. **Possible values**: `AMAZON_BAZAAR`, `AMAZON_BUSINESS`, `AMAZON_EASY_SHIP`, `AMAZON_HAUL`, `DELIVERY_BY_AMAZON`, `FBM_SHIP_PLUS`, `INVOICE_BY_AMAZON`, `IN_STORE_PICK_UP`, `PREMIUM`, `PREORDER`, `PRIME`" }, "associatedOrders": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The unique identifier of the related order that is associated with the current order." }, "associationType": { "type": "string", "description": "The relationship between the current order and the associated order. **Possible values**: `REPLACEMENT_ORIGINAL_ID`, `EXCHANGE_ORIGINAL_ID`" } } }, "description": "Other orders that have a direct relationship to this order, such as replacement or exchange orders." }, "salesChannel": { "type": "object", "properties": { "channelName": { "type": "string", "description": "The name of the sales platform or channel where the customer placed this order. **Possible values**: `AMAZON`, `NON_AMAZON`" }, "marketplaceId": { "type": "string", "description": "The unique identifier for the specific marketplace within the sales channel where this order was placed." }, "marketplaceName": { "type": "string", "description": "The human-readable name of the marketplace where this order was placed." } }, "required": [ "channelName" ], "description": "Other orders that have a direct relationship to this order, such as replacement or exchange orders." }, "buyer": { "type": "object", "properties": { "buyerName": { "type": "string", "description": "The full name of the customer who placed the order." }, "buyerEmail": { "type": "string", "description": "The anonymized email address of the buyer. **Note:** Only available for merchant-fulfilled (FBM) orders." }, "buyerCompanyName": { "type": "string", "description": "The name of the company or organization for a business order." }, "buyerPurchaseOrderNumber": { "type": "string", "description": "The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } } }, "recipient": { "type": "object", "properties": { "deliveryAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } } }, "deliveryPreference": { "type": "object", "properties": { "dropOffLocation": { "type": "string", "description": "The drop-off location selected by the customer." }, "addressInstruction": { "type": "string", "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryTime": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "enum": [ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" ], "description": "Specific day of the week for which operating hours are being defined." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Collection of time windows during which the location is available for deliveries on the specified day." } } }, "description": "Business hours when the business is open for deliveries." }, "exceptionDates": { "type": "array", "items": { "type": "object", "properties": { "exceptionDate": { "type": "string", "description": "Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity." }, "exceptionDateType": { "type": "string", "enum": [ "CLOSED", "OPEN" ], "description": "Operational status of the business on the specified exception date." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Alternative operating hours that apply specifically to this exception date." } } }, "description": "Specific dates within the next 30 days when normal business hours do not apply." } }, "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryCapabilities": { "type": "array", "items": { "type": "string" }, "description": "A list of miscellaneous delivery capabilities associated with the shipping address." } } } } }, "proceeds": { "type": "object", "properties": { "grandTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The proceeds category. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `TAX`, `DISCOUNT`, `DELIVERY_TIP`, `OTHER`. **Note:** `DELIVERY_TIP` is charged separately and not attributed to a specific item. The remaining categories are aggregated across all order items." }, "status": { "type": "string", "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." } }, "required": [ "type", "subtotal" ] }, "description": "Categorized proceeds for the order. Proceed categories are either aggregated across all order items (such as `ITEM`, `SHIPPING`, and `TAX`) or applied at the order level (such as `DELIVERY_TIP`)." } } }, "payment": { "type": "object", "properties": { "paymentExecutions": { "type": "array", "items": { "type": "object", "properties": { "paymentMethod": { "type": "string", "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "paymentAmount": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "acquirerId": { "type": "string", "description": "The unique identifier of the payment processor or acquiring bank that authorizes the payment. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." }, "cardBrand": { "type": "string", "description": "The card network or brand used in the payment transaction (for example, Visa or Mastercard). **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard`." }, "authorizationCode": { "type": "string", "description": "The unique code that confirms the payment authorization. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." } } }, "description": "A list of payment executions for the order." } } }, "tax": { "type": "object", "properties": { "taxRegistrations": { "type": "array", "items": { "type": "object", "properties": { "entityType": { "type": "string", "description": "The type of entity that the tax registration belongs to. **Possible values**: - `BUYER` (Indicates that this is the buyer's tax registration information) - `MERCHANT` (Indicates that this is the merchant's tax registration information) - `MARKETPLACE` (Indicates that this is the marketplace's tax registration information)" }, "legalName": { "type": "string", "description": "The legal name associated with the tax registration." }, "taxRegistrationType": { "type": "string", "description": "The type of the tax registration number. **Possible values**: `BUSINESS`, `VAT`, `CST`, `CPF`, `CNPJ`" }, "taxRegistrationNumber": { "type": "string", "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } }, "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAttributes": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the tax registration attribute. **Possible values**: `TAX_OFFICE`" }, "value": { "type": "string", "description": "The value of the tax registration attribute." } } }, "description": "Additional attributes related to the tax registration." } } }, "description": "A list of tax registrations associated with the order." }, "taxInvoicing": { "type": "object", "properties": { "buyerInvoicePreference": { "type": "string", "description": "The buyer's invoicing preference, which indicates whether the seller should issue an individual or a business invoice to the buyer. **Note**: This attribute is only available in the Turkey marketplace. **Possible values**: - `INDIVIDUAL` (Issues an individual invoice to the buyer) - `BUSINESS` (Issues a business invoice to the buyer)" }, "invoiceStatus": { "type": "string", "description": "The status of the invoice. Only available for Easy Ship orders and orders in the Brazil marketplace. **Possible values**: - `NOT_REQUIRED` (The order does not require an electronic invoice to be uploaded) - `NOT_FOUND` (The order requires an electronic invoice but it is not uploaded) - `PROCESSING` (The required electronic invoice was uploaded and is processing) - `ERRORED` (The uploaded electronic invoice was not accepted) - `ACCEPTED` (The uploaded electronic invoice was accepted)" } }, "description": "A list of tax registrations associated with the order." } } }, "fulfillment": { "type": "object", "properties": { "fulfillmentStatus": { "type": "string", "enum": [ "PENDING_AVAILABILITY", "PENDING", "UNSHIPPED", "PARTIALLY_SHIPPED", "SHIPPED", "CANCELLED", "UNFULFILLABLE" ] }, "fulfilledBy": { "type": "string", "description": "Specifies whether Amazon or the merchant is responsible for fulfilling this order. **Possible values**: `AMAZON`, `MERCHANT`." }, "fulfillmentServiceLevel": { "type": "string", "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "shipByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } }, "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "deliverByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "labelPrintingWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } } }, "required": [ "fulfillmentStatus" ] }, "orderItems": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "A unique identifier for this specific item within the order." }, "quantityOrdered": { "type": "number", "description": "The number of units of this item that the customer ordered." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "The number of units of this item that the customer ordered." }, "associatedOrderItems": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The order identifier of the associated order item." }, "orderItemId": { "type": "string", "description": "The order item identifier of the associated order item." }, "associationType": { "type": "string", "description": "The type of association between the order items. **Possible values**: - `VALUE_ADD_SERVICE` (The associated item is a service order)" } } }, "description": "A list of order items associated with this item. For example, a value-add service purchased with the product." }, "programs": { "type": "array", "items": { "type": "string" }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "product": { "type": "object", "properties": { "asin": { "type": "string" }, "title": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "sellerSku": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "condition": { "type": "object", "properties": { "conditionType": { "type": "string", "description": "The primary condition category that broadly describes the item's state. **Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`." }, "conditionSubtype": { "type": "string", "description": "A more specific condition classification that provides additional detail about the item's quality within the main condition type. **Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`, `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`." }, "conditionNote": { "type": "string", "description": "Additional details provided by the seller to describe the specific condition of this particular item." } } }, "price": { "type": "object", "properties": { "unitPrice": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "priceDesignation": { "type": "string", "description": "Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Possible value**: `BUSINESS_PRICE`" } } }, "serialNumbers": { "type": "array", "items": { "type": "string" }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." }, "customization": { "type": "object", "properties": { "customizedUrl": { "type": "string", "description": "The URL of the customized data for custom orders from the Amazon Custom program." } }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." } }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "proceeds": { "type": "object", "properties": { "proceedsTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "detailedBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "subtype": { "type": "string", "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" }, "value": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" } } }, "description": "Further granular breakdown of the subtotal." } }, "required": [ "type", "subtotal" ] }, "description": "The breakdown of proceeds." } } }, "expense": { "type": "object", "properties": { "pointsCost": { "type": "object", "properties": { "pointsGranted": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "Total number of Amazon Points granted to the customer's account for this item purchase." }, "pointsMonetaryValue": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Total number of Amazon Points granted to the customer's account for this item purchase." } } } } } } }, "promotion": { "type": "object", "properties": { "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "promotionId": { "type": "string", "description": "Unique identifier for the promotion applied to this item." } } }, "description": "A list of promotions applied to the order item." } } }, "cancellation": { "type": "object", "properties": { "cancellationRequest": { "type": "object", "properties": { "requester": { "type": "string", "description": "Entity that initiated the cancellation request for this item. **Possible values**: `BUYER`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was requested." } } }, "cancellationExecution": { "type": "object", "properties": { "cancelledBy": { "type": "string", "description": "Entity that executed the cancellation for this item. **Possible values**: `BUYER`, `MERCHANT`, `AMAZON`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was executed." } } } } }, "fulfillment": { "type": "object", "properties": { "quantityFulfilled": { "type": "number", "description": "The number of units of this item that have been successfully processed and shipped." }, "quantityUnfulfilled": { "type": "number", "description": "The number of units of this item that remain to be processed and shipped." }, "picking": { "type": "object", "properties": { "substitutionPreference": { "type": "object", "properties": { "substitutionType": { "type": "string", "enum": [ "CUSTOMER_PREFERENCE", "AMAZON_RECOMMENDED", "DO_NOT_SUBSTITUTE" ], "description": "Source and nature of the substitution preferences for this item." }, "substitutionOptions": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number of the substitute product." }, "quantityOrdered": { "type": "number", "description": "Number of units of the substitute item to be selected if substitution occurs." }, "sellerSku": { "type": "string", "description": "The item's seller stock keeping unit (SKU)." }, "title": { "type": "string", "description": "Product name or title of the substitute item as displayed to customers." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "Product name or title of the substitute item as displayed to customers." } } }, "description": "List of alternative products that can be substituted for the original item if it becomes unavailable." } }, "required": [ "substitutionType" ] } }, "description": "The number of units of this item that remain to be processed and shipped." }, "packing": { "type": "object", "properties": { "giftOption": { "type": "object", "properties": { "giftMessage": { "type": "string", "description": "Personal message from the buyer to be included with the gift-wrapped item." }, "giftWrapLevel": { "type": "string", "description": "Type or quality level of gift wrapping service selected by the customer." } } }, "serialNumberRequirement": { "type": "object", "properties": { "requirementType": { "type": "string", "description": "The requirement type for this request. **Possible values**: `REQUIRED`" } } } } }, "shipping": { "type": "object", "properties": { "scheduledDeliveryWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "shippingConstraints": { "type": "object", "properties": { "palletDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "cashOnDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "signatureConfirmation": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientIdentityVerification": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientAgeVerification": { "type": "string", "enum": [ "MANDATORY" ] } } }, "internationalShipping": { "type": "object", "properties": { "iossNumber": { "type": "string", "description": "Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale." } } } } } } }, "tax": { "type": "object", "properties": { "taxCalculationBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "reportingScheme": { "type": "string", "description": "The tax reporting scheme applied to this order item. **Possible values**: - `UOSS` (Union one stop shop. The item being purchased is held in the EU for shipment) - `IOSS` (Import one stop shop. The item being purchased is not held in the EU for shipment)" } } }, "description": "A list of tax calculation breakdowns for the order item." }, "taxCollections": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "description": "The tax collection model applied to the item. **Possible values**: - `MARKETPLACE_FACILITATOR` (Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller)" }, "responsibleParty": { "type": "string", "description": "The party responsible for withholding the taxes and remitting them to the taxing authority." } } }, "description": "A list of tax collections for the order item." } } } }, "required": [ "orderItemId", "quantityOrdered", "product" ] }, "description": "The list of all order items included in this order." }, "packages": { "type": "array", "items": { "type": "object", "properties": { "packageReferenceId": { "type": "string", "description": "A unique identifier for this package within the context of the order." }, "createdTime": { "type": "string", "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "packageStatus": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "IN_TRANSIT", "SHIPPED", "DELIVERED", "CANCELLED", "UNDELIVERABLE" ], "description": "Primary status classification of the package in the shipping workflow." }, "detailedStatus": { "type": "string", "description": "Granular status information providing specific details about the package's current location and handling stage. **Possible values**: - `PENDING_SCHEDULE` (Package awaiting pickup scheduling) - `PENDING_PICK_UP` (Package ready for carrier collection from seller) - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier) - `LABEL_CANCELLED` (Shipping label canceled by seller) - `PICKED_UP` (Package collected by carrier from seller location) - `DROPPED_OFF` (Package delivered to carrier by seller) - `AT_ORIGIN_FC` (Package at originating fulfillment center) - `AT_DESTINATION_FC` (Package at destination fulfillment center) - `DELIVERED` (Package successfully delivered to recipient) - `REJECTED_BY_BUYER` (Package refused by intended recipient) - `UNDELIVERABLE` (Package cannot be delivered due to address or access issues) - `RETURNING_TO_SELLER` (Package in transit back to seller) - `RETURNED_TO_SELLER` (Package successfully returned to seller) - `LOST` (Package location unknown or confirmed lost) - `OUT_FOR_DELIVERY` (Package on delivery vehicle for final delivery) - `DAMAGED` (Package damaged during transit)" } }, "required": [ "status" ], "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "carrier": { "type": "string", "description": "The carrier responsible for transporting this package to the customer." }, "shipTime": { "type": "string", "description": "The exact time when this package was handed over to the carrier and began its journey to the customer. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "shippingService": { "type": "string", "description": "The specific shipping method or service used for delivering this package." }, "trackingNumber": { "type": "string", "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "shipFromAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the business or facility at this address." }, "addressLine1": { "type": "string", "description": "The primary street address of the merchant's location." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code or ZIP code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code for the address, in ISO 3166-1 format." } }, "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "packageItems": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "Unique identifier of the order item included in this package." }, "quantity": { "type": "number", "description": "Number of units of this item included in the package shipment." }, "transparencyCodes": { "type": "array", "items": { "type": "string" }, "description": "The transparency codes associated with this item for product authentication." } }, "required": [ "orderItemId", "quantity" ] }, "description": "A list of all order items included in this specific package." } }, "required": [ "packageReferenceId" ] }, "description": "Shipping packages created for this order, including tracking information. **Note:** Only available for merchant-fulfilled (FBM) orders." }, "fulfillmentOrders": { "type": "array", "items": { "type": "object", "properties": { "fulfillmentOrderId": { "type": "string", "description": "The Fulfillment Order ID assigned by Amazon after fulfillment planning. This identifier is identical to the Shipment ID required by External Fulfillment APIs." } }, "required": [ "fulfillmentOrderId" ] }, "description": "The list of fulfillment orders associated with this customer order. Each entry corresponds to one fulfillment unit created by Amazon for this order. **Note:** Only available for EasyShip orders at present." } }, "required": [ "orderId", "createdTime", "lastUpdatedTime", "salesChannel", "orderItems" ] } }, "required": [ "order" ] }, "orders_2026_01_01_GiftOption": { "type": "object", "properties": { "giftMessage": { "type": "string", "description": "Personal message from the buyer to be included with the gift-wrapped item." }, "giftWrapLevel": { "type": "string", "description": "Type or quality level of gift wrapping service selected by the customer." } } }, "orders_2026_01_01_HourMinute": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "orders_2026_01_01_ItemCancellation": { "type": "object", "properties": { "cancellationRequest": { "type": "object", "properties": { "requester": { "type": "string", "description": "Entity that initiated the cancellation request for this item. **Possible values**: `BUYER`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was requested." } } }, "cancellationExecution": { "type": "object", "properties": { "cancelledBy": { "type": "string", "description": "Entity that executed the cancellation for this item. **Possible values**: `BUYER`, `MERCHANT`, `AMAZON`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was executed." } } } } }, "orders_2026_01_01_ItemCancellationExecution": { "type": "object", "properties": { "cancelledBy": { "type": "string", "description": "Entity that executed the cancellation for this item. **Possible values**: `BUYER`, `MERCHANT`, `AMAZON`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was executed." } } }, "orders_2026_01_01_ItemCancellationRequest": { "type": "object", "properties": { "requester": { "type": "string", "description": "Entity that initiated the cancellation request for this item. **Possible values**: `BUYER`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was requested." } } }, "orders_2026_01_01_ItemCondition": { "type": "object", "properties": { "conditionType": { "type": "string", "description": "The primary condition category that broadly describes the item's state. **Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`." }, "conditionSubtype": { "type": "string", "description": "A more specific condition classification that provides additional detail about the item's quality within the main condition type. **Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`, `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`." }, "conditionNote": { "type": "string", "description": "Additional details provided by the seller to describe the specific condition of this particular item." } } }, "orders_2026_01_01_ItemCustomization": { "type": "object", "properties": { "customizedUrl": { "type": "string", "description": "The URL of the customized data for custom orders from the Amazon Custom program." } } }, "orders_2026_01_01_ItemExpense": { "type": "object", "properties": { "pointsCost": { "type": "object", "properties": { "pointsGranted": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "Total number of Amazon Points granted to the customer's account for this item purchase." }, "pointsMonetaryValue": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Total number of Amazon Points granted to the customer's account for this item purchase." } } } } } } }, "orders_2026_01_01_ItemFulfillment": { "type": "object", "properties": { "quantityFulfilled": { "type": "number", "description": "The number of units of this item that have been successfully processed and shipped." }, "quantityUnfulfilled": { "type": "number", "description": "The number of units of this item that remain to be processed and shipped." }, "picking": { "type": "object", "properties": { "substitutionPreference": { "type": "object", "properties": { "substitutionType": { "type": "string", "enum": [ "CUSTOMER_PREFERENCE", "AMAZON_RECOMMENDED", "DO_NOT_SUBSTITUTE" ], "description": "Source and nature of the substitution preferences for this item." }, "substitutionOptions": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number of the substitute product." }, "quantityOrdered": { "type": "number", "description": "Number of units of the substitute item to be selected if substitution occurs." }, "sellerSku": { "type": "string", "description": "The item's seller stock keeping unit (SKU)." }, "title": { "type": "string", "description": "Product name or title of the substitute item as displayed to customers." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "Product name or title of the substitute item as displayed to customers." } } }, "description": "List of alternative products that can be substituted for the original item if it becomes unavailable." } }, "required": [ "substitutionType" ] } }, "description": "The number of units of this item that remain to be processed and shipped." }, "packing": { "type": "object", "properties": { "giftOption": { "type": "object", "properties": { "giftMessage": { "type": "string", "description": "Personal message from the buyer to be included with the gift-wrapped item." }, "giftWrapLevel": { "type": "string", "description": "Type or quality level of gift wrapping service selected by the customer." } } }, "serialNumberRequirement": { "type": "object", "properties": { "requirementType": { "type": "string", "description": "The requirement type for this request. **Possible values**: `REQUIRED`" } } } } }, "shipping": { "type": "object", "properties": { "scheduledDeliveryWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "shippingConstraints": { "type": "object", "properties": { "palletDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "cashOnDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "signatureConfirmation": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientIdentityVerification": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientAgeVerification": { "type": "string", "enum": [ "MANDATORY" ] } } }, "internationalShipping": { "type": "object", "properties": { "iossNumber": { "type": "string", "description": "Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale." } } } } } } }, "orders_2026_01_01_ItemInternationalShipping": { "type": "object", "properties": { "iossNumber": { "type": "string", "description": "Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale." } } }, "orders_2026_01_01_ItemPacking": { "type": "object", "properties": { "giftOption": { "type": "object", "properties": { "giftMessage": { "type": "string", "description": "Personal message from the buyer to be included with the gift-wrapped item." }, "giftWrapLevel": { "type": "string", "description": "Type or quality level of gift wrapping service selected by the customer." } } }, "serialNumberRequirement": { "type": "object", "properties": { "requirementType": { "type": "string", "description": "The requirement type for this request. **Possible values**: `REQUIRED`" } } } } }, "orders_2026_01_01_ItemPicking": { "type": "object", "properties": { "substitutionPreference": { "type": "object", "properties": { "substitutionType": { "type": "string", "enum": [ "CUSTOMER_PREFERENCE", "AMAZON_RECOMMENDED", "DO_NOT_SUBSTITUTE" ], "description": "Source and nature of the substitution preferences for this item." }, "substitutionOptions": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number of the substitute product." }, "quantityOrdered": { "type": "number", "description": "Number of units of the substitute item to be selected if substitution occurs." }, "sellerSku": { "type": "string", "description": "The item's seller stock keeping unit (SKU)." }, "title": { "type": "string", "description": "Product name or title of the substitute item as displayed to customers." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "Product name or title of the substitute item as displayed to customers." } } }, "description": "List of alternative products that can be substituted for the original item if it becomes unavailable." } }, "required": [ "substitutionType" ] } } }, "orders_2026_01_01_ItemPointsCost": { "type": "object", "properties": { "pointsGranted": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "Total number of Amazon Points granted to the customer's account for this item purchase." }, "pointsMonetaryValue": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Total number of Amazon Points granted to the customer's account for this item purchase." } } } } }, "orders_2026_01_01_ItemPrice": { "type": "object", "properties": { "unitPrice": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "priceDesignation": { "type": "string", "description": "Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Possible value**: `BUSINESS_PRICE`" } } }, "orders_2026_01_01_ItemProceeds": { "type": "object", "properties": { "proceedsTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "detailedBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "subtype": { "type": "string", "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" }, "value": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" } } }, "description": "Further granular breakdown of the subtotal." } }, "required": [ "type", "subtotal" ] }, "description": "The breakdown of proceeds." } } }, "orders_2026_01_01_ItemProceedsBreakdown": { "type": "object", "properties": { "type": { "type": "string", "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "detailedBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "subtype": { "type": "string", "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" }, "value": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" } } }, "description": "Further granular breakdown of the subtotal." } }, "required": [ "type", "subtotal" ] }, "orders_2026_01_01_ItemProceedsDetailedBreakdown": { "type": "object", "properties": { "subtype": { "type": "string", "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" }, "value": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" } } }, "orders_2026_01_01_ItemProduct": { "type": "object", "properties": { "asin": { "type": "string" }, "title": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "sellerSku": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "condition": { "type": "object", "properties": { "conditionType": { "type": "string", "description": "The primary condition category that broadly describes the item's state. **Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`." }, "conditionSubtype": { "type": "string", "description": "A more specific condition classification that provides additional detail about the item's quality within the main condition type. **Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`, `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`." }, "conditionNote": { "type": "string", "description": "Additional details provided by the seller to describe the specific condition of this particular item." } } }, "price": { "type": "object", "properties": { "unitPrice": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "priceDesignation": { "type": "string", "description": "Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Possible value**: `BUSINESS_PRICE`" } } }, "serialNumbers": { "type": "array", "items": { "type": "string" }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." }, "customization": { "type": "object", "properties": { "customizedUrl": { "type": "string", "description": "The URL of the customized data for custom orders from the Amazon Custom program." } }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." } } }, "orders_2026_01_01_ItemPromotion": { "type": "object", "properties": { "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "promotionId": { "type": "string", "description": "Unique identifier for the promotion applied to this item." } } }, "description": "A list of promotions applied to the order item." } } }, "orders_2026_01_01_ItemPromotionBreakdown": { "type": "object", "properties": { "promotionId": { "type": "string", "description": "Unique identifier for the promotion applied to this item." } } }, "orders_2026_01_01_ItemShipping": { "type": "object", "properties": { "scheduledDeliveryWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "shippingConstraints": { "type": "object", "properties": { "palletDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "cashOnDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "signatureConfirmation": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientIdentityVerification": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientAgeVerification": { "type": "string", "enum": [ "MANDATORY" ] } } }, "internationalShipping": { "type": "object", "properties": { "iossNumber": { "type": "string", "description": "Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale." } } } } }, "orders_2026_01_01_ItemShippingConstraints": { "type": "object", "properties": { "palletDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "cashOnDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "signatureConfirmation": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientIdentityVerification": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientAgeVerification": { "type": "string", "enum": [ "MANDATORY" ] } } }, "orders_2026_01_01_ItemSubstitutionOption": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number of the substitute product." }, "quantityOrdered": { "type": "number", "description": "Number of units of the substitute item to be selected if substitution occurs." }, "sellerSku": { "type": "string", "description": "The item's seller stock keeping unit (SKU)." }, "title": { "type": "string", "description": "Product name or title of the substitute item as displayed to customers." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "Product name or title of the substitute item as displayed to customers." } } }, "orders_2026_01_01_ItemSubstitutionPreference": { "type": "object", "properties": { "substitutionType": { "type": "string", "enum": [ "CUSTOMER_PREFERENCE", "AMAZON_RECOMMENDED", "DO_NOT_SUBSTITUTE" ], "description": "Source and nature of the substitution preferences for this item." }, "substitutionOptions": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number of the substitute product." }, "quantityOrdered": { "type": "number", "description": "Number of units of the substitute item to be selected if substitution occurs." }, "sellerSku": { "type": "string", "description": "The item's seller stock keeping unit (SKU)." }, "title": { "type": "string", "description": "Product name or title of the substitute item as displayed to customers." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "Product name or title of the substitute item as displayed to customers." } } }, "description": "List of alternative products that can be substituted for the original item if it becomes unavailable." } }, "required": [ "substitutionType" ] }, "orders_2026_01_01_ItemTax": { "type": "object", "properties": { "taxCalculationBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "reportingScheme": { "type": "string", "description": "The tax reporting scheme applied to this order item. **Possible values**: - `UOSS` (Union one stop shop. The item being purchased is held in the EU for shipment) - `IOSS` (Import one stop shop. The item being purchased is not held in the EU for shipment)" } } }, "description": "A list of tax calculation breakdowns for the order item." }, "taxCollections": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "description": "The tax collection model applied to the item. **Possible values**: - `MARKETPLACE_FACILITATOR` (Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller)" }, "responsibleParty": { "type": "string", "description": "The party responsible for withholding the taxes and remitting them to the taxing authority." } } }, "description": "A list of tax collections for the order item." } } }, "orders_2026_01_01_ItemTaxCalculationBreakdown": { "type": "object", "properties": { "reportingScheme": { "type": "string", "description": "The tax reporting scheme applied to this order item. **Possible values**: - `UOSS` (Union one stop shop. The item being purchased is held in the EU for shipment) - `IOSS` (Import one stop shop. The item being purchased is not held in the EU for shipment)" } } }, "orders_2026_01_01_ItemTaxCollection": { "type": "object", "properties": { "model": { "type": "string", "description": "The tax collection model applied to the item. **Possible values**: - `MARKETPLACE_FACILITATOR` (Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller)" }, "responsibleParty": { "type": "string", "description": "The party responsible for withholding the taxes and remitting them to the taxing authority." } } }, "orders_2026_01_01_Measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ] }, "orders_2026_01_01_MerchantAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the business or facility at this address." }, "addressLine1": { "type": "string", "description": "The primary street address of the merchant's location." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code or ZIP code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code for the address, in ISO 3166-1 format." } } }, "orders_2026_01_01_Money": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "orders_2026_01_01_Order": { "type": "object", "properties": { "orderId": { "type": "string", "description": "An Amazon-defined order identifier." }, "orderAliases": { "type": "array", "items": { "type": "object", "properties": { "aliasId": { "type": "string", "description": "The alternative identifier value that can be used to reference this order." }, "aliasType": { "type": "string", "description": "The kind of alternative identifier this represents. **Possible values**: `SELLER_ORDER_ID`" } }, "required": [ "aliasId", "aliasType" ] }, "description": "Alternative identifiers that can be used to reference this order, such as seller-defined order numbers." }, "createdTime": { "type": "string", "description": "The time when the customer placed the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "lastUpdatedTime": { "type": "string", "description": "The most recent time when any aspect of this order was modified by Amazon or the seller. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "programs": { "type": "array", "items": { "type": "string" }, "description": "Special programs associated with this order that may affect fulfillment or customer experience. **Possible values**: `AMAZON_BAZAAR`, `AMAZON_BUSINESS`, `AMAZON_EASY_SHIP`, `AMAZON_HAUL`, `DELIVERY_BY_AMAZON`, `FBM_SHIP_PLUS`, `INVOICE_BY_AMAZON`, `IN_STORE_PICK_UP`, `PREMIUM`, `PREORDER`, `PRIME`" }, "associatedOrders": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The unique identifier of the related order that is associated with the current order." }, "associationType": { "type": "string", "description": "The relationship between the current order and the associated order. **Possible values**: `REPLACEMENT_ORIGINAL_ID`, `EXCHANGE_ORIGINAL_ID`" } } }, "description": "Other orders that have a direct relationship to this order, such as replacement or exchange orders." }, "salesChannel": { "type": "object", "properties": { "channelName": { "type": "string", "description": "The name of the sales platform or channel where the customer placed this order. **Possible values**: `AMAZON`, `NON_AMAZON`" }, "marketplaceId": { "type": "string", "description": "The unique identifier for the specific marketplace within the sales channel where this order was placed." }, "marketplaceName": { "type": "string", "description": "The human-readable name of the marketplace where this order was placed." } }, "required": [ "channelName" ], "description": "Other orders that have a direct relationship to this order, such as replacement or exchange orders." }, "buyer": { "type": "object", "properties": { "buyerName": { "type": "string", "description": "The full name of the customer who placed the order." }, "buyerEmail": { "type": "string", "description": "The anonymized email address of the buyer. **Note:** Only available for merchant-fulfilled (FBM) orders." }, "buyerCompanyName": { "type": "string", "description": "The name of the company or organization for a business order." }, "buyerPurchaseOrderNumber": { "type": "string", "description": "The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } } }, "recipient": { "type": "object", "properties": { "deliveryAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } } }, "deliveryPreference": { "type": "object", "properties": { "dropOffLocation": { "type": "string", "description": "The drop-off location selected by the customer." }, "addressInstruction": { "type": "string", "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryTime": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "enum": [ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" ], "description": "Specific day of the week for which operating hours are being defined." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Collection of time windows during which the location is available for deliveries on the specified day." } } }, "description": "Business hours when the business is open for deliveries." }, "exceptionDates": { "type": "array", "items": { "type": "object", "properties": { "exceptionDate": { "type": "string", "description": "Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity." }, "exceptionDateType": { "type": "string", "enum": [ "CLOSED", "OPEN" ], "description": "Operational status of the business on the specified exception date." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Alternative operating hours that apply specifically to this exception date." } } }, "description": "Specific dates within the next 30 days when normal business hours do not apply." } }, "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryCapabilities": { "type": "array", "items": { "type": "string" }, "description": "A list of miscellaneous delivery capabilities associated with the shipping address." } } } } }, "proceeds": { "type": "object", "properties": { "grandTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The proceeds category. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `TAX`, `DISCOUNT`, `DELIVERY_TIP`, `OTHER`. **Note:** `DELIVERY_TIP` is charged separately and not attributed to a specific item. The remaining categories are aggregated across all order items." }, "status": { "type": "string", "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." } }, "required": [ "type", "subtotal" ] }, "description": "Categorized proceeds for the order. Proceed categories are either aggregated across all order items (such as `ITEM`, `SHIPPING`, and `TAX`) or applied at the order level (such as `DELIVERY_TIP`)." } } }, "payment": { "type": "object", "properties": { "paymentExecutions": { "type": "array", "items": { "type": "object", "properties": { "paymentMethod": { "type": "string", "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "paymentAmount": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "acquirerId": { "type": "string", "description": "The unique identifier of the payment processor or acquiring bank that authorizes the payment. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." }, "cardBrand": { "type": "string", "description": "The card network or brand used in the payment transaction (for example, Visa or Mastercard). **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard`." }, "authorizationCode": { "type": "string", "description": "The unique code that confirms the payment authorization. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." } } }, "description": "A list of payment executions for the order." } } }, "tax": { "type": "object", "properties": { "taxRegistrations": { "type": "array", "items": { "type": "object", "properties": { "entityType": { "type": "string", "description": "The type of entity that the tax registration belongs to. **Possible values**: - `BUYER` (Indicates that this is the buyer's tax registration information) - `MERCHANT` (Indicates that this is the merchant's tax registration information) - `MARKETPLACE` (Indicates that this is the marketplace's tax registration information)" }, "legalName": { "type": "string", "description": "The legal name associated with the tax registration." }, "taxRegistrationType": { "type": "string", "description": "The type of the tax registration number. **Possible values**: `BUSINESS`, `VAT`, `CST`, `CPF`, `CNPJ`" }, "taxRegistrationNumber": { "type": "string", "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } }, "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAttributes": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the tax registration attribute. **Possible values**: `TAX_OFFICE`" }, "value": { "type": "string", "description": "The value of the tax registration attribute." } } }, "description": "Additional attributes related to the tax registration." } } }, "description": "A list of tax registrations associated with the order." }, "taxInvoicing": { "type": "object", "properties": { "buyerInvoicePreference": { "type": "string", "description": "The buyer's invoicing preference, which indicates whether the seller should issue an individual or a business invoice to the buyer. **Note**: This attribute is only available in the Turkey marketplace. **Possible values**: - `INDIVIDUAL` (Issues an individual invoice to the buyer) - `BUSINESS` (Issues a business invoice to the buyer)" }, "invoiceStatus": { "type": "string", "description": "The status of the invoice. Only available for Easy Ship orders and orders in the Brazil marketplace. **Possible values**: - `NOT_REQUIRED` (The order does not require an electronic invoice to be uploaded) - `NOT_FOUND` (The order requires an electronic invoice but it is not uploaded) - `PROCESSING` (The required electronic invoice was uploaded and is processing) - `ERRORED` (The uploaded electronic invoice was not accepted) - `ACCEPTED` (The uploaded electronic invoice was accepted)" } }, "description": "A list of tax registrations associated with the order." } } }, "fulfillment": { "type": "object", "properties": { "fulfillmentStatus": { "type": "string", "enum": [ "PENDING_AVAILABILITY", "PENDING", "UNSHIPPED", "PARTIALLY_SHIPPED", "SHIPPED", "CANCELLED", "UNFULFILLABLE" ] }, "fulfilledBy": { "type": "string", "description": "Specifies whether Amazon or the merchant is responsible for fulfilling this order. **Possible values**: `AMAZON`, `MERCHANT`." }, "fulfillmentServiceLevel": { "type": "string", "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "shipByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } }, "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "deliverByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "labelPrintingWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } } }, "required": [ "fulfillmentStatus" ] }, "orderItems": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "A unique identifier for this specific item within the order." }, "quantityOrdered": { "type": "number", "description": "The number of units of this item that the customer ordered." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "The number of units of this item that the customer ordered." }, "associatedOrderItems": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The order identifier of the associated order item." }, "orderItemId": { "type": "string", "description": "The order item identifier of the associated order item." }, "associationType": { "type": "string", "description": "The type of association between the order items. **Possible values**: - `VALUE_ADD_SERVICE` (The associated item is a service order)" } } }, "description": "A list of order items associated with this item. For example, a value-add service purchased with the product." }, "programs": { "type": "array", "items": { "type": "string" }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "product": { "type": "object", "properties": { "asin": { "type": "string" }, "title": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "sellerSku": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "condition": { "type": "object", "properties": { "conditionType": { "type": "string", "description": "The primary condition category that broadly describes the item's state. **Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`." }, "conditionSubtype": { "type": "string", "description": "A more specific condition classification that provides additional detail about the item's quality within the main condition type. **Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`, `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`." }, "conditionNote": { "type": "string", "description": "Additional details provided by the seller to describe the specific condition of this particular item." } } }, "price": { "type": "object", "properties": { "unitPrice": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "priceDesignation": { "type": "string", "description": "Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Possible value**: `BUSINESS_PRICE`" } } }, "serialNumbers": { "type": "array", "items": { "type": "string" }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." }, "customization": { "type": "object", "properties": { "customizedUrl": { "type": "string", "description": "The URL of the customized data for custom orders from the Amazon Custom program." } }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." } }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "proceeds": { "type": "object", "properties": { "proceedsTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "detailedBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "subtype": { "type": "string", "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" }, "value": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" } } }, "description": "Further granular breakdown of the subtotal." } }, "required": [ "type", "subtotal" ] }, "description": "The breakdown of proceeds." } } }, "expense": { "type": "object", "properties": { "pointsCost": { "type": "object", "properties": { "pointsGranted": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "Total number of Amazon Points granted to the customer's account for this item purchase." }, "pointsMonetaryValue": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Total number of Amazon Points granted to the customer's account for this item purchase." } } } } } } }, "promotion": { "type": "object", "properties": { "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "promotionId": { "type": "string", "description": "Unique identifier for the promotion applied to this item." } } }, "description": "A list of promotions applied to the order item." } } }, "cancellation": { "type": "object", "properties": { "cancellationRequest": { "type": "object", "properties": { "requester": { "type": "string", "description": "Entity that initiated the cancellation request for this item. **Possible values**: `BUYER`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was requested." } } }, "cancellationExecution": { "type": "object", "properties": { "cancelledBy": { "type": "string", "description": "Entity that executed the cancellation for this item. **Possible values**: `BUYER`, `MERCHANT`, `AMAZON`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was executed." } } } } }, "fulfillment": { "type": "object", "properties": { "quantityFulfilled": { "type": "number", "description": "The number of units of this item that have been successfully processed and shipped." }, "quantityUnfulfilled": { "type": "number", "description": "The number of units of this item that remain to be processed and shipped." }, "picking": { "type": "object", "properties": { "substitutionPreference": { "type": "object", "properties": { "substitutionType": { "type": "string", "enum": [ "CUSTOMER_PREFERENCE", "AMAZON_RECOMMENDED", "DO_NOT_SUBSTITUTE" ], "description": "Source and nature of the substitution preferences for this item." }, "substitutionOptions": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number of the substitute product." }, "quantityOrdered": { "type": "number", "description": "Number of units of the substitute item to be selected if substitution occurs." }, "sellerSku": { "type": "string", "description": "The item's seller stock keeping unit (SKU)." }, "title": { "type": "string", "description": "Product name or title of the substitute item as displayed to customers." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "Product name or title of the substitute item as displayed to customers." } } }, "description": "List of alternative products that can be substituted for the original item if it becomes unavailable." } }, "required": [ "substitutionType" ] } }, "description": "The number of units of this item that remain to be processed and shipped." }, "packing": { "type": "object", "properties": { "giftOption": { "type": "object", "properties": { "giftMessage": { "type": "string", "description": "Personal message from the buyer to be included with the gift-wrapped item." }, "giftWrapLevel": { "type": "string", "description": "Type or quality level of gift wrapping service selected by the customer." } } }, "serialNumberRequirement": { "type": "object", "properties": { "requirementType": { "type": "string", "description": "The requirement type for this request. **Possible values**: `REQUIRED`" } } } } }, "shipping": { "type": "object", "properties": { "scheduledDeliveryWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "shippingConstraints": { "type": "object", "properties": { "palletDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "cashOnDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "signatureConfirmation": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientIdentityVerification": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientAgeVerification": { "type": "string", "enum": [ "MANDATORY" ] } } }, "internationalShipping": { "type": "object", "properties": { "iossNumber": { "type": "string", "description": "Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale." } } } } } } }, "tax": { "type": "object", "properties": { "taxCalculationBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "reportingScheme": { "type": "string", "description": "The tax reporting scheme applied to this order item. **Possible values**: - `UOSS` (Union one stop shop. The item being purchased is held in the EU for shipment) - `IOSS` (Import one stop shop. The item being purchased is not held in the EU for shipment)" } } }, "description": "A list of tax calculation breakdowns for the order item." }, "taxCollections": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "description": "The tax collection model applied to the item. **Possible values**: - `MARKETPLACE_FACILITATOR` (Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller)" }, "responsibleParty": { "type": "string", "description": "The party responsible for withholding the taxes and remitting them to the taxing authority." } } }, "description": "A list of tax collections for the order item." } } } }, "required": [ "orderItemId", "quantityOrdered", "product" ] }, "description": "The list of all order items included in this order." }, "packages": { "type": "array", "items": { "type": "object", "properties": { "packageReferenceId": { "type": "string", "description": "A unique identifier for this package within the context of the order." }, "createdTime": { "type": "string", "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "packageStatus": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "IN_TRANSIT", "SHIPPED", "DELIVERED", "CANCELLED", "UNDELIVERABLE" ], "description": "Primary status classification of the package in the shipping workflow." }, "detailedStatus": { "type": "string", "description": "Granular status information providing specific details about the package's current location and handling stage. **Possible values**: - `PENDING_SCHEDULE` (Package awaiting pickup scheduling) - `PENDING_PICK_UP` (Package ready for carrier collection from seller) - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier) - `LABEL_CANCELLED` (Shipping label canceled by seller) - `PICKED_UP` (Package collected by carrier from seller location) - `DROPPED_OFF` (Package delivered to carrier by seller) - `AT_ORIGIN_FC` (Package at originating fulfillment center) - `AT_DESTINATION_FC` (Package at destination fulfillment center) - `DELIVERED` (Package successfully delivered to recipient) - `REJECTED_BY_BUYER` (Package refused by intended recipient) - `UNDELIVERABLE` (Package cannot be delivered due to address or access issues) - `RETURNING_TO_SELLER` (Package in transit back to seller) - `RETURNED_TO_SELLER` (Package successfully returned to seller) - `LOST` (Package location unknown or confirmed lost) - `OUT_FOR_DELIVERY` (Package on delivery vehicle for final delivery) - `DAMAGED` (Package damaged during transit)" } }, "required": [ "status" ], "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "carrier": { "type": "string", "description": "The carrier responsible for transporting this package to the customer." }, "shipTime": { "type": "string", "description": "The exact time when this package was handed over to the carrier and began its journey to the customer. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "shippingService": { "type": "string", "description": "The specific shipping method or service used for delivering this package." }, "trackingNumber": { "type": "string", "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "shipFromAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the business or facility at this address." }, "addressLine1": { "type": "string", "description": "The primary street address of the merchant's location." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code or ZIP code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code for the address, in ISO 3166-1 format." } }, "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "packageItems": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "Unique identifier of the order item included in this package." }, "quantity": { "type": "number", "description": "Number of units of this item included in the package shipment." }, "transparencyCodes": { "type": "array", "items": { "type": "string" }, "description": "The transparency codes associated with this item for product authentication." } }, "required": [ "orderItemId", "quantity" ] }, "description": "A list of all order items included in this specific package." } }, "required": [ "packageReferenceId" ] }, "description": "Shipping packages created for this order, including tracking information. **Note:** Only available for merchant-fulfilled (FBM) orders." }, "fulfillmentOrders": { "type": "array", "items": { "type": "object", "properties": { "fulfillmentOrderId": { "type": "string", "description": "The Fulfillment Order ID assigned by Amazon after fulfillment planning. This identifier is identical to the Shipment ID required by External Fulfillment APIs." } }, "required": [ "fulfillmentOrderId" ] }, "description": "The list of fulfillment orders associated with this customer order. Each entry corresponds to one fulfillment unit created by Amazon for this order. **Note:** Only available for EasyShip orders at present." } }, "required": [ "orderId", "createdTime", "lastUpdatedTime", "salesChannel", "orderItems" ] }, "orders_2026_01_01_OrderFulfillment": { "type": "object", "properties": { "fulfillmentStatus": { "type": "string", "enum": [ "PENDING_AVAILABILITY", "PENDING", "UNSHIPPED", "PARTIALLY_SHIPPED", "SHIPPED", "CANCELLED", "UNFULFILLABLE" ] }, "fulfilledBy": { "type": "string", "description": "Specifies whether Amazon or the merchant is responsible for fulfilling this order. **Possible values**: `AMAZON`, `MERCHANT`." }, "fulfillmentServiceLevel": { "type": "string", "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "shipByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } }, "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "deliverByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "labelPrintingWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } } }, "required": [ "fulfillmentStatus" ] }, "orders_2026_01_01_OrderItem": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "A unique identifier for this specific item within the order." }, "quantityOrdered": { "type": "number", "description": "The number of units of this item that the customer ordered." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "The number of units of this item that the customer ordered." }, "associatedOrderItems": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The order identifier of the associated order item." }, "orderItemId": { "type": "string", "description": "The order item identifier of the associated order item." }, "associationType": { "type": "string", "description": "The type of association between the order items. **Possible values**: - `VALUE_ADD_SERVICE` (The associated item is a service order)" } } }, "description": "A list of order items associated with this item. For example, a value-add service purchased with the product." }, "programs": { "type": "array", "items": { "type": "string" }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "product": { "type": "object", "properties": { "asin": { "type": "string" }, "title": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "sellerSku": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "condition": { "type": "object", "properties": { "conditionType": { "type": "string", "description": "The primary condition category that broadly describes the item's state. **Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`." }, "conditionSubtype": { "type": "string", "description": "A more specific condition classification that provides additional detail about the item's quality within the main condition type. **Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`, `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`." }, "conditionNote": { "type": "string", "description": "Additional details provided by the seller to describe the specific condition of this particular item." } } }, "price": { "type": "object", "properties": { "unitPrice": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "priceDesignation": { "type": "string", "description": "Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Possible value**: `BUSINESS_PRICE`" } } }, "serialNumbers": { "type": "array", "items": { "type": "string" }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." }, "customization": { "type": "object", "properties": { "customizedUrl": { "type": "string", "description": "The URL of the customized data for custom orders from the Amazon Custom program." } }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." } }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "proceeds": { "type": "object", "properties": { "proceedsTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "detailedBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "subtype": { "type": "string", "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" }, "value": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" } } }, "description": "Further granular breakdown of the subtotal." } }, "required": [ "type", "subtotal" ] }, "description": "The breakdown of proceeds." } } }, "expense": { "type": "object", "properties": { "pointsCost": { "type": "object", "properties": { "pointsGranted": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "Total number of Amazon Points granted to the customer's account for this item purchase." }, "pointsMonetaryValue": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Total number of Amazon Points granted to the customer's account for this item purchase." } } } } } } }, "promotion": { "type": "object", "properties": { "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "promotionId": { "type": "string", "description": "Unique identifier for the promotion applied to this item." } } }, "description": "A list of promotions applied to the order item." } } }, "cancellation": { "type": "object", "properties": { "cancellationRequest": { "type": "object", "properties": { "requester": { "type": "string", "description": "Entity that initiated the cancellation request for this item. **Possible values**: `BUYER`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was requested." } } }, "cancellationExecution": { "type": "object", "properties": { "cancelledBy": { "type": "string", "description": "Entity that executed the cancellation for this item. **Possible values**: `BUYER`, `MERCHANT`, `AMAZON`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was executed." } } } } }, "fulfillment": { "type": "object", "properties": { "quantityFulfilled": { "type": "number", "description": "The number of units of this item that have been successfully processed and shipped." }, "quantityUnfulfilled": { "type": "number", "description": "The number of units of this item that remain to be processed and shipped." }, "picking": { "type": "object", "properties": { "substitutionPreference": { "type": "object", "properties": { "substitutionType": { "type": "string", "enum": [ "CUSTOMER_PREFERENCE", "AMAZON_RECOMMENDED", "DO_NOT_SUBSTITUTE" ], "description": "Source and nature of the substitution preferences for this item." }, "substitutionOptions": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number of the substitute product." }, "quantityOrdered": { "type": "number", "description": "Number of units of the substitute item to be selected if substitution occurs." }, "sellerSku": { "type": "string", "description": "The item's seller stock keeping unit (SKU)." }, "title": { "type": "string", "description": "Product name or title of the substitute item as displayed to customers." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "Product name or title of the substitute item as displayed to customers." } } }, "description": "List of alternative products that can be substituted for the original item if it becomes unavailable." } }, "required": [ "substitutionType" ] } }, "description": "The number of units of this item that remain to be processed and shipped." }, "packing": { "type": "object", "properties": { "giftOption": { "type": "object", "properties": { "giftMessage": { "type": "string", "description": "Personal message from the buyer to be included with the gift-wrapped item." }, "giftWrapLevel": { "type": "string", "description": "Type or quality level of gift wrapping service selected by the customer." } } }, "serialNumberRequirement": { "type": "object", "properties": { "requirementType": { "type": "string", "description": "The requirement type for this request. **Possible values**: `REQUIRED`" } } } } }, "shipping": { "type": "object", "properties": { "scheduledDeliveryWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "shippingConstraints": { "type": "object", "properties": { "palletDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "cashOnDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "signatureConfirmation": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientIdentityVerification": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientAgeVerification": { "type": "string", "enum": [ "MANDATORY" ] } } }, "internationalShipping": { "type": "object", "properties": { "iossNumber": { "type": "string", "description": "Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale." } } } } } } }, "tax": { "type": "object", "properties": { "taxCalculationBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "reportingScheme": { "type": "string", "description": "The tax reporting scheme applied to this order item. **Possible values**: - `UOSS` (Union one stop shop. The item being purchased is held in the EU for shipment) - `IOSS` (Import one stop shop. The item being purchased is not held in the EU for shipment)" } } }, "description": "A list of tax calculation breakdowns for the order item." }, "taxCollections": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "description": "The tax collection model applied to the item. **Possible values**: - `MARKETPLACE_FACILITATOR` (Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller)" }, "responsibleParty": { "type": "string", "description": "The party responsible for withholding the taxes and remitting them to the taxing authority." } } }, "description": "A list of tax collections for the order item." } } } }, "required": [ "orderItemId", "quantityOrdered", "product" ] }, "orders_2026_01_01_OrderPackage": { "type": "object", "properties": { "packageReferenceId": { "type": "string", "description": "A unique identifier for this package within the context of the order." }, "createdTime": { "type": "string", "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "packageStatus": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "IN_TRANSIT", "SHIPPED", "DELIVERED", "CANCELLED", "UNDELIVERABLE" ], "description": "Primary status classification of the package in the shipping workflow." }, "detailedStatus": { "type": "string", "description": "Granular status information providing specific details about the package's current location and handling stage. **Possible values**: - `PENDING_SCHEDULE` (Package awaiting pickup scheduling) - `PENDING_PICK_UP` (Package ready for carrier collection from seller) - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier) - `LABEL_CANCELLED` (Shipping label canceled by seller) - `PICKED_UP` (Package collected by carrier from seller location) - `DROPPED_OFF` (Package delivered to carrier by seller) - `AT_ORIGIN_FC` (Package at originating fulfillment center) - `AT_DESTINATION_FC` (Package at destination fulfillment center) - `DELIVERED` (Package successfully delivered to recipient) - `REJECTED_BY_BUYER` (Package refused by intended recipient) - `UNDELIVERABLE` (Package cannot be delivered due to address or access issues) - `RETURNING_TO_SELLER` (Package in transit back to seller) - `RETURNED_TO_SELLER` (Package successfully returned to seller) - `LOST` (Package location unknown or confirmed lost) - `OUT_FOR_DELIVERY` (Package on delivery vehicle for final delivery) - `DAMAGED` (Package damaged during transit)" } }, "required": [ "status" ], "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "carrier": { "type": "string", "description": "The carrier responsible for transporting this package to the customer." }, "shipTime": { "type": "string", "description": "The exact time when this package was handed over to the carrier and began its journey to the customer. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "shippingService": { "type": "string", "description": "The specific shipping method or service used for delivering this package." }, "trackingNumber": { "type": "string", "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "shipFromAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the business or facility at this address." }, "addressLine1": { "type": "string", "description": "The primary street address of the merchant's location." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code or ZIP code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code for the address, in ISO 3166-1 format." } }, "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "packageItems": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "Unique identifier of the order item included in this package." }, "quantity": { "type": "number", "description": "Number of units of this item included in the package shipment." }, "transparencyCodes": { "type": "array", "items": { "type": "string" }, "description": "The transparency codes associated with this item for product authentication." } }, "required": [ "orderItemId", "quantity" ] }, "description": "A list of all order items included in this specific package." } }, "required": [ "packageReferenceId" ] }, "orders_2026_01_01_OrderPayment": { "type": "object", "properties": { "paymentExecutions": { "type": "array", "items": { "type": "object", "properties": { "paymentMethod": { "type": "string", "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "paymentAmount": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "acquirerId": { "type": "string", "description": "The unique identifier of the payment processor or acquiring bank that authorizes the payment. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." }, "cardBrand": { "type": "string", "description": "The card network or brand used in the payment transaction (for example, Visa or Mastercard). **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard`." }, "authorizationCode": { "type": "string", "description": "The unique code that confirms the payment authorization. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." } } }, "description": "A list of payment executions for the order." } } }, "orders_2026_01_01_OrderProceeds": { "type": "object", "properties": { "grandTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The proceeds category. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `TAX`, `DISCOUNT`, `DELIVERY_TIP`, `OTHER`. **Note:** `DELIVERY_TIP` is charged separately and not attributed to a specific item. The remaining categories are aggregated across all order items." }, "status": { "type": "string", "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." } }, "required": [ "type", "subtotal" ] }, "description": "Categorized proceeds for the order. Proceed categories are either aggregated across all order items (such as `ITEM`, `SHIPPING`, and `TAX`) or applied at the order level (such as `DELIVERY_TIP`)." } } }, "orders_2026_01_01_OrderProceedsBreakdown": { "type": "object", "properties": { "type": { "type": "string", "description": "The proceeds category. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `TAX`, `DISCOUNT`, `DELIVERY_TIP`, `OTHER`. **Note:** `DELIVERY_TIP` is charged separately and not attributed to a specific item. The remaining categories are aggregated across all order items." }, "status": { "type": "string", "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." } }, "required": [ "type", "subtotal" ] }, "orders_2026_01_01_OrderTax": { "type": "object", "properties": { "taxRegistrations": { "type": "array", "items": { "type": "object", "properties": { "entityType": { "type": "string", "description": "The type of entity that the tax registration belongs to. **Possible values**: - `BUYER` (Indicates that this is the buyer's tax registration information) - `MERCHANT` (Indicates that this is the merchant's tax registration information) - `MARKETPLACE` (Indicates that this is the marketplace's tax registration information)" }, "legalName": { "type": "string", "description": "The legal name associated with the tax registration." }, "taxRegistrationType": { "type": "string", "description": "The type of the tax registration number. **Possible values**: `BUSINESS`, `VAT`, `CST`, `CPF`, `CNPJ`" }, "taxRegistrationNumber": { "type": "string", "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } }, "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAttributes": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the tax registration attribute. **Possible values**: `TAX_OFFICE`" }, "value": { "type": "string", "description": "The value of the tax registration attribute." } } }, "description": "Additional attributes related to the tax registration." } } }, "description": "A list of tax registrations associated with the order." }, "taxInvoicing": { "type": "object", "properties": { "buyerInvoicePreference": { "type": "string", "description": "The buyer's invoicing preference, which indicates whether the seller should issue an individual or a business invoice to the buyer. **Note**: This attribute is only available in the Turkey marketplace. **Possible values**: - `INDIVIDUAL` (Issues an individual invoice to the buyer) - `BUSINESS` (Issues a business invoice to the buyer)" }, "invoiceStatus": { "type": "string", "description": "The status of the invoice. Only available for Easy Ship orders and orders in the Brazil marketplace. **Possible values**: - `NOT_REQUIRED` (The order does not require an electronic invoice to be uploaded) - `NOT_FOUND` (The order requires an electronic invoice but it is not uploaded) - `PROCESSING` (The required electronic invoice was uploaded and is processing) - `ERRORED` (The uploaded electronic invoice was not accepted) - `ACCEPTED` (The uploaded electronic invoice was accepted)" } }, "description": "A list of tax registrations associated with the order." } } }, "orders_2026_01_01_OrderTaxInvoicing": { "type": "object", "properties": { "buyerInvoicePreference": { "type": "string", "description": "The buyer's invoicing preference, which indicates whether the seller should issue an individual or a business invoice to the buyer. **Note**: This attribute is only available in the Turkey marketplace. **Possible values**: - `INDIVIDUAL` (Issues an individual invoice to the buyer) - `BUSINESS` (Issues a business invoice to the buyer)" }, "invoiceStatus": { "type": "string", "description": "The status of the invoice. Only available for Easy Ship orders and orders in the Brazil marketplace. **Possible values**: - `NOT_REQUIRED` (The order does not require an electronic invoice to be uploaded) - `NOT_FOUND` (The order requires an electronic invoice but it is not uploaded) - `PROCESSING` (The required electronic invoice was uploaded and is processing) - `ERRORED` (The uploaded electronic invoice was not accepted) - `ACCEPTED` (The uploaded electronic invoice was accepted)" } } }, "orders_2026_01_01_OrderTaxRegistration": { "type": "object", "properties": { "entityType": { "type": "string", "description": "The type of entity that the tax registration belongs to. **Possible values**: - `BUYER` (Indicates that this is the buyer's tax registration information) - `MERCHANT` (Indicates that this is the merchant's tax registration information) - `MARKETPLACE` (Indicates that this is the marketplace's tax registration information)" }, "legalName": { "type": "string", "description": "The legal name associated with the tax registration." }, "taxRegistrationType": { "type": "string", "description": "The type of the tax registration number. **Possible values**: `BUSINESS`, `VAT`, `CST`, `CPF`, `CNPJ`" }, "taxRegistrationNumber": { "type": "string", "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } }, "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAttributes": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the tax registration attribute. **Possible values**: `TAX_OFFICE`" }, "value": { "type": "string", "description": "The value of the tax registration attribute." } } }, "description": "Additional attributes related to the tax registration." } } }, "orders_2026_01_01_PackageItem": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "Unique identifier of the order item included in this package." }, "quantity": { "type": "number", "description": "Number of units of this item included in the package shipment." }, "transparencyCodes": { "type": "array", "items": { "type": "string" }, "description": "The transparency codes associated with this item for product authentication." } }, "required": [ "orderItemId", "quantity" ] }, "orders_2026_01_01_PackageStatus": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "IN_TRANSIT", "SHIPPED", "DELIVERED", "CANCELLED", "UNDELIVERABLE" ], "description": "Primary status classification of the package in the shipping workflow." }, "detailedStatus": { "type": "string", "description": "Granular status information providing specific details about the package's current location and handling stage. **Possible values**: - `PENDING_SCHEDULE` (Package awaiting pickup scheduling) - `PENDING_PICK_UP` (Package ready for carrier collection from seller) - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier) - `LABEL_CANCELLED` (Shipping label canceled by seller) - `PICKED_UP` (Package collected by carrier from seller location) - `DROPPED_OFF` (Package delivered to carrier by seller) - `AT_ORIGIN_FC` (Package at originating fulfillment center) - `AT_DESTINATION_FC` (Package at destination fulfillment center) - `DELIVERED` (Package successfully delivered to recipient) - `REJECTED_BY_BUYER` (Package refused by intended recipient) - `UNDELIVERABLE` (Package cannot be delivered due to address or access issues) - `RETURNING_TO_SELLER` (Package in transit back to seller) - `RETURNED_TO_SELLER` (Package successfully returned to seller) - `LOST` (Package location unknown or confirmed lost) - `OUT_FOR_DELIVERY` (Package on delivery vehicle for final delivery) - `DAMAGED` (Package damaged during transit)" } }, "required": [ "status" ] }, "orders_2026_01_01_Pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that can be used to fetch the next page of results." } } }, "orders_2026_01_01_PaymentExecution": { "type": "object", "properties": { "paymentMethod": { "type": "string", "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "paymentAmount": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "acquirerId": { "type": "string", "description": "The unique identifier of the payment processor or acquiring bank that authorizes the payment. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." }, "cardBrand": { "type": "string", "description": "The card network or brand used in the payment transaction (for example, Visa or Mastercard). **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard`." }, "authorizationCode": { "type": "string", "description": "The unique code that confirms the payment authorization. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." } } }, "orders_2026_01_01_PointsGranted": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "Total number of Amazon Points granted to the customer's account for this item purchase." }, "pointsMonetaryValue": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Total number of Amazon Points granted to the customer's account for this item purchase." } } }, "orders_2026_01_01_PreferredDeliveryCapability": { "type": "string" }, "orders_2026_01_01_PreferredDeliveryTime": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "enum": [ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" ], "description": "Specific day of the week for which operating hours are being defined." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Collection of time windows during which the location is available for deliveries on the specified day." } } }, "description": "Business hours when the business is open for deliveries." }, "exceptionDates": { "type": "array", "items": { "type": "object", "properties": { "exceptionDate": { "type": "string", "description": "Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity." }, "exceptionDateType": { "type": "string", "enum": [ "CLOSED", "OPEN" ], "description": "Operational status of the business on the specified exception date." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Alternative operating hours that apply specifically to this exception date." } } }, "description": "Specific dates within the next 30 days when normal business hours do not apply." } } }, "orders_2026_01_01_Recipient": { "type": "object", "properties": { "deliveryAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } } }, "deliveryPreference": { "type": "object", "properties": { "dropOffLocation": { "type": "string", "description": "The drop-off location selected by the customer." }, "addressInstruction": { "type": "string", "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryTime": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "enum": [ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" ], "description": "Specific day of the week for which operating hours are being defined." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Collection of time windows during which the location is available for deliveries on the specified day." } } }, "description": "Business hours when the business is open for deliveries." }, "exceptionDates": { "type": "array", "items": { "type": "object", "properties": { "exceptionDate": { "type": "string", "description": "Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity." }, "exceptionDateType": { "type": "string", "enum": [ "CLOSED", "OPEN" ], "description": "Operational status of the business on the specified exception date." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Alternative operating hours that apply specifically to this exception date." } } }, "description": "Specific dates within the next 30 days when normal business hours do not apply." } }, "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryCapabilities": { "type": "array", "items": { "type": "string" }, "description": "A list of miscellaneous delivery capabilities associated with the shipping address." } } } } }, "orders_2026_01_01_SalesChannel": { "type": "object", "properties": { "channelName": { "type": "string", "description": "The name of the sales platform or channel where the customer placed this order. **Possible values**: `AMAZON`, `NON_AMAZON`" }, "marketplaceId": { "type": "string", "description": "The unique identifier for the specific marketplace within the sales channel where this order was placed." }, "marketplaceName": { "type": "string", "description": "The human-readable name of the marketplace where this order was placed." } }, "required": [ "channelName" ] }, "orders_2026_01_01_SearchOrdersResponse": { "type": "object", "properties": { "orders": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "An Amazon-defined order identifier." }, "orderAliases": { "type": "array", "items": { "type": "object", "properties": { "aliasId": { "type": "string", "description": "The alternative identifier value that can be used to reference this order." }, "aliasType": { "type": "string", "description": "The kind of alternative identifier this represents. **Possible values**: `SELLER_ORDER_ID`" } }, "required": [ "aliasId", "aliasType" ] }, "description": "Alternative identifiers that can be used to reference this order, such as seller-defined order numbers." }, "createdTime": { "type": "string", "description": "The time when the customer placed the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "lastUpdatedTime": { "type": "string", "description": "The most recent time when any aspect of this order was modified by Amazon or the seller. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "programs": { "type": "array", "items": { "type": "string" }, "description": "Special programs associated with this order that may affect fulfillment or customer experience. **Possible values**: `AMAZON_BAZAAR`, `AMAZON_BUSINESS`, `AMAZON_EASY_SHIP`, `AMAZON_HAUL`, `DELIVERY_BY_AMAZON`, `FBM_SHIP_PLUS`, `INVOICE_BY_AMAZON`, `IN_STORE_PICK_UP`, `PREMIUM`, `PREORDER`, `PRIME`" }, "associatedOrders": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The unique identifier of the related order that is associated with the current order." }, "associationType": { "type": "string", "description": "The relationship between the current order and the associated order. **Possible values**: `REPLACEMENT_ORIGINAL_ID`, `EXCHANGE_ORIGINAL_ID`" } } }, "description": "Other orders that have a direct relationship to this order, such as replacement or exchange orders." }, "salesChannel": { "type": "object", "properties": { "channelName": { "type": "string", "description": "The name of the sales platform or channel where the customer placed this order. **Possible values**: `AMAZON`, `NON_AMAZON`" }, "marketplaceId": { "type": "string", "description": "The unique identifier for the specific marketplace within the sales channel where this order was placed." }, "marketplaceName": { "type": "string", "description": "The human-readable name of the marketplace where this order was placed." } }, "required": [ "channelName" ], "description": "Other orders that have a direct relationship to this order, such as replacement or exchange orders." }, "buyer": { "type": "object", "properties": { "buyerName": { "type": "string", "description": "The full name of the customer who placed the order." }, "buyerEmail": { "type": "string", "description": "The anonymized email address of the buyer. **Note:** Only available for merchant-fulfilled (FBM) orders." }, "buyerCompanyName": { "type": "string", "description": "The name of the company or organization for a business order." }, "buyerPurchaseOrderNumber": { "type": "string", "description": "The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } } }, "recipient": { "type": "object", "properties": { "deliveryAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } } }, "deliveryPreference": { "type": "object", "properties": { "dropOffLocation": { "type": "string", "description": "The drop-off location selected by the customer." }, "addressInstruction": { "type": "string", "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryTime": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "enum": [ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" ], "description": "Specific day of the week for which operating hours are being defined." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Collection of time windows during which the location is available for deliveries on the specified day." } } }, "description": "Business hours when the business is open for deliveries." }, "exceptionDates": { "type": "array", "items": { "type": "object", "properties": { "exceptionDate": { "type": "string", "description": "Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity." }, "exceptionDateType": { "type": "string", "enum": [ "CLOSED", "OPEN" ], "description": "Operational status of the business on the specified exception date." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Alternative operating hours that apply specifically to this exception date." } } }, "description": "Specific dates within the next 30 days when normal business hours do not apply." } }, "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryCapabilities": { "type": "array", "items": { "type": "string" }, "description": "A list of miscellaneous delivery capabilities associated with the shipping address." } } } } }, "proceeds": { "type": "object", "properties": { "grandTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The proceeds category. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `TAX`, `DISCOUNT`, `DELIVERY_TIP`, `OTHER`. **Note:** `DELIVERY_TIP` is charged separately and not attributed to a specific item. The remaining categories are aggregated across all order items." }, "status": { "type": "string", "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." } }, "required": [ "type", "subtotal" ] }, "description": "Categorized proceeds for the order. Proceed categories are either aggregated across all order items (such as `ITEM`, `SHIPPING`, and `TAX`) or applied at the order level (such as `DELIVERY_TIP`)." } } }, "payment": { "type": "object", "properties": { "paymentExecutions": { "type": "array", "items": { "type": "object", "properties": { "paymentMethod": { "type": "string", "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "paymentAmount": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "acquirerId": { "type": "string", "description": "The unique identifier of the payment processor or acquiring bank that authorizes the payment. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." }, "cardBrand": { "type": "string", "description": "The card network or brand used in the payment transaction (for example, Visa or Mastercard). **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard`." }, "authorizationCode": { "type": "string", "description": "The unique code that confirms the payment authorization. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." } } }, "description": "A list of payment executions for the order." } } }, "tax": { "type": "object", "properties": { "taxRegistrations": { "type": "array", "items": { "type": "object", "properties": { "entityType": { "type": "string", "description": "The type of entity that the tax registration belongs to. **Possible values**: - `BUYER` (Indicates that this is the buyer's tax registration information) - `MERCHANT` (Indicates that this is the merchant's tax registration information) - `MARKETPLACE` (Indicates that this is the marketplace's tax registration information)" }, "legalName": { "type": "string", "description": "The legal name associated with the tax registration." }, "taxRegistrationType": { "type": "string", "description": "The type of the tax registration number. **Possible values**: `BUSINESS`, `VAT`, `CST`, `CPF`, `CNPJ`" }, "taxRegistrationNumber": { "type": "string", "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } }, "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAttributes": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the tax registration attribute. **Possible values**: `TAX_OFFICE`" }, "value": { "type": "string", "description": "The value of the tax registration attribute." } } }, "description": "Additional attributes related to the tax registration." } } }, "description": "A list of tax registrations associated with the order." }, "taxInvoicing": { "type": "object", "properties": { "buyerInvoicePreference": { "type": "string", "description": "The buyer's invoicing preference, which indicates whether the seller should issue an individual or a business invoice to the buyer. **Note**: This attribute is only available in the Turkey marketplace. **Possible values**: - `INDIVIDUAL` (Issues an individual invoice to the buyer) - `BUSINESS` (Issues a business invoice to the buyer)" }, "invoiceStatus": { "type": "string", "description": "The status of the invoice. Only available for Easy Ship orders and orders in the Brazil marketplace. **Possible values**: - `NOT_REQUIRED` (The order does not require an electronic invoice to be uploaded) - `NOT_FOUND` (The order requires an electronic invoice but it is not uploaded) - `PROCESSING` (The required electronic invoice was uploaded and is processing) - `ERRORED` (The uploaded electronic invoice was not accepted) - `ACCEPTED` (The uploaded electronic invoice was accepted)" } }, "description": "A list of tax registrations associated with the order." } } }, "fulfillment": { "type": "object", "properties": { "fulfillmentStatus": { "type": "string", "enum": [ "PENDING_AVAILABILITY", "PENDING", "UNSHIPPED", "PARTIALLY_SHIPPED", "SHIPPED", "CANCELLED", "UNFULFILLABLE" ] }, "fulfilledBy": { "type": "string", "description": "Specifies whether Amazon or the merchant is responsible for fulfilling this order. **Possible values**: `AMAZON`, `MERCHANT`." }, "fulfillmentServiceLevel": { "type": "string", "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "shipByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } }, "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "deliverByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "labelPrintingWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } } }, "required": [ "fulfillmentStatus" ] }, "orderItems": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "A unique identifier for this specific item within the order." }, "quantityOrdered": { "type": "number", "description": "The number of units of this item that the customer ordered." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "The number of units of this item that the customer ordered." }, "associatedOrderItems": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The order identifier of the associated order item." }, "orderItemId": { "type": "string", "description": "The order item identifier of the associated order item." }, "associationType": { "type": "string", "description": "The type of association between the order items. **Possible values**: - `VALUE_ADD_SERVICE` (The associated item is a service order)" } } }, "description": "A list of order items associated with this item. For example, a value-add service purchased with the product." }, "programs": { "type": "array", "items": { "type": "string" }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "product": { "type": "object", "properties": { "asin": { "type": "string" }, "title": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "sellerSku": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "condition": { "type": "object", "properties": { "conditionType": { "type": "string", "description": "The primary condition category that broadly describes the item's state. **Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`." }, "conditionSubtype": { "type": "string", "description": "A more specific condition classification that provides additional detail about the item's quality within the main condition type. **Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`, `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`." }, "conditionNote": { "type": "string", "description": "Additional details provided by the seller to describe the specific condition of this particular item." } } }, "price": { "type": "object", "properties": { "unitPrice": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "priceDesignation": { "type": "string", "description": "Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Possible value**: `BUSINESS_PRICE`" } } }, "serialNumbers": { "type": "array", "items": { "type": "string" }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." }, "customization": { "type": "object", "properties": { "customizedUrl": { "type": "string", "description": "The URL of the customized data for custom orders from the Amazon Custom program." } }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." } }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "proceeds": { "type": "object", "properties": { "proceedsTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "detailedBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "subtype": { "type": "string", "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" }, "value": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" } } }, "description": "Further granular breakdown of the subtotal." } }, "required": [ "type", "subtotal" ] }, "description": "The breakdown of proceeds." } } }, "expense": { "type": "object", "properties": { "pointsCost": { "type": "object", "properties": { "pointsGranted": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "Total number of Amazon Points granted to the customer's account for this item purchase." }, "pointsMonetaryValue": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Total number of Amazon Points granted to the customer's account for this item purchase." } } } } } } }, "promotion": { "type": "object", "properties": { "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "promotionId": { "type": "string", "description": "Unique identifier for the promotion applied to this item." } } }, "description": "A list of promotions applied to the order item." } } }, "cancellation": { "type": "object", "properties": { "cancellationRequest": { "type": "object", "properties": { "requester": { "type": "string", "description": "Entity that initiated the cancellation request for this item. **Possible values**: `BUYER`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was requested." } } }, "cancellationExecution": { "type": "object", "properties": { "cancelledBy": { "type": "string", "description": "Entity that executed the cancellation for this item. **Possible values**: `BUYER`, `MERCHANT`, `AMAZON`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was executed." } } } } }, "fulfillment": { "type": "object", "properties": { "quantityFulfilled": { "type": "number", "description": "The number of units of this item that have been successfully processed and shipped." }, "quantityUnfulfilled": { "type": "number", "description": "The number of units of this item that remain to be processed and shipped." }, "picking": { "type": "object", "properties": { "substitutionPreference": { "type": "object", "properties": { "substitutionType": { "type": "string", "enum": [ "CUSTOMER_PREFERENCE", "AMAZON_RECOMMENDED", "DO_NOT_SUBSTITUTE" ], "description": "Source and nature of the substitution preferences for this item." }, "substitutionOptions": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number of the substitute product." }, "quantityOrdered": { "type": "number", "description": "Number of units of the substitute item to be selected if substitution occurs." }, "sellerSku": { "type": "string", "description": "The item's seller stock keeping unit (SKU)." }, "title": { "type": "string", "description": "Product name or title of the substitute item as displayed to customers." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "Product name or title of the substitute item as displayed to customers." } } }, "description": "List of alternative products that can be substituted for the original item if it becomes unavailable." } }, "required": [ "substitutionType" ] } }, "description": "The number of units of this item that remain to be processed and shipped." }, "packing": { "type": "object", "properties": { "giftOption": { "type": "object", "properties": { "giftMessage": { "type": "string", "description": "Personal message from the buyer to be included with the gift-wrapped item." }, "giftWrapLevel": { "type": "string", "description": "Type or quality level of gift wrapping service selected by the customer." } } }, "serialNumberRequirement": { "type": "object", "properties": { "requirementType": { "type": "string", "description": "The requirement type for this request. **Possible values**: `REQUIRED`" } } } } }, "shipping": { "type": "object", "properties": { "scheduledDeliveryWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "shippingConstraints": { "type": "object", "properties": { "palletDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "cashOnDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "signatureConfirmation": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientIdentityVerification": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientAgeVerification": { "type": "string", "enum": [ "MANDATORY" ] } } }, "internationalShipping": { "type": "object", "properties": { "iossNumber": { "type": "string", "description": "Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale." } } } } } } }, "tax": { "type": "object", "properties": { "taxCalculationBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "reportingScheme": { "type": "string", "description": "The tax reporting scheme applied to this order item. **Possible values**: - `UOSS` (Union one stop shop. The item being purchased is held in the EU for shipment) - `IOSS` (Import one stop shop. The item being purchased is not held in the EU for shipment)" } } }, "description": "A list of tax calculation breakdowns for the order item." }, "taxCollections": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "description": "The tax collection model applied to the item. **Possible values**: - `MARKETPLACE_FACILITATOR` (Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller)" }, "responsibleParty": { "type": "string", "description": "The party responsible for withholding the taxes and remitting them to the taxing authority." } } }, "description": "A list of tax collections for the order item." } } } }, "required": [ "orderItemId", "quantityOrdered", "product" ] }, "description": "The list of all order items included in this order." }, "packages": { "type": "array", "items": { "type": "object", "properties": { "packageReferenceId": { "type": "string", "description": "A unique identifier for this package within the context of the order." }, "createdTime": { "type": "string", "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "packageStatus": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "IN_TRANSIT", "SHIPPED", "DELIVERED", "CANCELLED", "UNDELIVERABLE" ], "description": "Primary status classification of the package in the shipping workflow." }, "detailedStatus": { "type": "string", "description": "Granular status information providing specific details about the package's current location and handling stage. **Possible values**: - `PENDING_SCHEDULE` (Package awaiting pickup scheduling) - `PENDING_PICK_UP` (Package ready for carrier collection from seller) - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier) - `LABEL_CANCELLED` (Shipping label canceled by seller) - `PICKED_UP` (Package collected by carrier from seller location) - `DROPPED_OFF` (Package delivered to carrier by seller) - `AT_ORIGIN_FC` (Package at originating fulfillment center) - `AT_DESTINATION_FC` (Package at destination fulfillment center) - `DELIVERED` (Package successfully delivered to recipient) - `REJECTED_BY_BUYER` (Package refused by intended recipient) - `UNDELIVERABLE` (Package cannot be delivered due to address or access issues) - `RETURNING_TO_SELLER` (Package in transit back to seller) - `RETURNED_TO_SELLER` (Package successfully returned to seller) - `LOST` (Package location unknown or confirmed lost) - `OUT_FOR_DELIVERY` (Package on delivery vehicle for final delivery) - `DAMAGED` (Package damaged during transit)" } }, "required": [ "status" ], "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "carrier": { "type": "string", "description": "The carrier responsible for transporting this package to the customer." }, "shipTime": { "type": "string", "description": "The exact time when this package was handed over to the carrier and began its journey to the customer. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "shippingService": { "type": "string", "description": "The specific shipping method or service used for delivering this package." }, "trackingNumber": { "type": "string", "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "shipFromAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the business or facility at this address." }, "addressLine1": { "type": "string", "description": "The primary street address of the merchant's location." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code or ZIP code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code for the address, in ISO 3166-1 format." } }, "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "packageItems": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "Unique identifier of the order item included in this package." }, "quantity": { "type": "number", "description": "Number of units of this item included in the package shipment." }, "transparencyCodes": { "type": "array", "items": { "type": "string" }, "description": "The transparency codes associated with this item for product authentication." } }, "required": [ "orderItemId", "quantity" ] }, "description": "A list of all order items included in this specific package." } }, "required": [ "packageReferenceId" ] }, "description": "Shipping packages created for this order, including tracking information. **Note:** Only available for merchant-fulfilled (FBM) orders." }, "fulfillmentOrders": { "type": "array", "items": { "type": "object", "properties": { "fulfillmentOrderId": { "type": "string", "description": "The Fulfillment Order ID assigned by Amazon after fulfillment planning. This identifier is identical to the Shipment ID required by External Fulfillment APIs." } }, "required": [ "fulfillmentOrderId" ] }, "description": "The list of fulfillment orders associated with this customer order. Each entry corresponds to one fulfillment unit created by Amazon for this order. **Note:** Only available for EasyShip orders at present." } }, "required": [ "orderId", "createdTime", "lastUpdatedTime", "salesChannel", "orderItems" ] }, "description": "An array containing all orders that match the search criteria." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that can be used to fetch the next page of results." } }, "description": "An array containing all orders that match the search criteria." }, "lastUpdatedBefore": { "type": "string", "description": "Only orders updated before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "createdBefore": { "type": "string", "description": "Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } }, "required": [ "orders" ] }, "orders_2026_01_01_SerialNumberRequirement": { "type": "object", "properties": { "requirementType": { "type": "string", "description": "The requirement type for this request. **Possible values**: `REQUIRED`" } } }, "orders_2026_01_01_SKU": { "type": "string" }, "orders_2026_01_01_TaxRegistrationAttribute": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the tax registration attribute. **Possible values**: `TAX_OFFICE`" }, "value": { "type": "string", "description": "The value of the tax registration attribute." } } }, "orders_2026_01_01_TimeWindow": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "otp_type": { "type": "string", "enum": [ "app", "email" ] }, "packing_option_status": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] }, "PackingOption": { "type": "object", "properties": { "inbound_plan_id": { "type": "string" }, "packing_option_id": { "type": "string" }, "user_id": { "type": "string" }, "discounts": { "anyOf": [ {}, { "type": "null" } ] }, "expiration": { "type": [ "string", "null" ], "format": "date-time" }, "fees": { "anyOf": [ {}, { "type": "null" } ] }, "packing_groups": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "packingGroupId": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] } } }, "required": [ "packingGroupId" ] } }, "status": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] }, "supported_shipping_configurations": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "confirm_packing_option_operation": { "anyOf": [ {}, { "type": "null" } ] }, "plan_id": { "type": [ "string", "null" ] }, "ship_from_id": { "type": [ "string", "null" ] } }, "required": [ "inbound_plan_id", "packing_option_id", "user_id", "discounts", "expiration", "fees", "packing_groups", "status", "supported_shipping_configurations", "created", "created_by", "updated", "updated_by", "confirm_packing_option_operation", "plan_id", "ship_from_id" ] }, "PackingOptionPackingGroups": { "type": "array", "items": { "type": "object", "properties": { "packingGroupId": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] } } }, "required": [ "packingGroupId" ] } }, "PackTemplate": { "type": "object", "properties": { "pack_template_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "owner": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center", "nullable": false }, "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center", "nullable": false }, "length": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ], "nullable": false }, "weight": { "type": "number", "nullable": false }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ], "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false } }, "required": [ "pack_template_id", "user_id", "owner", "pack_template_name", "length", "width", "height", "unit_of_measurement", "weight", "unit_of_weight", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by" ] }, "PagesOpts": { "type": "object", "properties": { "all_pages": { "type": "boolean", "description": "loop through all pages. defaults to true" }, "maybe_202": { "type": "boolean", "description": "return a 202 response if we have to wait for more than 5 seconds. defaults to true" }, "sleepMs": { "type": "number", "description": "how long to sleep between pages. defaults to 500ms" } } }, "PatchListingsItemBody": { "type": "object", "properties": { "productType": { "type": "string", "description": "The Amazon product type of the listings item.", "nullable": false }, "patches": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "replace", "merge", "delete" ], "description": "Type of JSON Patch operation. Supported JSON Patch operations include `add`, `replace`, `merge` and `delete`. Refer to .", "nullable": false }, "path": { "type": "string", "description": "JSON Pointer path of the element to patch. Refer to [JavaScript Object Notation (JSON) Patch](https://tools.ietf.org/html/rfc6902) for more information.", "nullable": false }, "value": { "type": [ "array", "null" ], "items": {}, "description": "JSON value to `add`, `replace`, `merge` or `delete`." } }, "required": [ "op", "path" ] }, "description": "One or more JSON Patch operations to perform on the listings item.", "nullable": false } }, "required": [ "productType", "patches" ] }, "PatchListingsItemErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses." } }, "required": [ "errors" ] }, "PatchListingsItemResponse": { "type": "object", "properties": { "sku": { "type": "string", "description": "A selling partner-provided identifier for an Amazon listing." }, "status": { "type": "string", "enum": [ "ACCEPTED", "INVALID", "VALID" ], "description": "The status of the listings item submission." }, "submissionId": { "type": "string", "description": "The unique identifier of the listings item submission." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] }, "description": "Listings item issues related to the listings item submission." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." } } }, "description": "Listings item issues related to the listings item submission." } }, "required": [ "sku", "status", "submissionId" ] }, "PatchListingsItemSearchParams": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" } }, "includedData": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "identifiers", "issues" ] } } ] }, "mode": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "VALIDATION_PREVIEW" ] } ] }, "issueLocale": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceIds", "mp" ] }, "PickList": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "location_name": { "type": "string" }, "quantity": { "type": "number" }, "location_id": { "type": "string", "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] } }, "PickListRow": { "type": "object", "properties": { "sku": { "type": "string" }, "location_name": { "type": "string" }, "quantity": { "type": "number" }, "location_id": { "type": "string", "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] }, "placement_option_status": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] }, "PlacementOption": { "type": "object", "properties": { "placement_option_id": { "type": "string" }, "user_id": { "type": "string" }, "inbound_plan_id": { "type": "string" }, "discounts": { "anyOf": [ {}, { "type": "null" } ] }, "expiration": { "type": [ "string", "null" ], "format": "date-time" }, "fees": { "anyOf": [ {}, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] }, "shipment_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "confirm_placement_option_operation": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "placement_option_id", "user_id", "inbound_plan_id", "discounts", "expiration", "fees", "status", "shipment_ids", "created", "created_by", "updated", "updated_by", "confirm_placement_option_operation" ] }, "Plan": { "type": "object", "properties": { "plan_id": { "type": "string" }, "user_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": "string" }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the plan was created" }, "errors": { "anyOf": [ { "description": "The method by which the plan was created" }, { "type": "null" } ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id" }, "flow": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ], "description": "For Walmart plans, this is the inbound_order_id" }, "location_id": { "type": [ "string", "null" ] }, "pick_list": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string" }, "location_name": { "type": "string" }, "quantity": { "type": "number" }, "location_id": { "type": "string", "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] } }, "content_information_source": { "type": [ "string", "null" ], "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "description": "When PO items are imported into a plan, this is a list of what locations in the warehouse contain the imported items." }, "status": { "type": "string", "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ] }, "prep_matrix_type": { "type": [ "string", "null" ] }, "prep_matrix_price": { "type": [ "number", "null" ] }, "prep_matrix_currency_code": { "type": [ "string", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "type": [ "object", "null" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "customPlacement": { "type": "array", "items": { "type": "object", "properties": { "warehouseId": { "type": "string" }, "mskus": { "type": "array", "items": { "type": "string" } } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": "string", "description": "Expected delivery date for shipment" } }, "description": "Data used to generate WM Inbound Preview or AZ Inbound Plan" } }, "required": [ "plan_id", "user_id", "marketplace_id", "ship_from_id", "fulfillment_channel", "created", "created_by", "creation_source", "errors", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by", "plan_name", "flow", "location_id", "pick_list", "content_information_source", "status", "prep_matrix_type", "prep_matrix_price", "prep_matrix_currency_code", "expected_delivery_date", "data" ] }, "PlanData": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "customPlacement": { "type": "array", "items": { "type": "object", "properties": { "warehouseId": { "type": "string" }, "mskus": { "type": "array", "items": { "type": "string" } } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": "string", "description": "Expected delivery date for shipment" } } }, "PlanInput": { "type": "object", "properties": { "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "ship_from_id": { "type": "string", "nullable": false }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ], "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false, "description": "The method by which the plan was created" }, "errors": { "nullable": false, "description": "The method by which the plan was created" }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id", "nullable": false }, "flow": { "type": "string", "enum": [ "pack_first", "pack_later" ], "nullable": false, "description": "For Walmart plans, this is the inbound_order_id" }, "location_id": { "type": "string", "nullable": false }, "pick_list": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "location_name": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "location_id": { "type": [ "string", "null" ], "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] }, "nullable": false }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "nullable": false, "description": "When PO items are imported into a plan, this is a list of what locations in the warehouse contain the imported items." }, "status": { "type": "string", "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ], "nullable": false }, "prep_matrix_type": { "type": "string", "nullable": false }, "prep_matrix_price": { "type": "number", "nullable": false }, "prep_matrix_currency_code": { "type": "string", "nullable": false }, "expected_delivery_date": { "type": "string", "format": "date-time", "nullable": false }, "data": { "type": "object", "properties": { "email": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "phoneNumber": { "type": [ "string", "null" ] }, "customPlacement": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "warehouseId": { "type": "string", "nullable": false }, "mskus": { "type": "array", "items": { "type": "string" }, "nullable": false } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": [ "string", "null" ], "description": "Expected delivery date for shipment" } }, "nullable": false, "description": "Data used to generate WM Inbound Preview or AZ Inbound Plan" } } }, "PlanItem": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" } }, "required": [ "plan_item_id", "plan_id", "user_id", "sku", "marketplace_id", "quantity", "creation_source", "errors", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by", "expires", "cost", "supplier_id", "lot_code", "packing_group_ids", "print_fnsku_label_quantity", "quantity_in_case", "item_prep" ] }, "PlanItemItemPrep": { "type": "object", "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } } }, "PlanItemPackingGroupIds": { "type": "object", "additionalProperties": { "type": "number" } }, "prep_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ] }, "PrintBillOfLadingSearchParams": { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Unique identifier identifying each shipment." }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ], "description": "The classification of the shipment based on the nature of the goods and the method of transportation." }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "Product": { "type": "object", "properties": { "external_id": { "type": "string", "description": "The Amazon ASIN, or Walmart WPID, etc." }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "The Amazon ASIN, or Walmart WPID, etc." }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "anyOf": [ { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "type": "string" } }, "required": [ "value" ] } }, { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "type": "string" } }, "required": [ "value" ] } ] }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } } } }, { "type": "object", "properties": {} } ] }, { "type": "null" } ] }, "meltable": { "type": [ "boolean", "null" ], "description": "Channel-specific data received from one or more APIs" }, "expiration_required": { "type": [ "boolean", "null" ] }, "hazmat": { "type": [ "string", "null" ] }, "size": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "dims": { "anyOf": [ {}, { "type": "null" } ] }, "feed_data": { "anyOf": [ { "description": "Inputs to various walmart feed types." }, { "type": "null" } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data" ] }, "ProductData": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } } } }, { "type": "object", "properties": {} } ] }, "ProductFeedData": {}, "productFeesV0_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "productFeesV0_ErrorList": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } }, "productFeesV0_FeeDetail": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] }, "productFeesV0_FeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } }, "productFeesV0_FeesEstimate": { "type": "object", "properties": { "TimeOfFeesEstimation": { "type": "string", "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "TotalFeesEstimate": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "FeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "TimeOfFeesEstimation" ] }, "productFeesV0_FeesEstimateByIdRequest": { "type": "object", "properties": { "FeesEstimateRequest": { "type": [ "object", "null" ], "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier.", "nullable": false }, "IsAmazonFulfilled": { "type": [ "boolean", "null" ], "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "nullable": false }, "Shipping": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } } }, "Points": { "type": [ "object", "null" ], "properties": { "PointsNumber": { "type": [ "number", "null" ], "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon.", "nullable": false }, "Identifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request.", "nullable": false }, "OptionalFulfillmentProgram": { "type": [ "string", "null" ], "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "required": [ "MarketplaceId", "PriceToEstimateFees", "Identifier" ] }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "nullable": false }, "IdValue": { "type": "string", "description": "The item identifier.", "nullable": false } }, "required": [ "IdType", "IdValue" ] }, "productFeesV0_FeesEstimateError": { "type": "object", "properties": { "Type": { "type": "string", "description": "An error type, identifying either the receiver or the sender as the originator of the error." }, "Code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "Message": { "type": "string", "description": "A message that describes the error condition." }, "Detail": { "type": "array", "items": { "type": "object" }, "description": "A message that describes the error condition." } }, "required": [ "Type", "Code", "Message", "Detail" ] }, "productFeesV0_FeesEstimateErrorDetail": { "type": "array", "items": { "type": "object" } }, "productFeesV0_FeesEstimateIdentifier": { "type": "object", "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier." }, "SellerId": { "type": "string", "description": "The seller identifier." }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "description": "The seller identifier." }, "IdValue": { "type": "string", "description": "The item identifier." }, "IsAmazonFulfilled": { "type": "boolean", "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Shipping": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Points": { "type": "object", "properties": { "PointsNumber": { "type": "number", "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon." }, "SellerInputIdentifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request." }, "OptionalFulfillmentProgram": { "type": "string", "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } } }, "productFeesV0_FeesEstimateRequest": { "type": "object", "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier.", "nullable": false }, "IsAmazonFulfilled": { "type": [ "boolean", "null" ], "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "nullable": false }, "Shipping": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } } }, "Points": { "type": [ "object", "null" ], "properties": { "PointsNumber": { "type": [ "number", "null" ], "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon.", "nullable": false }, "Identifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request.", "nullable": false }, "OptionalFulfillmentProgram": { "type": [ "string", "null" ], "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "required": [ "MarketplaceId", "PriceToEstimateFees", "Identifier" ] }, "productFeesV0_FeesEstimateResult": { "type": "object", "properties": { "Status": { "type": "string", "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimateIdentifier": { "type": "object", "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier." }, "SellerId": { "type": "string", "description": "The seller identifier." }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "description": "The seller identifier." }, "IdValue": { "type": "string", "description": "The item identifier." }, "IsAmazonFulfilled": { "type": "boolean", "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Shipping": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Points": { "type": "object", "properties": { "PointsNumber": { "type": "number", "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon." }, "SellerInputIdentifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request." }, "OptionalFulfillmentProgram": { "type": "string", "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimate": { "type": "object", "properties": { "TimeOfFeesEstimation": { "type": "string", "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "TotalFeesEstimate": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "FeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "TimeOfFeesEstimation" ] }, "Error": { "type": "object", "properties": { "Type": { "type": "string", "description": "An error type, identifying either the receiver or the sender as the originator of the error." }, "Code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "Message": { "type": "string", "description": "A message that describes the error condition." }, "Detail": { "type": "array", "items": { "type": "object" }, "description": "A message that describes the error condition." } }, "required": [ "Type", "Code", "Message", "Detail" ] } } }, "productFeesV0_GetMyFeesEstimateResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "FeesEstimateResult": { "type": "object", "properties": { "Status": { "type": "string", "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimateIdentifier": { "type": "object", "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier." }, "SellerId": { "type": "string", "description": "The seller identifier." }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "description": "The seller identifier." }, "IdValue": { "type": "string", "description": "The item identifier." }, "IsAmazonFulfilled": { "type": "boolean", "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Shipping": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Points": { "type": "object", "properties": { "PointsNumber": { "type": "number", "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon." }, "SellerInputIdentifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request." }, "OptionalFulfillmentProgram": { "type": "string", "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimate": { "type": "object", "properties": { "TimeOfFeesEstimation": { "type": "string", "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "TotalFeesEstimate": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "FeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "TimeOfFeesEstimation" ] }, "Error": { "type": "object", "properties": { "Type": { "type": "string", "description": "An error type, identifying either the receiver or the sender as the originator of the error." }, "Code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "Message": { "type": "string", "description": "A message that describes the error condition." }, "Detail": { "type": "array", "items": { "type": "object" }, "description": "A message that describes the error condition." } }, "required": [ "Type", "Code", "Message", "Detail" ] } } } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "productFeesV0_GetMyFeesEstimateResult": { "type": "object", "properties": { "FeesEstimateResult": { "type": "object", "properties": { "Status": { "type": "string", "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimateIdentifier": { "type": "object", "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier." }, "SellerId": { "type": "string", "description": "The seller identifier." }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "description": "The seller identifier." }, "IdValue": { "type": "string", "description": "The item identifier." }, "IsAmazonFulfilled": { "type": "boolean", "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Shipping": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Points": { "type": "object", "properties": { "PointsNumber": { "type": "number", "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon." }, "SellerInputIdentifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request." }, "OptionalFulfillmentProgram": { "type": "string", "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimate": { "type": "object", "properties": { "TimeOfFeesEstimation": { "type": "string", "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "TotalFeesEstimate": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "FeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "TimeOfFeesEstimation" ] }, "Error": { "type": "object", "properties": { "Type": { "type": "string", "description": "An error type, identifying either the receiver or the sender as the originator of the error." }, "Code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "Message": { "type": "string", "description": "A message that describes the error condition." }, "Detail": { "type": "array", "items": { "type": "object" }, "description": "A message that describes the error condition." } }, "required": [ "Type", "Code", "Message", "Detail" ] } } } } }, "productFeesV0_GetMyFeesEstimatesResponse": { "type": "array", "items": { "type": "object", "properties": { "Status": { "type": "string", "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimateIdentifier": { "type": "object", "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier." }, "SellerId": { "type": "string", "description": "The seller identifier." }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "description": "The seller identifier." }, "IdValue": { "type": "string", "description": "The item identifier." }, "IsAmazonFulfilled": { "type": "boolean", "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Shipping": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Points": { "type": "object", "properties": { "PointsNumber": { "type": "number", "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon." }, "SellerInputIdentifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request." }, "OptionalFulfillmentProgram": { "type": "string", "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimate": { "type": "object", "properties": { "TimeOfFeesEstimation": { "type": "string", "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "TotalFeesEstimate": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "FeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "TimeOfFeesEstimation" ] }, "Error": { "type": "object", "properties": { "Type": { "type": "string", "description": "An error type, identifying either the receiver or the sender as the originator of the error." }, "Code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "Message": { "type": "string", "description": "A message that describes the error condition." }, "Detail": { "type": "array", "items": { "type": "object" }, "description": "A message that describes the error condition." } }, "required": [ "Type", "Code", "Message", "Detail" ] } } } }, "productFeesV0_IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ] }, "productFeesV0_IncludedFeeDetail": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] }, "productFeesV0_IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } }, "productFeesV0_MoneyType": { "type": "object", "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } } }, "productFeesV0_OptionalFulfillmentProgram": { "type": "string", "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ] }, "productFeesV0_Points": { "type": "object", "properties": { "PointsNumber": { "type": [ "number", "null" ], "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "description": "The number of Amazon Points" } } }, "productFeesV0_PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "nullable": false }, "Shipping": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } } }, "Points": { "type": [ "object", "null" ], "properties": { "PointsNumber": { "type": [ "number", "null" ], "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ] }, "productPricing_2022_05_01_AmountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] }, "productPricing_2022_05_01_Asin": { "type": "string" }, "productPricing_2022_05_01_CompetitiveSummaryBatchResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "The HTTP response status code." }, "reasonPhrase": { "type": "string", "description": "The HTTP response reason phrase." } } }, "body": { "type": "object", "properties": { "asin": { "type": "string" }, "marketplaceId": { "type": "string" }, "featuredBuyingOptions": { "type": "array", "items": { "type": "object", "properties": { "buyingOptionType": { "type": "string", "enum": [ "New" ], "description": "The buying option type for the featured offer. `buyingOptionType` represents the buying options that a customer receives on the detail page, such as `B2B`, `Fresh`, and `Subscribe n Save`. `buyingOptionType` currently supports `NEW` as a value." }, "segmentedFeaturedOffers": { "type": "array", "items": { "type": "object", "properties": {} }, "description": "A list of segmented featured offers for the current buying option type. A segment can be considered as a group of regional contexts that all have the same featured offer. A regional context is a combination of factors such as customer type, region, or postal code and buying option." } }, "required": [ "buyingOptionType", "segmentedFeaturedOffers" ] }, "description": "A list of featured buying options for the specified ASIN `marketplaceId` combination." }, "lowestPricedOffers": { "type": "array", "items": { "type": "object", "properties": { "lowestPricedOffersInput": { "type": "object", "properties": { "itemCondition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ] }, "offerType": { "type": "string", "enum": [ "Consumer" ], "description": "The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`." } }, "required": [ "itemCondition", "offerType" ] }, "offers": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string", "description": "The seller identifier for the offer." }, "condition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ], "description": "The seller identifier for the offer." }, "subCondition": { "type": "string", "enum": [ "New", "Mint", "VeryGood", "Good", "Acceptable", "Poor", "Club", "OEM", "Warranty", "RefurbishedWarranty", "Refurbished", "OpenBox", "Other" ], "description": "The item subcondition of the offer." }, "fulfillmentType": { "type": "string", "enum": [ "AFN", "MFN" ], "description": "The item subcondition of the offer." }, "listingPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "shippingOptions": { "type": "array", "items": { "type": "object", "properties": { "shippingOptionType": { "type": "string", "enum": [ "DEFAULT" ], "description": "The type of shipping option." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of shipping option." } }, "required": [ "shippingOptionType", "price" ] }, "description": "A list of shipping options associated with this offer" }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points." }, "pointsMonetaryValue": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points." } }, "description": "A list of shipping options associated with this offer" }, "primeDetails": { "type": "object", "properties": { "eligibility": { "type": "string", "enum": [ "NATIONAL", "REGIONAL", "NONE" ], "description": "Indicates whether the offer is an Amazon Prime offer." } }, "required": [ "eligibility" ] }, "promotions": { "type": "array", "items": { "type": "object", "properties": { "promotionType": { "type": "string" }, "promotionSavings": { "type": "object", "properties": { "discount": { "type": "object", "properties": { "type": { "type": "string" }, "amountOff": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "percentOff": { "type": "number", "description": "The percentage discount applied to the original price (1-100). Only valid when type is PERCENTAGE_OFF." } } }, "discountedPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } } } }, "purchaseRequirements": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "quantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "amountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] } } } } } }, "required": [ "promotionType", "promotionSavings" ] } } }, "required": [ "sellerId", "condition", "fulfillmentType", "listingPrice" ] }, "description": "A list of up to 20 lowest priced offers that match the criteria specified in `lowestPricedOffersInput`." } }, "required": [ "lowestPricedOffersInput", "offers" ] }, "description": "A list of lowest priced offers for the specified ASIN `marketplaceId` combination." }, "referencePrices": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." } }, "required": [ "name", "price" ] }, "description": "A list of reference prices for the specified ASIN `marketplaceId` combination." }, "similarItems": { "type": "array", "items": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" } }, "required": [ "asin" ] }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." } } }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." } }, "required": [ "asin", "marketplaceId" ] } }, "required": [ "status", "body" ] } } }, "required": [ "responses" ] }, "productPricing_2022_05_01_CompetitiveSummaryIncludedData": { "type": "string", "enum": [ "featuredBuyingOptions", "referencePrices", "lowestPricedOffers", "similarItems" ] }, "productPricing_2022_05_01_CompetitiveSummaryRequest": { "type": "object", "properties": { "asin": { "type": "string", "nullable": false }, "marketplaceId": { "type": "string", "nullable": false }, "includedData": { "type": "array", "items": { "type": "string", "enum": [ "featuredBuyingOptions", "referencePrices", "lowestPricedOffers", "similarItems" ] }, "description": "The list of requested competitive pricing data for the product.", "nullable": false }, "lowestPricedOffersInputs": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "itemCondition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ], "nullable": false }, "offerType": { "type": "string", "enum": [ "Consumer" ], "description": "The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`.", "nullable": false } }, "required": [ "itemCondition", "offerType" ] }, "description": "The list of `lowestPricedOffersInput` parameters that are used to build `lowestPricedOffers` in the response. This attribute is only valid if `lowestPricedOffers` is requested in `includedData`" }, "method": { "type": "string", "enum": [ "GET", "PUT", "PATCH", "DELETE", "POST" ], "description": "The list of `lowestPricedOffersInput` parameters that are used to build `lowestPricedOffers` in the response. This attribute is only valid if `lowestPricedOffers` is requested in `includedData`", "nullable": false }, "uri": { "type": "string", "nullable": false } }, "required": [ "asin", "marketplaceId", "includedData", "method", "uri" ] }, "productPricing_2022_05_01_CompetitiveSummaryRequestList": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "nullable": false }, "marketplaceId": { "type": "string", "nullable": false }, "includedData": { "type": "array", "items": { "type": "string", "enum": [ "featuredBuyingOptions", "referencePrices", "lowestPricedOffers", "similarItems" ] }, "description": "The list of requested competitive pricing data for the product.", "nullable": false }, "lowestPricedOffersInputs": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "itemCondition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ], "nullable": false }, "offerType": { "type": "string", "enum": [ "Consumer" ], "description": "The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`.", "nullable": false } }, "required": [ "itemCondition", "offerType" ] }, "description": "The list of `lowestPricedOffersInput` parameters that are used to build `lowestPricedOffers` in the response. This attribute is only valid if `lowestPricedOffers` is requested in `includedData`" }, "method": { "type": "string", "enum": [ "GET", "PUT", "PATCH", "DELETE", "POST" ], "description": "The list of `lowestPricedOffersInput` parameters that are used to build `lowestPricedOffers` in the response. This attribute is only valid if `lowestPricedOffers` is requested in `includedData`", "nullable": false }, "uri": { "type": "string", "nullable": false } }, "required": [ "asin", "marketplaceId", "includedData", "method", "uri" ] } }, "productPricing_2022_05_01_CompetitiveSummaryResponse": { "type": "object", "properties": { "status": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "The HTTP response status code." }, "reasonPhrase": { "type": "string", "description": "The HTTP response reason phrase." } } }, "body": { "type": "object", "properties": { "asin": { "type": "string" }, "marketplaceId": { "type": "string" }, "featuredBuyingOptions": { "type": "array", "items": { "type": "object", "properties": { "buyingOptionType": { "type": "string", "enum": [ "New" ], "description": "The buying option type for the featured offer. `buyingOptionType` represents the buying options that a customer receives on the detail page, such as `B2B`, `Fresh`, and `Subscribe n Save`. `buyingOptionType` currently supports `NEW` as a value." }, "segmentedFeaturedOffers": { "type": "array", "items": { "type": "object", "properties": {} }, "description": "A list of segmented featured offers for the current buying option type. A segment can be considered as a group of regional contexts that all have the same featured offer. A regional context is a combination of factors such as customer type, region, or postal code and buying option." } }, "required": [ "buyingOptionType", "segmentedFeaturedOffers" ] }, "description": "A list of featured buying options for the specified ASIN `marketplaceId` combination." }, "lowestPricedOffers": { "type": "array", "items": { "type": "object", "properties": { "lowestPricedOffersInput": { "type": "object", "properties": { "itemCondition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ] }, "offerType": { "type": "string", "enum": [ "Consumer" ], "description": "The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`." } }, "required": [ "itemCondition", "offerType" ] }, "offers": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string", "description": "The seller identifier for the offer." }, "condition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ], "description": "The seller identifier for the offer." }, "subCondition": { "type": "string", "enum": [ "New", "Mint", "VeryGood", "Good", "Acceptable", "Poor", "Club", "OEM", "Warranty", "RefurbishedWarranty", "Refurbished", "OpenBox", "Other" ], "description": "The item subcondition of the offer." }, "fulfillmentType": { "type": "string", "enum": [ "AFN", "MFN" ], "description": "The item subcondition of the offer." }, "listingPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "shippingOptions": { "type": "array", "items": { "type": "object", "properties": { "shippingOptionType": { "type": "string", "enum": [ "DEFAULT" ], "description": "The type of shipping option." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of shipping option." } }, "required": [ "shippingOptionType", "price" ] }, "description": "A list of shipping options associated with this offer" }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points." }, "pointsMonetaryValue": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points." } }, "description": "A list of shipping options associated with this offer" }, "primeDetails": { "type": "object", "properties": { "eligibility": { "type": "string", "enum": [ "NATIONAL", "REGIONAL", "NONE" ], "description": "Indicates whether the offer is an Amazon Prime offer." } }, "required": [ "eligibility" ] }, "promotions": { "type": "array", "items": { "type": "object", "properties": { "promotionType": { "type": "string" }, "promotionSavings": { "type": "object", "properties": { "discount": { "type": "object", "properties": { "type": { "type": "string" }, "amountOff": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "percentOff": { "type": "number", "description": "The percentage discount applied to the original price (1-100). Only valid when type is PERCENTAGE_OFF." } } }, "discountedPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } } } }, "purchaseRequirements": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "quantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "amountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] } } } } } }, "required": [ "promotionType", "promotionSavings" ] } } }, "required": [ "sellerId", "condition", "fulfillmentType", "listingPrice" ] }, "description": "A list of up to 20 lowest priced offers that match the criteria specified in `lowestPricedOffersInput`." } }, "required": [ "lowestPricedOffersInput", "offers" ] }, "description": "A list of lowest priced offers for the specified ASIN `marketplaceId` combination." }, "referencePrices": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." } }, "required": [ "name", "price" ] }, "description": "A list of reference prices for the specified ASIN `marketplaceId` combination." }, "similarItems": { "type": "array", "items": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" } }, "required": [ "asin" ] }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." } } }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." } }, "required": [ "asin", "marketplaceId" ] } }, "required": [ "status", "body" ] }, "productPricing_2022_05_01_CompetitiveSummaryResponseBody": { "type": "object", "properties": { "asin": { "type": "string" }, "marketplaceId": { "type": "string" }, "featuredBuyingOptions": { "type": "array", "items": { "type": "object", "properties": { "buyingOptionType": { "type": "string", "enum": [ "New" ], "description": "The buying option type for the featured offer. `buyingOptionType` represents the buying options that a customer receives on the detail page, such as `B2B`, `Fresh`, and `Subscribe n Save`. `buyingOptionType` currently supports `NEW` as a value." }, "segmentedFeaturedOffers": { "type": "array", "items": { "type": "object", "properties": {} }, "description": "A list of segmented featured offers for the current buying option type. A segment can be considered as a group of regional contexts that all have the same featured offer. A regional context is a combination of factors such as customer type, region, or postal code and buying option." } }, "required": [ "buyingOptionType", "segmentedFeaturedOffers" ] }, "description": "A list of featured buying options for the specified ASIN `marketplaceId` combination." }, "lowestPricedOffers": { "type": "array", "items": { "type": "object", "properties": { "lowestPricedOffersInput": { "type": "object", "properties": { "itemCondition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ] }, "offerType": { "type": "string", "enum": [ "Consumer" ], "description": "The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`." } }, "required": [ "itemCondition", "offerType" ] }, "offers": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string", "description": "The seller identifier for the offer." }, "condition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ], "description": "The seller identifier for the offer." }, "subCondition": { "type": "string", "enum": [ "New", "Mint", "VeryGood", "Good", "Acceptable", "Poor", "Club", "OEM", "Warranty", "RefurbishedWarranty", "Refurbished", "OpenBox", "Other" ], "description": "The item subcondition of the offer." }, "fulfillmentType": { "type": "string", "enum": [ "AFN", "MFN" ], "description": "The item subcondition of the offer." }, "listingPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "shippingOptions": { "type": "array", "items": { "type": "object", "properties": { "shippingOptionType": { "type": "string", "enum": [ "DEFAULT" ], "description": "The type of shipping option." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of shipping option." } }, "required": [ "shippingOptionType", "price" ] }, "description": "A list of shipping options associated with this offer" }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points." }, "pointsMonetaryValue": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points." } }, "description": "A list of shipping options associated with this offer" }, "primeDetails": { "type": "object", "properties": { "eligibility": { "type": "string", "enum": [ "NATIONAL", "REGIONAL", "NONE" ], "description": "Indicates whether the offer is an Amazon Prime offer." } }, "required": [ "eligibility" ] }, "promotions": { "type": "array", "items": { "type": "object", "properties": { "promotionType": { "type": "string" }, "promotionSavings": { "type": "object", "properties": { "discount": { "type": "object", "properties": { "type": { "type": "string" }, "amountOff": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "percentOff": { "type": "number", "description": "The percentage discount applied to the original price (1-100). Only valid when type is PERCENTAGE_OFF." } } }, "discountedPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } } } }, "purchaseRequirements": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "quantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "amountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] } } } } } }, "required": [ "promotionType", "promotionSavings" ] } } }, "required": [ "sellerId", "condition", "fulfillmentType", "listingPrice" ] }, "description": "A list of up to 20 lowest priced offers that match the criteria specified in `lowestPricedOffersInput`." } }, "required": [ "lowestPricedOffersInput", "offers" ] }, "description": "A list of lowest priced offers for the specified ASIN `marketplaceId` combination." }, "referencePrices": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." } }, "required": [ "name", "price" ] }, "description": "A list of reference prices for the specified ASIN `marketplaceId` combination." }, "similarItems": { "type": "array", "items": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" } }, "required": [ "asin" ] }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." } } }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." } }, "required": [ "asin", "marketplaceId" ] }, "productPricing_2022_05_01_CompetitiveSummaryResponseList": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "The HTTP response status code." }, "reasonPhrase": { "type": "string", "description": "The HTTP response reason phrase." } } }, "body": { "type": "object", "properties": { "asin": { "type": "string" }, "marketplaceId": { "type": "string" }, "featuredBuyingOptions": { "type": "array", "items": { "type": "object", "properties": { "buyingOptionType": { "type": "string", "enum": [ "New" ], "description": "The buying option type for the featured offer. `buyingOptionType` represents the buying options that a customer receives on the detail page, such as `B2B`, `Fresh`, and `Subscribe n Save`. `buyingOptionType` currently supports `NEW` as a value." }, "segmentedFeaturedOffers": { "type": "array", "items": { "type": "object", "properties": {} }, "description": "A list of segmented featured offers for the current buying option type. A segment can be considered as a group of regional contexts that all have the same featured offer. A regional context is a combination of factors such as customer type, region, or postal code and buying option." } }, "required": [ "buyingOptionType", "segmentedFeaturedOffers" ] }, "description": "A list of featured buying options for the specified ASIN `marketplaceId` combination." }, "lowestPricedOffers": { "type": "array", "items": { "type": "object", "properties": { "lowestPricedOffersInput": { "type": "object", "properties": { "itemCondition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ] }, "offerType": { "type": "string", "enum": [ "Consumer" ], "description": "The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`." } }, "required": [ "itemCondition", "offerType" ] }, "offers": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string", "description": "The seller identifier for the offer." }, "condition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ], "description": "The seller identifier for the offer." }, "subCondition": { "type": "string", "enum": [ "New", "Mint", "VeryGood", "Good", "Acceptable", "Poor", "Club", "OEM", "Warranty", "RefurbishedWarranty", "Refurbished", "OpenBox", "Other" ], "description": "The item subcondition of the offer." }, "fulfillmentType": { "type": "string", "enum": [ "AFN", "MFN" ], "description": "The item subcondition of the offer." }, "listingPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "shippingOptions": { "type": "array", "items": { "type": "object", "properties": { "shippingOptionType": { "type": "string", "enum": [ "DEFAULT" ], "description": "The type of shipping option." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of shipping option." } }, "required": [ "shippingOptionType", "price" ] }, "description": "A list of shipping options associated with this offer" }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points." }, "pointsMonetaryValue": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points." } }, "description": "A list of shipping options associated with this offer" }, "primeDetails": { "type": "object", "properties": { "eligibility": { "type": "string", "enum": [ "NATIONAL", "REGIONAL", "NONE" ], "description": "Indicates whether the offer is an Amazon Prime offer." } }, "required": [ "eligibility" ] }, "promotions": { "type": "array", "items": { "type": "object", "properties": { "promotionType": { "type": "string" }, "promotionSavings": { "type": "object", "properties": { "discount": { "type": "object", "properties": { "type": { "type": "string" }, "amountOff": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "percentOff": { "type": "number", "description": "The percentage discount applied to the original price (1-100). Only valid when type is PERCENTAGE_OFF." } } }, "discountedPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } } } }, "purchaseRequirements": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "quantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "amountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] } } } } } }, "required": [ "promotionType", "promotionSavings" ] } } }, "required": [ "sellerId", "condition", "fulfillmentType", "listingPrice" ] }, "description": "A list of up to 20 lowest priced offers that match the criteria specified in `lowestPricedOffersInput`." } }, "required": [ "lowestPricedOffersInput", "offers" ] }, "description": "A list of lowest priced offers for the specified ASIN `marketplaceId` combination." }, "referencePrices": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." } }, "required": [ "name", "price" ] }, "description": "A list of reference prices for the specified ASIN `marketplaceId` combination." }, "similarItems": { "type": "array", "items": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" } }, "required": [ "asin" ] }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." } } }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." } }, "required": [ "asin", "marketplaceId" ] } }, "required": [ "status", "body" ] } }, "productPricing_2022_05_01_Condition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ] }, "productPricing_2022_05_01_DiscountType": { "type": "string" }, "productPricing_2022_05_01_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "productPricing_2022_05_01_ErrorList": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } }, "productPricing_2022_05_01_FeaturedBuyingOption": { "type": "object", "properties": { "buyingOptionType": { "type": "string", "enum": [ "New" ], "description": "The buying option type for the featured offer. `buyingOptionType` represents the buying options that a customer receives on the detail page, such as `B2B`, `Fresh`, and `Subscribe n Save`. `buyingOptionType` currently supports `NEW` as a value." }, "segmentedFeaturedOffers": { "type": "array", "items": { "type": "object", "properties": {} }, "description": "A list of segmented featured offers for the current buying option type. A segment can be considered as a group of regional contexts that all have the same featured offer. A regional context is a combination of factors such as customer type, region, or postal code and buying option." } }, "required": [ "buyingOptionType", "segmentedFeaturedOffers" ] }, "productPricing_2022_05_01_FeaturedOfferExpectedPriceRequest": { "type": "object", "properties": {} }, "productPricing_2022_05_01_FeaturedOfferExpectedPriceRequestList": { "type": "array", "items": { "type": "object", "properties": {} } }, "productPricing_2022_05_01_FeaturedOfferExpectedPriceResponse": { "type": "object", "properties": {} }, "productPricing_2022_05_01_FeaturedOfferExpectedPriceResponseList": { "type": "array", "items": { "type": "object", "properties": {} } }, "productPricing_2022_05_01_FulfillmentType": { "type": "string", "enum": [ "AFN", "MFN" ] }, "productPricing_2022_05_01_GetFeaturedOfferExpectedPriceBatchResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "productPricing_2022_05_01_HttpMethod": { "type": "string", "enum": [ "GET", "PUT", "PATCH", "DELETE", "POST" ] }, "productPricing_2022_05_01_HttpStatusLine": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "The HTTP response status code." }, "reasonPhrase": { "type": "string", "description": "The HTTP response reason phrase." } } }, "productPricing_2022_05_01_HttpUri": { "type": "string" }, "productPricing_2022_05_01_Item": { "type": "object", "properties": { "asin": { "type": "string" } }, "required": [ "asin" ] }, "productPricing_2022_05_01_LowestPricedOffer": { "type": "object", "properties": { "lowestPricedOffersInput": { "type": "object", "properties": { "itemCondition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ] }, "offerType": { "type": "string", "enum": [ "Consumer" ], "description": "The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`." } }, "required": [ "itemCondition", "offerType" ] }, "offers": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string", "description": "The seller identifier for the offer." }, "condition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ], "description": "The seller identifier for the offer." }, "subCondition": { "type": "string", "enum": [ "New", "Mint", "VeryGood", "Good", "Acceptable", "Poor", "Club", "OEM", "Warranty", "RefurbishedWarranty", "Refurbished", "OpenBox", "Other" ], "description": "The item subcondition of the offer." }, "fulfillmentType": { "type": "string", "enum": [ "AFN", "MFN" ], "description": "The item subcondition of the offer." }, "listingPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "shippingOptions": { "type": "array", "items": { "type": "object", "properties": { "shippingOptionType": { "type": "string", "enum": [ "DEFAULT" ], "description": "The type of shipping option." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of shipping option." } }, "required": [ "shippingOptionType", "price" ] }, "description": "A list of shipping options associated with this offer" }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points." }, "pointsMonetaryValue": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points." } }, "description": "A list of shipping options associated with this offer" }, "primeDetails": { "type": "object", "properties": { "eligibility": { "type": "string", "enum": [ "NATIONAL", "REGIONAL", "NONE" ], "description": "Indicates whether the offer is an Amazon Prime offer." } }, "required": [ "eligibility" ] }, "promotions": { "type": "array", "items": { "type": "object", "properties": { "promotionType": { "type": "string" }, "promotionSavings": { "type": "object", "properties": { "discount": { "type": "object", "properties": { "type": { "type": "string" }, "amountOff": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "percentOff": { "type": "number", "description": "The percentage discount applied to the original price (1-100). Only valid when type is PERCENTAGE_OFF." } } }, "discountedPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } } } }, "purchaseRequirements": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "quantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "amountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] } } } } } }, "required": [ "promotionType", "promotionSavings" ] } } }, "required": [ "sellerId", "condition", "fulfillmentType", "listingPrice" ] }, "description": "A list of up to 20 lowest priced offers that match the criteria specified in `lowestPricedOffersInput`." } }, "required": [ "lowestPricedOffersInput", "offers" ] }, "productPricing_2022_05_01_LowestPricedOffersInput": { "type": "object", "properties": { "itemCondition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ], "nullable": false }, "offerType": { "type": "string", "enum": [ "Consumer" ], "description": "The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`.", "nullable": false } }, "required": [ "itemCondition", "offerType" ] }, "productPricing_2022_05_01_MarketplaceId": { "type": "string" }, "productPricing_2022_05_01_MoneyType": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "productPricing_2022_05_01_Offer": { "type": "object", "properties": { "sellerId": { "type": "string", "description": "The seller identifier for the offer." }, "condition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ], "description": "The seller identifier for the offer." }, "subCondition": { "type": "string", "enum": [ "New", "Mint", "VeryGood", "Good", "Acceptable", "Poor", "Club", "OEM", "Warranty", "RefurbishedWarranty", "Refurbished", "OpenBox", "Other" ], "description": "The item subcondition of the offer." }, "fulfillmentType": { "type": "string", "enum": [ "AFN", "MFN" ], "description": "The item subcondition of the offer." }, "listingPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "shippingOptions": { "type": "array", "items": { "type": "object", "properties": { "shippingOptionType": { "type": "string", "enum": [ "DEFAULT" ], "description": "The type of shipping option." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of shipping option." } }, "required": [ "shippingOptionType", "price" ] }, "description": "A list of shipping options associated with this offer" }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points." }, "pointsMonetaryValue": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points." } }, "description": "A list of shipping options associated with this offer" }, "primeDetails": { "type": "object", "properties": { "eligibility": { "type": "string", "enum": [ "NATIONAL", "REGIONAL", "NONE" ], "description": "Indicates whether the offer is an Amazon Prime offer." } }, "required": [ "eligibility" ] }, "promotions": { "type": "array", "items": { "type": "object", "properties": { "promotionType": { "type": "string" }, "promotionSavings": { "type": "object", "properties": { "discount": { "type": "object", "properties": { "type": { "type": "string" }, "amountOff": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "percentOff": { "type": "number", "description": "The percentage discount applied to the original price (1-100). Only valid when type is PERCENTAGE_OFF." } } }, "discountedPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } } } }, "purchaseRequirements": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "quantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "amountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] } } } } } }, "required": [ "promotionType", "promotionSavings" ] } } }, "required": [ "sellerId", "condition", "fulfillmentType", "listingPrice" ] }, "productPricing_2022_05_01_Points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points." }, "pointsMonetaryValue": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points." } } }, "productPricing_2022_05_01_PrimeDetails": { "type": "object", "properties": { "eligibility": { "type": "string", "enum": [ "NATIONAL", "REGIONAL", "NONE" ], "description": "Indicates whether the offer is an Amazon Prime offer." } }, "required": [ "eligibility" ] }, "productPricing_2022_05_01_Promotion": { "type": "object", "properties": { "promotionType": { "type": "string" }, "promotionSavings": { "type": "object", "properties": { "discount": { "type": "object", "properties": { "type": { "type": "string" }, "amountOff": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "percentOff": { "type": "number", "description": "The percentage discount applied to the original price (1-100). Only valid when type is PERCENTAGE_OFF." } } }, "discountedPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } } } }, "purchaseRequirements": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "quantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "amountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] } } } } } }, "required": [ "promotionType", "promotionSavings" ] }, "productPricing_2022_05_01_PromotionDiscount": { "type": "object", "properties": { "type": { "type": "string" }, "amountOff": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "percentOff": { "type": "number", "description": "The percentage discount applied to the original price (1-100). Only valid when type is PERCENTAGE_OFF." } } }, "productPricing_2022_05_01_Promotions": { "type": "array", "items": { "type": "object", "properties": { "promotionType": { "type": "string" }, "promotionSavings": { "type": "object", "properties": { "discount": { "type": "object", "properties": { "type": { "type": "string" }, "amountOff": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "percentOff": { "type": "number", "description": "The percentage discount applied to the original price (1-100). Only valid when type is PERCENTAGE_OFF." } } }, "discountedPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } } } }, "purchaseRequirements": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "quantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "amountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] } } } } } }, "required": [ "promotionType", "promotionSavings" ] } }, "productPricing_2022_05_01_PromotionSavings": { "type": "object", "properties": { "discount": { "type": "object", "properties": { "type": { "type": "string" }, "amountOff": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "percentOff": { "type": "number", "description": "The percentage discount applied to the original price (1-100). Only valid when type is PERCENTAGE_OFF." } } }, "discountedPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } } } }, "productPricing_2022_05_01_PromotionType": { "type": "string" }, "productPricing_2022_05_01_PurchaseCondition": { "type": "object", "properties": { "quantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "amountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] } } }, "productPricing_2022_05_01_PurchaseRequirements": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "quantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "amountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] } } } } }, "productPricing_2022_05_01_QuantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "productPricing_2022_05_01_ReferencePrice": { "type": "object", "properties": { "name": { "type": "string", "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." } }, "required": [ "name", "price" ] }, "productPricing_2022_05_01_SegmentedFeaturedOffer": { "type": "object", "properties": {} }, "productPricing_2022_05_01_ShippingOption": { "type": "object", "properties": { "shippingOptionType": { "type": "string", "enum": [ "DEFAULT" ], "description": "The type of shipping option." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of shipping option." } }, "required": [ "shippingOptionType", "price" ] }, "productPricing_2022_05_01_SimilarItems": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" } }, "required": [ "asin" ] }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." } } }, "ProductWeight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "type": "string" } }, "required": [ "value" ] } }, { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "type": "string" } }, "required": [ "value" ] } ] }, "Proxy": { "type": "object", "properties": { "user_id": { "type": "string", "description": "The user who can proxy into the client_id account" }, "client_id": { "type": "string", "description": "The user who can proxy into the client_id account" }, "disabled": { "type": [ "string", "null" ], "format": "date-time", "description": "The user who can be proxied into by the user_id account" } }, "required": [ "user_id", "client_id", "disabled" ] }, "Proxyee": { "type": "object", "properties": { "user_id": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" } } }, "purchase_order_status": { "type": "string", "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ] }, "PurchaseOrder": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "purchase_order_name": { "type": "string" }, "user_id": { "type": "string" }, "ship_from_id": { "type": "string", "description": "The ID of the supplier." }, "created": { "type": "string", "format": "date-time", "description": "The ID of the supplier." }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_status": { "type": "string", "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view" }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time", "description": "A transitional column marking this PO created in the WFS plan view" } }, "required": [ "purchase_order_id", "purchase_order_name", "user_id", "ship_from_id", "created", "created_by", "creation_source", "purchase_order_status", "purchase_order_date", "supplier_id", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by", "external_id", "notes", "attachment_id", "wfs", "expected_delivery_date" ] }, "PurchaseOrderSummary": { "type": "object", "properties": { "skus": { "type": [ "number", "null" ] }, "ordered": { "type": [ "number", "null" ] }, "received": { "type": [ "number", "null" ] }, "damaged": { "type": [ "number", "null" ] }, "missing": { "type": [ "number", "null" ] }, "not_ordered": { "type": [ "number", "null" ] } }, "required": [ "skus", "ordered", "received", "damaged", "missing", "not_ordered" ] }, "PutListingsItemBody": { "type": "object", "properties": { "productType": { "type": "string", "description": "The listings item's Amazon product type.", "nullable": false }, "requirements": { "type": [ "string", "null" ], "enum": [ "LISTING", "LISTING_PRODUCT_ONLY", "LISTING_OFFER_ONLY" ], "description": "The name of the requirements set for the provided data." }, "attributes": { "description": "JSON object containing structured listings item attribute data keyed by attribute name.", "nullable": false } }, "required": [ "productType", "attributes" ] }, "PutListingsItemErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses." } }, "required": [ "errors" ] }, "PutListingsItemResponse": { "type": "object", "properties": { "sku": { "type": "string", "description": "A selling partner-provided identifier for an Amazon listing." }, "status": { "type": "string", "enum": [ "ACCEPTED", "INVALID", "VALID" ], "description": "The status of the listings item submission." }, "submissionId": { "type": "string", "description": "The unique identifier of the listings item submission." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] }, "description": "Listings item issues related to the listings item submission." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." } } }, "description": "Listings item issues related to the listings item submission." } }, "required": [ "sku", "status", "submissionId" ] }, "PutListingsItemSearchParams": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" } }, "includedData": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "identifiers", "issues" ] } } ] }, "mode": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "VALIDATION_PREVIEW" ] } ] }, "issueLocale": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceIds", "mp" ] }, "RdsItemLocation": {}, "ReceiveItemsToLocation": { "type": "object", "properties": { "item_location_id": { "type": "string" }, "user_id": { "type": "string" }, "location_id": { "type": "string" }, "sku": { "type": "string" }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "attachment_id": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "fulfillable": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "total": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that cannot be sold in its current state." }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "The sum of `fulfillable` and `damaged` quantity at this location." }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "purchase_order_item_id": { "type": "string" }, "received_diff": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged_diff": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "output_quantity": { "type": "number", "description": "The quantity of the item at this location that can be sold." } }, "required": [ "purchase_order_item_id", "received_diff", "damaged_diff", "input_sku", "output_sku", "output_quantity" ] }, "ReceiveItemsToLocationBody": { "type": "object", "properties": { "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_id": { "type": "string", "nullable": false }, "gtin": { "type": "string", "nullable": false }, "received": { "type": [ "number", "null" ], "description": "Either this or `damaged` must be supplied" }, "damaged": { "type": [ "number", "null" ], "description": "Either this or `received` must be supplied" }, "lot_code": { "type": [ "string", "null" ], "description": "Either this or `received` must be supplied" }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "by_intent": { "type": [ "boolean", "null" ], "description": "true if this should be bundled by the PO item intent.bundle array" } } }, "nullable": false } } }, "ReceiveItemsToLocationParams": { "type": "object", "properties": { "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "gtin": { "type": "string" }, "received": { "type": "number", "description": "Either this or `damaged` must be supplied" }, "damaged": { "type": "number", "description": "Either this or `received` must be supplied" }, "lot_code": { "type": [ "string", "null" ], "description": "Either this or `received` must be supplied" }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "by_intent": { "type": "boolean", "description": "true if this should be bundled by the PO item intent.bundle array" } } } }, "location_id": { "type": "string" }, "by_intent": { "type": "boolean" } }, "required": [ "purchase_order_items", "location_id" ] }, "ReceiveItemsToLocationResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "item_location_id": { "type": "string" }, "user_id": { "type": "string" }, "location_id": { "type": "string" }, "sku": { "type": "string" }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "attachment_id": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "fulfillable": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "total": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that cannot be sold in its current state." }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "The sum of `fulfillable` and `damaged` quantity at this location." }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "purchase_order_item_id": { "type": "string" }, "received_diff": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged_diff": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "output_quantity": { "type": "number", "description": "The quantity of the item at this location that can be sold." } }, "required": [ "purchase_order_item_id", "received_diff", "damaged_diff", "input_sku", "output_sku", "output_quantity" ] } } }, "required": [ "items" ] }, "ReceiveItemsToLocationSearchParams": { "type": "object", "properties": { "by_intent": { "type": "boolean" } } }, "reports_2021_06_30_CreateReportResponse": { "type": "object", "properties": { "reportId": { "type": "string", "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." } }, "required": [ "reportId" ] }, "reports_2021_06_30_Error": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "reports_2021_06_30_GetReportsResponse": { "type": "object", "properties": { "reports": { "type": "array", "items": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers for the report." }, "reportId": { "type": "string", "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." }, "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information." }, "dataStartTime": { "type": "string", "description": "The start of a date and time range used for selecting the data to report." }, "dataEndTime": { "type": "string", "description": "The end of a date and time range used for selecting the data to report." }, "reportScheduleId": { "type": "string", "description": "The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID." }, "createdTime": { "type": "string", "description": "The date and time when the report was created." }, "processingStatus": { "type": "string", "enum": [ "CANCELLED", "DONE", "FATAL", "IN_PROGRESS", "IN_QUEUE" ], "description": "The processing status of the report." }, "processingStartTime": { "type": "string", "description": "The date and time when the report processing started, in ISO 8601 date time format." }, "processingEndTime": { "type": "string", "description": "The date and time when the report processing completed, in ISO 8601 date time format." }, "reportDocumentId": { "type": "string", "description": "The identifier for the report document. Pass this into the `getReportDocument` operation to get the information you will need to retrieve the report document's contents." } }, "required": [ "reportId", "reportType", "createdTime", "processingStatus" ] } }, "nextToken": { "type": "string", "description": "Returned when the number of results exceeds `pageSize`. To get the next page of results, call `getReports` with this token as the only parameter." } }, "required": [ "reports" ] }, "reports_2021_06_30_Report": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers for the report." }, "reportId": { "type": "string", "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." }, "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information." }, "dataStartTime": { "type": "string", "description": "The start of a date and time range used for selecting the data to report." }, "dataEndTime": { "type": "string", "description": "The end of a date and time range used for selecting the data to report." }, "reportScheduleId": { "type": "string", "description": "The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID." }, "createdTime": { "type": "string", "description": "The date and time when the report was created." }, "processingStatus": { "type": "string", "enum": [ "CANCELLED", "DONE", "FATAL", "IN_PROGRESS", "IN_QUEUE" ], "description": "The processing status of the report." }, "processingStartTime": { "type": "string", "description": "The date and time when the report processing started, in ISO 8601 date time format." }, "processingEndTime": { "type": "string", "description": "The date and time when the report processing completed, in ISO 8601 date time format." }, "reportDocumentId": { "type": "string", "description": "The identifier for the report document. Pass this into the `getReportDocument` operation to get the information you will need to retrieve the report document's contents." } }, "required": [ "reportId", "reportType", "createdTime", "processingStatus" ] }, "reports_2021_06_30_ReportDocument": { "type": "object", "properties": { "reportDocumentId": { "type": "string", "description": "The identifier for the report document. This identifier is unique only in combination with a seller ID." }, "url": { "type": "string", "description": "A presigned URL for the report document. If `compressionAlgorithm` is not returned, you can download the report directly from this URL. This URL expires after 5 minutes." }, "compressionAlgorithm": { "type": "string", "enum": [ "GZIP" ], "description": "If the report document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the report when you download. Otherwise, you can download the report directly. Refer to [Step 2. Download the report](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-retrieve-a-report#step-2-download-the-report) in the use case guide, where sample code is provided." } }, "required": [ "reportDocumentId", "url" ] }, "reports_2021_06_30_ReportList": { "type": "array", "items": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers for the report." }, "reportId": { "type": "string", "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." }, "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information." }, "dataStartTime": { "type": "string", "description": "The start of a date and time range used for selecting the data to report." }, "dataEndTime": { "type": "string", "description": "The end of a date and time range used for selecting the data to report." }, "reportScheduleId": { "type": "string", "description": "The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID." }, "createdTime": { "type": "string", "description": "The date and time when the report was created." }, "processingStatus": { "type": "string", "enum": [ "CANCELLED", "DONE", "FATAL", "IN_PROGRESS", "IN_QUEUE" ], "description": "The processing status of the report." }, "processingStartTime": { "type": "string", "description": "The date and time when the report processing started, in ISO 8601 date time format." }, "processingEndTime": { "type": "string", "description": "The date and time when the report processing completed, in ISO 8601 date time format." }, "reportDocumentId": { "type": "string", "description": "The identifier for the report document. Pass this into the `getReportDocument` operation to get the information you will need to retrieve the report document's contents." } }, "required": [ "reportId", "reportType", "createdTime", "processingStatus" ] } }, "reports_2021_06_30_ReportOptions": {}, "reports_2021_06_30_ReportSchedule": { "type": "object", "properties": { "reportScheduleId": { "type": "string", "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID." }, "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise." }, "reportOptions": { "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise." }, "period": { "type": "string", "description": "An ISO 8601 period value that indicates how often a report should be created." }, "nextReportCreationTime": { "type": "string", "description": "The date and time when the schedule will create its next report, in ISO 8601 date time format." } }, "required": [ "reportScheduleId", "reportType", "period" ] }, "reports_2021_06_30_ReportScheduleList": { "type": "object", "properties": { "reportSchedules": { "type": "array", "items": { "type": "object", "properties": { "reportScheduleId": { "type": "string", "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID." }, "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise." }, "reportOptions": { "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise." }, "period": { "type": "string", "description": "An ISO 8601 period value that indicates how often a report should be created." }, "nextReportCreationTime": { "type": "string", "description": "The date and time when the schedule will create its next report, in ISO 8601 date time format." } }, "required": [ "reportScheduleId", "reportType", "period" ] }, "description": "Detailed information about a report schedule." } }, "required": [ "reportSchedules" ] }, "RetireAnItemParams": { "type": "object", "properties": { "fetch": { "type": "object" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "fetch", "sku", "marketplace_id" ] }, "RetireAnItemResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "message": { "type": "string", "description": "Message confirming the deletion or retirement of an item from the Walmart Catalog" } } }, "role": { "type": "string", "enum": [ "3pl-billing", "admin", "api", "integration", "manage-team", "prep-center", "prep-client" ] }, "SaveReportBody": { "oneOf": [ { "type": "object", "properties": { "reportType": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA" ] }, { "type": "string", "enum": [ "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2" ] }, { "type": "string", "enum": [ "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA" ] }, { "type": "string", "enum": [ "GET_STRANDED_INVENTORY_UI_DATA" ] }, { "type": "string", "enum": [ "GET_FBA_INVENTORY_PLANNING_DATA" ] } ] }, "reportId": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "processingStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "CANCELLED" ] }, { "type": "string", "enum": [ "ERROR" ] }, { "type": "string", "enum": [ "DONE" ] }, { "type": "string", "enum": [ "FATAL" ] }, { "type": "string", "enum": [ "WAIT" ] }, { "type": "string", "enum": [ "PREPARING" ] }, { "type": "string", "enum": [ "QUEUEING" ] }, { "type": "string", "enum": [ "SUBMITTED" ] }, { "type": "string", "enum": [ "DONE_NO_DATA" ] } ] }, "reportDocumentId": { "type": "object" } } }, { "type": "object", "properties": { "requestId": { "type": "object" }, "requestStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ERROR" ] }, { "type": "string", "enum": [ "RECEIVED" ] }, { "type": "string", "enum": [ "INPROGRESS" ] }, { "type": "string", "enum": [ "READY" ] } ] }, "reportType": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "CANCELLATION" ] }, { "type": "string", "enum": [ "ITEM" ] }, { "type": "string", "enum": [ "INVENTORY" ] }, { "type": "string", "enum": [ "DELIVERY_DEFECT" ] }, { "type": "string", "enum": [ "ITEM_PERFORMANCE" ] }, { "type": "string", "enum": [ "PROMO" ] }, { "type": "string", "enum": [ "RETURN_OVERRIDES" ] }, { "type": "string", "enum": [ "CPA" ] }, { "type": "string", "enum": [ "SHIPPING_CONFIGURATION" ] }, { "type": "string", "enum": [ "SHIPPING_PROGRAM" ] }, { "type": "string", "enum": [ "FITMENT_MISSING_ATTR" ] }, { "type": "string", "enum": [ "FITMENT_ACES_COVERAGE" ] }, { "type": "string", "enum": [ "BUYBOX" ] }, { "type": "string", "enum": [ "ASSORTMENT_RECOMMENDATIONS" ] }, { "type": "string", "enum": [ "LAGTIME" ] } ] }, "reportVersion": { "type": "object" } } } ] }, "SaveReportResponse": { "type": "boolean" }, "SaveReportSearchParams": { "type": "object", "properties": { "bg": { "type": "boolean", "description": "if true, `saveReport` will return immediately without waiting for the rows to save (they will be saved in the background)" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SaveTag": { "type": "object", "properties": { "tag_name": { "type": "string", "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_id": { "type": [ "string", "null" ] } } }, "SearchCatalogItemsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses returned when a request is unsuccessful." } }, "required": [ "errors" ] }, "SearchCatalogItemsResponse": { "type": "object", "properties": { "numberOfResults": { "type": "number", "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." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that you can use to retrieve the next page." }, "previousToken": { "type": "string", "description": "A token that you can use to retrieve the previous page." } }, "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." }, "refinements": { "type": "object", "properties": { "brands": { "type": "array", "items": { "type": "object", "properties": { "numberOfResults": { "type": "number", "description": "The estimated number of results that would be returned if you refine your search by the specified `brandName`." }, "brandName": { "type": "string", "description": "The brand name that you can use to refine your search." } }, "required": [ "numberOfResults", "brandName" ] }, "description": "A list of brands you can use to refine your search." }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "numberOfResults": { "type": "number", "description": "The estimated number of results that would be returned if you refine your search by the specified `classificationId`." }, "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "The identifier of the classification that you can use to refine your search." } }, "required": [ "numberOfResults", "displayName", "classificationId" ] }, "description": "A list of classifications you can use to refine your search." } }, "required": [ "brands", "classifications" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" }, "attributes": {}, "classifications": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ] }, "description": "Classifications (browse nodes) that are associated with the item in the Amazon catalog." } }, "required": [ "marketplaceId" ] } }, "dimensions": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "item": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } }, "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "package": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } } } }, "required": [ "marketplaceId" ] } }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).identifier." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "identifierType": { "type": "string", "description": "Type of identifier, such as UPC, EAN, or ISBN." }, "identifier": { "type": "string", "description": "Identifier of the item." } }, "required": [ "identifierType", "identifier" ] }, "description": "Identifiers associated with the item in the Amazon catalog for the indicated `marketplaceId`." } }, "required": [ "marketplaceId", "identifiers" ] } }, "images": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "images": { "type": "array", "items": { "type": "object", "properties": { "variant": { "type": "string", "enum": [ "MAIN", "PT01", "PT02", "PT03", "PT04", "PT05", "PT06", "PT07", "PT08", "SWCH" ], "description": "Variant of the image, such as `MAIN` or `PT01`." }, "link": { "type": "string", "description": "URL for the image." }, "height": { "type": "number", "description": "Height of the image in pixels." }, "width": { "type": "number", "description": "Width of the image in pixels." } }, "required": [ "variant", "link", "height", "width" ] }, "description": "Images for an item in the Amazon catalog, grouped by `marketplaceId`." } }, "required": [ "marketplaceId", "images" ] } }, "productTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "productType": { "type": "string", "description": "Name of the product type that is associated with the Amazon catalog item." } } } }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are children of this item." }, "parentAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are parents of this item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "Names of the Amazon catalog item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family." } }, "description": "ASINs of the related items that are parents of this item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "Type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the item." } }, "required": [ "marketplaceId", "relationships" ] } }, "salesRanks": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classificationRanks": { "type": "array", "items": { "type": "object", "properties": { "classificationId": { "type": "string", "description": "Identifier of the classification that is associated with the sales rank." }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales category." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "classificationId", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification." }, "displayGroupRanks": { "type": "array", "items": { "type": "object", "properties": { "websiteDisplayGroup": { "type": "string", "description": "Name of the website display group that is associated with the sales rank" }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales rank." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "websiteDisplayGroup", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group." } }, "required": [ "marketplaceId" ] } }, "summaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "adultProduct": { "type": "boolean", "description": "When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature." }, "autographed": { "type": "boolean", "description": "When `true`, the Amazon catalog item is autographed." }, "brand": { "type": "string", "description": "Name of the brand that is associated with the Amazon catalog item." }, "browseClassification": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ], "description": "Name of the brand that is associated with the Amazon catalog item." }, "color": { "type": "string", "description": "The color that is associated with the Amazon catalog item." }, "contributors": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name of the role in the requested locale, such as `Author` or `Actor`." }, "value": { "type": "string", "description": "Role value for the Amazon catalog item, such as `author` or `actor`." } }, "required": [ "value" ] }, "value": { "type": "string", "description": "Name of the contributor, such as `Jane Austen`." } }, "required": [ "role", "value" ] }, "description": "Individual contributors to the creation of the item, such as the authors or actors." }, "itemClassification": { "type": "string", "enum": [ "BASE_PRODUCT", "OTHER", "PRODUCT_BUNDLE", "VARIATION_PARENT" ], "description": "Classification type that is associated with the Amazon catalog item." }, "itemName": { "type": "string", "description": "The name that is associated with the Amazon catalog item." }, "manufacturer": { "type": "string", "description": "The name of the manufacturer that is associated with the Amazon catalog item." }, "memorabilia": { "type": "boolean", "description": "When true, the item is classified as memorabilia." }, "modelNumber": { "type": "string", "description": "The model number that is associated with the Amazon catalog item." }, "packageQuantity": { "type": "number", "description": "The quantity of the Amazon catalog item within one package." }, "partNumber": { "type": "string", "description": "The part number that is associated with the Amazon catalog item." }, "releaseDate": { "type": "string", "description": "The earliest date on which the Amazon catalog item can be shipped to customers." }, "size": { "type": "string", "description": "The name of the size of the Amazon catalog item." }, "style": { "type": "string", "description": "The name of the style that is associated with the Amazon catalog item." }, "tradeInEligible": { "type": "boolean", "description": "When true, the Amazon catalog item is eligible for trade-in." }, "websiteDisplayGroup": { "type": "string", "description": "The identifier of the website display group that is associated with the Amazon catalog item." }, "websiteDisplayGroupName": { "type": "string", "description": "The display name of the website display group that is associated with the Amazon catalog item." } }, "required": [ "marketplaceId" ] } }, "vendorDetails": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "brandCode": { "type": "string", "description": "The brand code that is associated with an Amazon catalog item." }, "manufacturerCode": { "type": "string", "description": "The manufacturer code that is associated with an Amazon catalog item." }, "manufacturerCodeParent": { "type": "string", "description": "The parent vendor code of the manufacturer code." }, "productCategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The parent vendor code of the manufacturer code." }, "productGroup": { "type": "string", "description": "The product group that is associated with an Amazon catalog item." }, "productSubcategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The product group that is associated with an Amazon catalog item." }, "replenishmentCategory": { "type": "string", "enum": [ "ALLOCATED", "BASIC_REPLENISHMENT", "IN_SEASON", "LIMITED_REPLENISHMENT", "MANUFACTURER_OUT_OF_STOCK", "NEW_PRODUCT", "NON_REPLENISHABLE", "NON_STOCKUPABLE", "OBSOLETE", "PLANNED_REPLENISHMENT" ], "description": "The replenishment category that is associated with an Amazon catalog item." } }, "required": [ "marketplaceId" ] } } }, "required": [ "asin" ] }, "description": "A list of items from the Amazon catalog." } }, "required": [ "numberOfResults", "items" ] }, "SearchCatalogItemsSearchParams": { "type": "object", "properties": { "identifiers": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "identifiersType": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ASIN" ] }, { "type": "string", "enum": [ "EAN" ] }, { "type": "string", "enum": [ "GTIN" ] }, { "type": "string", "enum": [ "ISBN" ] }, { "type": "string", "enum": [ "JAN" ] }, { "type": "string", "enum": [ "MINSAN" ] }, { "type": "string", "enum": [ "SKU" ] }, { "type": "string", "enum": [ "UPC" ] } ] }, "locale": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "sellerId": { "type": "object" }, "keywords": { "type": "object" }, "brandNames": { "type": "object" }, "classificationIds": { "type": "object" }, "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "pageToken": { "type": "object" }, "keywordsLocale": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "marketplaceIds": { "type": "object" }, "includedData": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "images", "attributes", "classifications", "dimensions", "identifiers", "productTypes", "relationships", "salesRanks", "summaries", "vendorDetails" ] } } ] } } }, "SelectAllInventoryLocation": { "type": "object", "properties": { "item_location_id": { "type": "string" }, "location_id": { "type": "string" }, "sku": { "type": "string" }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "attachment_id": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "fulfillable": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "total": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that cannot be sold in its current state." }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "The sum of `fulfillable` and `damaged` quantity at this location." }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "location_name": { "type": "string" }, "location_type": { "type": "string", "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ] } } }, "SelectAllInventoryParams": { "type": "object", "properties": { "limit": { "type": "number", "description": "Only select this number of records" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "Limit items to this marketplace" }, "country": { "type": "string", "enum": [ "AE", "AU", "BE", "BR", "CA", "CL", "CN", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ], "description": "Limit items to this country across channels (ie. az and wm)" }, "search": { "type": "string", "description": "Search inventory for matching values keyed by `search_by`" }, "with_tags": { "type": "boolean", "description": "Return inventory tags" }, "with_data": { "type": "boolean", "description": "Return `data` element" }, "in_stock": { "type": "boolean", "description": "defaults to true, return only inventory with quantity" }, "next": { "type": "string", "description": "the next token for paging" }, "ship_from_id": { "type": "string" }, "search_by": { "type": "string", "enum": [ "sku", "title", "fnsku" ] } }, "required": [ "ship_from_id" ] }, "SelectAllInventoryResponse": { "type": "object", "properties": { "all_inventory": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "inventory": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "product": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "value" ] } }, { "type": "object" } ] }, "data": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sku": { "type": "object" }, "condition": { "type": "object" }, "wpid": { "type": "object" }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "productName": { "type": "object" }, "shelf": { "type": "object" }, "productType": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } ] }, "publishedStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PUBLISHED" ] }, { "type": "string", "enum": [ "READY_TO_PUBLISH" ] }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "UNPUBLISHED" ] }, { "type": "string", "enum": [ "STAGE" ] }, { "type": "string", "enum": [ "SYSTEM_PROBLEM." ] } ] }, "additionalAttributes": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "nameValueAttribute": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "variantResourceType": { "type": "object" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "object" }, "source": { "type": "object" }, "rank": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "isVariant": { "type": "object" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } ] } } } ] }, "unpublishedReasons": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "reason": { "oneOf": [ { "type": "object" }, { "type": "object" } ] } } } ] }, "lifecycleStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "ARCHIVED" ] }, { "type": "string", "enum": [ "RETIRED" ] } ] }, "isDuplicate": { "type": "object" }, "isCustomerFavorite": { "type": "object" }, "duplicateItemdetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "status": { "type": "object" }, "lastUpdatedDate": { "type": "object" }, "identifiedDate": { "type": "object" }, "destinationItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "type": "object" }, "wpid": { "type": "object" }, "gtin": { "type": "object" }, "upc": { "type": "object" }, "itemId": { "type": "object" }, "productName": { "type": "object" }, "productType": { "type": "object" }, "additionalAttributes": { "type": "object" } } } ] } } } ] } } } ] }, "getSearchResult": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "condition": { "type": "object" }, "isMarketPlaceItem": { "type": "object" }, "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } ] }, "customerRating": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } ] }, "description": { "type": "object" }, "title": { "type": "object" }, "brand": { "type": "object" }, "productType": { "type": "object" }, "properties": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variant_items_num": { "type": "object" }, "num_reviews": { "type": "object" }, "categories": { "type": "object" }, "variants": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variantMeta": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } ] }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "object" }, "itemId": { "type": "object" }, "isAvailable": { "type": "object" }, "title": { "type": "object" }, "variantValues": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "object" }, "value": { "type": "object" } } } } ] } } } } }, "required": [ "variantData" ] } ] }, "next_day_eligible": { "type": "object" } } } ] }, "parent": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } ] } } } ] } } }, { "type": "object" } ] }, "meltable": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "expiration_required": { "type": "object" }, "hazmat": { "type": "object" }, "size": { "type": "object" }, "category": { "type": "object" }, "dims": { "type": "object" }, "feed_data": { "type": "object" }, "gtins": { "type": "object" }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": "object" }, "icon": { "type": "object" } }, "required": [ "tag_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data", "gtins" ] }, "condition": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } } } } }, "warehouse_inventory": { "type": "array", "items": { "type": "object", "properties": { "item_location_id": { "type": "string" }, "location_id": { "type": "string" }, "sku": { "type": "string" }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "attachment_id": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "fulfillable": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "total": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that cannot be sold in its current state." }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "The sum of `fulfillable` and `damaged` quantity at this location." }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "location_name": { "type": "string" }, "location_type": { "type": "string", "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ] } } } }, "gtins": { "type": "array", "items": { "type": "string" } } }, "required": [ "sku", "inventory", "warehouse_inventory", "gtins" ] } }, "next": { "type": "string" } }, "required": [ "all_inventory" ] }, "SelectAttachmentsParams": { "type": "object", "properties": { "next": { "type": "string" }, "archived": { "type": "boolean" }, "attachment_ids": { "type": "array", "items": { "type": "string" } }, "file_name": { "type": "string", "description": "The name of the attached file" }, "purchase_order_ids": { "type": "array", "items": { "type": "string" } }, "limit": { "type": "number" } } }, "SelectAttachmentsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "attachment_id": { "type": "string" }, "file_name": { "type": "string", "description": "The name of the attached file" }, "content_type": { "type": [ "string", "null" ], "description": "The name of the attached file" }, "file_uri": { "type": [ "string", "null" ], "description": "The MIME type of the attached file" }, "file_data": { "type": [ "string", "null" ], "description": "If the file is hosted externally, this will be a link to that file" }, "file_size": { "type": [ "number", "null" ], "description": "Small files may be stored here" }, "created": { "type": "string", "format": "date-time", "description": "The size of the attached file in bytes" }, "created_by": { "type": [ "string", "null" ] } } } } }, "required": [ "total_rows", "attachments" ] }, "SelectAzBoxesParams": { "type": "object", "properties": { "box_ids": { "type": "array", "items": { "type": "string" } }, "inbound_plan_id": { "type": [ "string", "null" ] }, "packing_group_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "shipment_id": { "type": [ "string", "null" ] }, "with_items": { "type": "boolean" }, "with_tags": { "type": "boolean" }, "only_with_items": { "type": "boolean" } } }, "SelectAzBoxesResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "boxes": { "type": "array", "items": { "type": "object", "properties": { "box_id": { "type": "string" }, "user_id": { "type": "string" }, "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "pallet_id": { "type": [ "number", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "tracking_id": { "type": [ "string", "null" ] }, "inbound_plan_id": { "type": [ "string", "null" ] }, "packing_option_id": { "type": [ "string", "null" ] }, "packing_group_id": { "type": [ "string", "null" ] }, "package_id": { "type": [ "string", "null" ] }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ] }, "print_box_label_quantity": { "type": "number" }, "length": { "type": [ "number", "null" ] }, "width": { "type": [ "number", "null" ] }, "height": { "type": [ "number", "null" ] }, "unit_of_measurement": { "type": [ "string", "null" ], "enum": [ "CM", "IN" ] }, "weight": { "type": [ "number", "null" ] }, "unit_of_weight": { "type": [ "string", "null" ], "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "amazon_box_id": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "box_item_id": { "type": "string" }, "user_id": { "type": "string" }, "box_id": { "type": "number" }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "external_id": { "type": "string" }, "sku": { "type": "string" }, "fnsku": { "type": [ "string", "null" ] }, "label_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ] }, "prep_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ] }, "manufacturing_lot_code": { "type": [ "string", "null" ] }, "prep_instructions": { "anyOf": [ {}, { "type": "null" } ] }, "quantity": { "type": "number" }, "packing_group_id": { "type": [ "string", "null" ] }, "plan_item_id": { "type": [ "number", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "box_item_id", "user_id", "box_id", "expires", "external_id", "sku", "fnsku", "label_owner", "prep_owner", "manufacturing_lot_code", "prep_instructions", "quantity", "packing_group_id", "plan_item_id", "created", "created_by", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by" ] }, "description": "set if `with_items` option was set" } } } } }, "required": [ "total_rows", "boxes" ] }, "SelectAzBoxItemsParams": { "type": "object", "properties": { "plan_id": { "type": [ "string", "null" ] }, "box_id": { "type": "number" }, "box_item_ids": { "type": "array", "items": { "type": "string" } } } }, "SelectAzBoxItemsResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "items": { "type": "array", "items": { "type": "object", "properties": { "box_item_id": { "type": "string" }, "user_id": { "type": "string" }, "box_id": { "type": "number" }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "external_id": { "type": "string" }, "sku": { "type": "string" }, "fnsku": { "type": [ "string", "null" ] }, "label_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ] }, "prep_owner": { "type": "string", "enum": [ "AMAZON", "NONE", "SELLER" ] }, "manufacturing_lot_code": { "type": [ "string", "null" ] }, "prep_instructions": { "anyOf": [ {}, { "type": "null" } ] }, "quantity": { "type": "number" }, "packing_group_id": { "type": [ "string", "null" ] }, "plan_item_id": { "type": [ "number", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "box_item_id", "user_id", "box_id", "expires", "external_id", "sku", "fnsku", "label_owner", "prep_owner", "manufacturing_lot_code", "prep_instructions", "quantity", "packing_group_id", "plan_item_id", "created", "created_by", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by" ] } } }, "required": [ "total_rows", "items" ] }, "SelectAzPalletResponse": { "type": "object", "properties": { "pallet": { "type": "object", "properties": { "pallet_id": { "type": "number" }, "user_id": { "type": "string" }, "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ] }, "inbound_plan_id": { "type": "string" }, "placement_option_id": { "type": [ "string", "null" ] }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": "number" }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "pallet_id", "user_id", "shipment_id", "plan_id", "index", "quantity", "stackability", "inbound_plan_id", "placement_option_id", "length", "width", "height", "unit_of_measurement", "weight", "unit_of_weight", "created", "created_by", "creation_source", "updated", "updated_by", "deleted", "deleted_by" ] } } }, "SelectAzPalletsParams": { "type": "object", "properties": { "shipment_id": { "type": "string" }, "inbound_plan_id": { "type": "string" }, "pallet_ids": { "type": "array", "items": { "type": "number" } }, "with_tags": { "type": "boolean" } } }, "SelectAzPalletsResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "pallets": { "type": "array", "items": { "type": "object", "properties": { "pallet_id": { "type": "number" }, "user_id": { "type": "string" }, "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ] }, "inbound_plan_id": { "type": "string" }, "placement_option_id": { "type": [ "string", "null" ] }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": "number" }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "pallet_id", "user_id", "shipment_id", "plan_id", "index", "quantity", "stackability", "inbound_plan_id", "placement_option_id", "length", "width", "height", "unit_of_measurement", "weight", "unit_of_weight", "created", "created_by", "creation_source", "updated", "updated_by", "deleted", "deleted_by" ] } } }, "required": [ "total_rows", "pallets" ] }, "SelectAzShipmentLogParams": { "type": "object", "properties": { "next": { "type": "string" }, "inbound_plan_id": { "type": "string" }, "shipment_id": { "type": "string" }, "shipment_confirmation_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string" }, "before": { "type": [ "string", "null" ], "format": "date-time" }, "after": { "type": [ "string", "null" ], "format": "date-time" }, "sort": { "type": "string", "enum": [ "asc", "desc" ] }, "limit": { "type": "number" }, "with_user_name": { "type": "boolean", "description": "Returns the user's name" }, "with_ship_from_name": { "type": "boolean", "description": "Returns ship from name" } } }, "SelectAzShipmentLogResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "shipment_log": { "type": "array", "items": { "type": "object" } } }, "required": [ "shipment_log" ] }, "SelectAzShipmentsParams": { "type": "object", "properties": { "next": { "type": "string" }, "shipment_ids": { "type": "array", "items": { "type": "string" } }, "shipment_confirmation_ids": { "type": "array", "items": { "type": [ "string", "null" ] } }, "plan_id": { "type": [ "string", "null" ] }, "inbound_plan_id": { "type": "string" }, "ship_from_id": { "type": [ "string", "null" ] }, "statuses": { "type": "array", "items": { "type": [ "string", "null" ], "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ] } }, "limit": { "type": "number" }, "with_tags": { "type": "boolean" } } }, "SelectAzShipmentsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "az_shipments": { "type": "array", "items": { "type": "object", "properties": { "shipment_id": { "type": "string" }, "user_id": { "type": "string" }, "plan_id": { "type": [ "string", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ], "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "synced": { "type": [ "string", "null" ], "format": "date-time" }, "inbound_plan_id": { "type": "string" }, "placement_option_id": { "type": [ "string", "null" ] }, "shipping_solution": { "type": [ "string", "null" ], "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ] }, "selected_transportation_option_id": { "type": [ "string", "null" ] }, "confirmed_transportation_option_id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "amazon_reference_id": { "type": [ "string", "null" ] }, "contact_information": { "anyOf": [ {}, { "type": "null" } ] }, "dates": { "anyOf": [ {}, { "type": "null" } ] }, "destination": { "anyOf": [ {}, { "type": "null" } ] }, "freight_information": { "anyOf": [ {}, { "type": "null" } ] }, "selected_delivery_window": { "anyOf": [ {}, { "type": "null" } ] }, "self_ship_appointment_details": { "anyOf": [ {}, { "type": "null" } ] }, "shipment_confirmation_id": { "type": [ "string", "null" ] }, "tracking_details": { "anyOf": [ {}, { "type": "null" } ] }, "update_shipment_tracking_details_operation": { "anyOf": [ {}, { "type": "null" } ] }, "update_shipment_tracking_details_operation_at": { "type": [ "string", "null" ], "format": "date-time" }, "boxes": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": "string", "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": "string", "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": "string", "description": "Template name of the box." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] } }, "boxes_update": { "anyOf": [ {}, { "type": "null" } ] }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] } }, "ship_date": { "type": [ "string", "null" ], "format": "date-time" }, "shipping_mode": { "type": [ "string", "null" ], "enum": [ "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS", "FREIGHT_FTL_NONPALLET", "FREIGHT_FTL_PALLET", "FREIGHT_LTL", "GROUND_SMALL_PARCEL", "OCEAN_FCL", "OCEAN_LCL" ] }, "dirty": { "type": [ "boolean", "null" ] }, "selected_delivery_window_option_id": { "type": [ "string", "null" ], "description": "Which delivery window the user has selected from the drop down, but not necessarily accepted yet" } }, "required": [ "shipment_id", "user_id", "plan_id", "marketplace_id", "ship_from_id", "status", "created", "created_by", "creation_source", "updated", "updated_by", "deleted", "deleted_by", "synced", "inbound_plan_id", "placement_option_id", "shipping_solution", "selected_transportation_option_id", "confirmed_transportation_option_id", "name", "amazon_reference_id", "contact_information", "dates", "destination", "freight_information", "selected_delivery_window", "self_ship_appointment_details", "shipment_confirmation_id", "tracking_details", "update_shipment_tracking_details_operation", "update_shipment_tracking_details_operation_at", "boxes", "boxes_update", "items", "ship_date", "shipping_mode", "dirty", "selected_delivery_window_option_id" ] } }, "total_rows": { "type": "number" } }, "required": [ "az_shipments" ] }, "SelectBundlesResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "bundle_item_id": { "type": "string" }, "bundle_id": { "type": "string" }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } } } } } } } } } }, "required": [ "bundles" ] }, "SelectBundlesSearchParams": { "type": "object", "properties": { "next": { "type": "string" }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "limit": { "type": "number", "description": "defaults to 100" }, "bundle_ids": { "type": "string", "description": "comma separated list of `bundle_id`s" } } }, "SelectClientsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "clients": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" } } } } }, "required": [ "clients" ] }, "SelectClientsSearchParams": { "type": "object", "properties": { "next": { "type": "string" }, "client_id": { "type": "string" }, "limit": { "type": "number" } } }, "SelectDeliveryWindowOptionsResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "delivery_window_options": { "type": "array", "items": { "type": "object", "properties": { "delivery_window_option_id": { "type": "string" }, "user_id": { "type": "string" }, "inbound_plan_id": { "type": "string" }, "availability_type": { "type": "string", "enum": [ "AVAILABLE", "BLOCKED", "CONGESTED", "DISCOUNTED" ] }, "start_date": { "type": "string", "format": "date-time" }, "end_date": { "type": "string", "format": "date-time" }, "valid_until": { "type": "string", "format": "date-time" }, "discounts": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] } }, "status": { "type": "string", "enum": [ "ACCEPTED", "OFFERED" ] }, "shipment_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "confirm_delivery_window_option_operation": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "delivery_window_option_id", "user_id", "inbound_plan_id", "availability_type", "start_date", "end_date", "valid_until", "discounts", "status", "shipment_id", "created", "created_by", "updated", "updated_by", "confirm_delivery_window_option_operation" ] } } }, "required": [ "total_rows", "delivery_window_options" ] }, "SelectDeliveryWindowOptionsSearchParams": { "type": "object", "properties": { "inboundPlanId": { "type": "string" }, "deliveryWindowOptionId": { "type": "string" }, "force": { "type": "boolean", "description": "pass `true` to force loading data from SP-API" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "shipmentId": { "type": "string" } }, "required": [ "shipmentId" ] }, "SelectedAllInventory": { "type": "object", "properties": { "sku": { "type": "string" }, "inventory": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "product": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "value" ] } }, { "type": "object" } ] }, "data": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sku": { "type": "object" }, "condition": { "type": "object" }, "wpid": { "type": "object" }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "productName": { "type": "object" }, "shelf": { "type": "object" }, "productType": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } ] }, "publishedStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PUBLISHED" ] }, { "type": "string", "enum": [ "READY_TO_PUBLISH" ] }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "UNPUBLISHED" ] }, { "type": "string", "enum": [ "STAGE" ] }, { "type": "string", "enum": [ "SYSTEM_PROBLEM." ] } ] }, "additionalAttributes": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "nameValueAttribute": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "variantResourceType": { "type": "object" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "object" }, "source": { "type": "object" }, "rank": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "isVariant": { "type": "object" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } ] } } } ] }, "unpublishedReasons": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "reason": { "oneOf": [ { "type": "object" }, { "type": "object" } ] } } } ] }, "lifecycleStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "ARCHIVED" ] }, { "type": "string", "enum": [ "RETIRED" ] } ] }, "isDuplicate": { "type": "object" }, "isCustomerFavorite": { "type": "object" }, "duplicateItemdetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "status": { "type": "object" }, "lastUpdatedDate": { "type": "object" }, "identifiedDate": { "type": "object" }, "destinationItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "type": "object" }, "wpid": { "type": "object" }, "gtin": { "type": "object" }, "upc": { "type": "object" }, "itemId": { "type": "object" }, "productName": { "type": "object" }, "productType": { "type": "object" }, "additionalAttributes": { "type": "object" } } } ] } } } ] } } } ] }, "getSearchResult": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "condition": { "type": "object" }, "isMarketPlaceItem": { "type": "object" }, "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } ] }, "customerRating": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } ] }, "description": { "type": "object" }, "title": { "type": "object" }, "brand": { "type": "object" }, "productType": { "type": "object" }, "properties": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variant_items_num": { "type": "object" }, "num_reviews": { "type": "object" }, "categories": { "type": "object" }, "variants": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variantMeta": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } ] }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "object" }, "itemId": { "type": "object" }, "isAvailable": { "type": "object" }, "title": { "type": "object" }, "variantValues": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "object" }, "value": { "type": "object" } } } } ] } } } } }, "required": [ "variantData" ] } ] }, "next_day_eligible": { "type": "object" } } } ] }, "parent": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } ] } } } ] } } }, { "type": "object" } ] }, "meltable": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "expiration_required": { "type": "object" }, "hazmat": { "type": "object" }, "size": { "type": "object" }, "category": { "type": "object" }, "dims": { "type": "object" }, "feed_data": { "type": "object" }, "gtins": { "type": "object" }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": "object" }, "icon": { "type": "object" } }, "required": [ "tag_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data", "gtins" ] }, "condition": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } } } } }, "warehouse_inventory": { "type": "array", "items": { "type": "object", "properties": { "item_location_id": { "type": "string" }, "location_id": { "type": "string" }, "sku": { "type": "string" }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "attachment_id": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "fulfillable": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "total": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that cannot be sold in its current state." }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "The sum of `fulfillable` and `damaged` quantity at this location." }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "location_name": { "type": "string" }, "location_type": { "type": "string", "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ] } } } }, "gtins": { "type": "array", "items": { "type": "string" } } }, "required": [ "sku", "inventory", "warehouse_inventory", "gtins" ] }, "SelectedInventory": { "type": "object", "properties": { "sku": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "product": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "value" ] } }, { "type": "object" } ] }, "data": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sku": { "type": "object" }, "condition": { "type": "object" }, "wpid": { "type": "object" }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "productName": { "type": "object" }, "shelf": { "type": "object" }, "productType": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } ] }, "publishedStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PUBLISHED" ] }, { "type": "string", "enum": [ "READY_TO_PUBLISH" ] }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "UNPUBLISHED" ] }, { "type": "string", "enum": [ "STAGE" ] }, { "type": "string", "enum": [ "SYSTEM_PROBLEM." ] } ] }, "additionalAttributes": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "nameValueAttribute": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "variantResourceType": { "type": "object" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "object" }, "source": { "type": "object" }, "rank": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "isVariant": { "type": "object" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } ] } } } ] }, "unpublishedReasons": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "reason": { "oneOf": [ { "type": "object" }, { "type": "object" } ] } } } ] }, "lifecycleStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "ARCHIVED" ] }, { "type": "string", "enum": [ "RETIRED" ] } ] }, "isDuplicate": { "type": "object" }, "isCustomerFavorite": { "type": "object" }, "duplicateItemdetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "status": { "type": "object" }, "lastUpdatedDate": { "type": "object" }, "identifiedDate": { "type": "object" }, "destinationItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "type": "object" }, "wpid": { "type": "object" }, "gtin": { "type": "object" }, "upc": { "type": "object" }, "itemId": { "type": "object" }, "productName": { "type": "object" }, "productType": { "type": "object" }, "additionalAttributes": { "type": "object" } } } ] } } } ] } } } ] }, "getSearchResult": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "condition": { "type": "object" }, "isMarketPlaceItem": { "type": "object" }, "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } ] }, "customerRating": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } ] }, "description": { "type": "object" }, "title": { "type": "object" }, "brand": { "type": "object" }, "productType": { "type": "object" }, "properties": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variant_items_num": { "type": "object" }, "num_reviews": { "type": "object" }, "categories": { "type": "object" }, "variants": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variantMeta": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } ] }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "object" }, "itemId": { "type": "object" }, "isAvailable": { "type": "object" }, "title": { "type": "object" }, "variantValues": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "object" }, "value": { "type": "object" } } } } ] } } } } }, "required": [ "variantData" ] } ] }, "next_day_eligible": { "type": "object" } } } ] }, "parent": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } ] } } } ] } } }, { "type": "object" } ] }, "meltable": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "expiration_required": { "type": "object" }, "hazmat": { "type": "object" }, "size": { "type": "object" }, "category": { "type": "object" }, "dims": { "type": "object" }, "feed_data": { "type": "object" }, "gtins": { "type": "object" }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": "object" }, "icon": { "type": "object" } }, "required": [ "tag_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data", "gtins" ] }, "condition": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } } } } } }, "required": [ "sku", "items" ] }, "SelectedReport": { "type": "object", "properties": { "report_id": { "type": "number", "description": "Internal database identifier" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "report_type_id": { "type": "number" }, "report_status_id": { "type": "number" }, "id": { "type": "string", "description": "The reportId or requestId from the API" }, "created": { "type": "string", "format": "date-time", "description": "The reportId or requestId from the API" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "finished": { "type": [ "string", "null" ], "format": "date-time", "description": "When the report finished" }, "row_count": { "type": [ "number", "null" ], "description": "When the report finished" }, "synced_count": { "type": [ "number", "null" ], "description": "The total number of rows in the report. We may not know this until the report has finished syncing" }, "errors": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "The number of rows that have been synced thus far. Is updated continuously while the report is syncing." }, "data": { "anyOf": [ { "description": "Miscellaneous other data related to the report" }, { "type": "null" } ] }, "report_type": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] }, "status": { "oneOf": [ { "type": "string", "enum": [ "WAIT", "PREPARING", "QUEUEING", "SUBMITTED", "IN_PROGRESS", "CANCELLED", "DONE", "DONE_NO_DATA", "ERROR", "FATAL" ] }, { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ] } ] }, "is_done": { "type": "boolean" } }, "required": [ "report_type", "status", "is_done" ] }, "SelectedWmShipment": { "type": "object", "properties": { "shipment_items": { "type": "array", "items": { "type": "object", "properties": { "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] } }, "user_id": { "type": "string" }, "plan_id": { "type": [ "number", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "creation_source": { "type": [ "string", "null" ], "enum": [ "purchase_order", "api", "import", "manual", "spreadsheet" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": "object" }, "deleted_by": { "type": "object" }, "status": { "type": "string" }, "shipment_id": { "type": "string" }, "ship_from_id": { "type": "number" }, "archived": { "type": "object" }, "archived_by": { "type": "object" }, "synced": { "type": "object" }, "ship_to_address": { "type": [ "object", "null" ], "properties": { "fcName": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "fcName", "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "shipment_units": { "type": "object" }, "received_units": { "type": "object" }, "items_submitted": { "type": "object" }, "received_units_at_fc": { "type": "object" }, "expected_delivery_date": { "type": "object" }, "updated_expected_delivery_date": { "type": "object" }, "actual_delivery_date": { "type": "object" }, "tracking_no": { "type": [ "object", "null" ] }, "carrier_name": { "type": "object" }, "channel_method": { "type": "object" }, "ship_node": { "type": "object" }, "shipment_type": { "type": "object" }, "po_type": { "type": "object" }, "shipment_carrier_type": { "type": "object" }, "is_exception_occurred": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "exception_status": { "type": "object" }, "is_po_box_enabled": { "type": "object" }, "transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object" }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "object" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "object" }, "carrierName": { "type": "string" }, "shipmentType": { "type": "string" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": { "type": "object" } } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "consolidated_transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object" } }, "receipt_start_date": { "type": "object" }, "receipt_end_date": { "type": "object" }, "data": { "type": "object" }, "carrier_rate_quotes": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "assessorialCharge": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "carrier": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "carrierId": { "type": "object" }, "carrierName": { "type": "object" } } } ] }, "currency": { "type": "object" }, "declaredValue": { "type": "object" }, "discountCharge": { "type": "object" }, "effectiveDate": { "type": "object" }, "equipmentTypeCode": { "type": "object" }, "estimatedDeliveryDateTime": { "type": "object" }, "expiryDate": { "type": "object" }, "freightCharge": { "type": "object" }, "freightReadyDate": { "type": "object" }, "fuelCharge": { "type": "object" }, "minimumCharge": { "type": "object" }, "mixedSKUs": { "type": "object" }, "mode": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "LTL" ] }, { "type": "string", "enum": [ "PARCEL" ] }, { "type": "string", "enum": [ "FTL" ] } ] }, "netCharge": { "type": "object" }, "nominalCharge": { "type": "object" }, "numberOfPallets": { "type": "object" }, "quoteId": { "type": "object" }, "sellerFreightClassCode": { "type": "object" }, "serviceCharge": { "type": "object" }, "serviceCode": { "type": "object" }, "singleSKUs": { "type": "object" }, "status": { "type": "object" }, "surchargeType": { "type": "object" }, "surchargeValue": { "type": "object" }, "totalBillingWeight": { "type": "object" }, "totalVolume": { "type": "object" }, "totalWeight": { "type": "object" }, "transitDays": { "type": "object" }, "sp_status": { "type": "object" } } } }, "inbound_order_id": { "type": "string" }, "single_sku_box_count": { "type": "object" }, "mixed_sku_box_count": { "type": "object" }, "user_shipment_carrier_type": { "type": "object" }, "preferred_pickup_date": { "type": "object" }, "freight_class": { "type": "object" }, "declared_value": { "type": "object" }, "pickup_instructions": { "type": "object" }, "pickup_seller_schedule": { "type": "object" } }, "required": [ "shipment_items", "user_id", "plan_id", "marketplace_id", "creation_source", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by", "status", "shipment_id", "ship_from_id", "archived", "archived_by", "synced", "ship_to_address", "shipment_units", "received_units", "items_submitted", "received_units_at_fc", "expected_delivery_date", "updated_expected_delivery_date", "actual_delivery_date", "tracking_no", "carrier_name", "channel_method", "ship_node", "shipment_type", "po_type", "shipment_carrier_type", "is_exception_occurred", "exception_status", "is_po_box_enabled", "transfer_shipments", "consolidated_transfer_shipments", "receipt_start_date", "receipt_end_date", "data", "carrier_rate_quotes", "inbound_order_id", "single_sku_box_count", "mixed_sku_box_count", "user_shipment_carrier_type", "preferred_pickup_date", "freight_class", "declared_value", "pickup_instructions", "pickup_seller_schedule" ] }, "SelectFeedsParams": { "type": "object", "properties": { "feed_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "A list of feeds to be processed when this one completes" }, "next": { "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "status": { "type": "array", "items": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "PROCESSED", "ERROR", "Submitted" ] } }, "type": { "type": "array", "items": { "type": "string", "enum": [ "MP_ITEM_MATCH", "MP_ITEM", "inventory", "PRICE_AND_PROMOTION", "OMNI_WFS", "price" ] } }, "limit": { "type": "number" } } }, "SelectFeedsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "feeds": { "type": "array", "items": { "type": "object", "properties": { "feed_id": { "type": "string" }, "user_id": { "type": "string" }, "feed_type_id": { "type": "number" }, "feed_status_id": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "data": { "type": [ "object", "null" ], "properties": { "feedId": { "type": "string" }, "feedType": { "type": "string", "enum": [ "price", "inventory", "MP_ITEM_MATCH", "MP_ITEM", "PRICE_AND_PROMOTION", "OMNI_WFS" ] }, "feedStatus": { "type": "string", "enum": [ "ERROR", "RECEIVED", "INPROGRESS", "PROCESSED", "Submitted" ] }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "itemDetails": { "type": "object", "properties": { "itemIngestionStatus": { "type": "object", "additionalProperties": { "type": "object", "properties": { "martId": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "wpid": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "index": { "type": "object" }, "ingestionStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "INPROGRESS" ] }, { "type": "string", "enum": [ "SUCCESS" ] }, { "type": "string", "enum": [ "DATA_ERROR" ] }, { "type": "string", "enum": [ "SYSTEM_ERROR" ] }, { "type": "string", "enum": [ "TIMEOUT_ERROR" ] } ] }, "sku": { "type": "object" }, "ingestionErrors": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "ingestionError": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ] }, "code": { "type": "string" }, "field": { "type": "object" }, "description": { "type": "object" } }, "required": [ "type", "code" ] } } ] } } } ] } } } } }, "required": [ "itemIngestionStatus" ] } }, "required": [ "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing", "itemDetails" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "source_data": { "type": [ "object", "null" ], "properties": { "buylist_ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "buylist_ids" ] }, "pending_feeds": { "type": [ "array", "null" ], "items": { "oneOf": [ { "type": "object", "properties": { "MPItemFeedHeader": { "oneOf": [ { "type": "object", "properties": { "requestId": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "requestBatchId": { "type": "object" }, "feedDate": { "type": "object" }, "processMode": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "REPLACE" ] } ] }, "subset": { "type": "object" }, "Mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sellingChannel": { "type": "string", "enum": [ "mpsetupbymatch" ] }, "version": { "type": "string", "enum": [ "4.2" ] }, "locale": { "type": "string", "enum": [ "en" ] } }, "required": [ "sellingChannel", "version", "locale" ] }, { "type": "object", "properties": { "businessUnit": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ] }, "locale": { "type": "string", "enum": [ "en" ] }, "version": { "type": "string", "enum": [ "5.0.20250121-19_24_23-api" ] } }, "required": [ "businessUnit", "locale", "version" ] }, { "type": "object", "properties": { "businessUnit": { "type": "object" }, "locale": { "type": "string", "enum": [ "en" ] }, "version": { "type": "string", "enum": [ "2.0.20240126-12_25_52-api" ] } }, "required": [ "businessUnit", "locale", "version" ] } ] }, "MPItem": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "Item": { "type": "object", "properties": { "sku": { "type": "string" }, "productIdentifiers": { "type": "object", "properties": { "productIdType": { "type": "string", "enum": [ "EAN", "GTIN", "ISBN", "UPC" ] }, "productId": { "type": "string" } }, "required": [ "productIdType", "productId" ] }, "price": { "type": "number" }, "ShippingWeight": { "type": "number" }, "condition": { "type": "string", "enum": [ "New", "New with defects", "New without box", "New without tags", "Open Box", "Pre-Owned: Fair", "Pre-Owned: Good", "Pre-Owned: Like New", "Remanufactured", "Restored Premium", "Restored" ] }, "mainImageUrl": { "type": "object" }, "productSecondaryImageURL": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "productCategory": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "Animal Accessories" ] }, { "type": "string", "enum": [ "Animal Food" ] }, { "type": "string", "enum": [ "Animal Health & Grooming" ] }, { "type": "string", "enum": [ "Animal Other" ] }, { "type": "string", "enum": [ "Art & Craft" ] }, { "type": "string", "enum": [ "Baby Diapering, Care, & Other" ] }, { "type": "string", "enum": [ "Baby Food" ] }, { "type": "string", "enum": [ "Baby Furniture" ] }, { "type": "string", "enum": [ "Baby Toys" ] }, { "type": "string", "enum": [ "Baby Transport" ] }, { "type": "string", "enum": [ "Beauty, Personal Care, & Hygiene" ] }, { "type": "string", "enum": [ "Bedding" ] }, { "type": "string", "enum": [ "Books & Magazines" ] }, { "type": "string", "enum": [ "Building Supply" ] }, { "type": "string", "enum": [ "Cameras & Lenses" ] }, { "type": "string", "enum": [ "Carriers & Accessories" ] }, { "type": "string", "enum": [ "Cases & Bags" ] }, { "type": "string", "enum": [ "Ceremonial Clothing & Accessories" ] }, { "type": "string", "enum": [ "Clothing" ] }, { "type": "string", "enum": [ "Computer Components" ] }, { "type": "string", "enum": [ "Computers" ] }, { "type": "string", "enum": [ "Costumes" ] }, { "type": "string", "enum": [ "Cycling" ] }, { "type": "string", "enum": [ "Decorations & Favors" ] }, { "type": "string", "enum": [ "Electrical" ] }, { "type": "string", "enum": [ "Electronics Accessories" ] }, { "type": "string", "enum": [ "Electronics Cables" ] }, { "type": "string", "enum": [ "Electronics Other" ] }, { "type": "string", "enum": [ "Food & Beverage" ] }, { "type": "string", "enum": [ "Footwear" ] }, { "type": "string", "enum": [ "Fuels & Lubricants" ] }, { "type": "string", "enum": [ "Funeral" ] }, { "type": "string", "enum": [ "Furniture" ] }, { "type": "string", "enum": [ "Garden & Patio" ] }, { "type": "string", "enum": [ "Gift Supply & Awards" ] }, { "type": "string", "enum": [ "Grills & Outdoor Cooking" ] }, { "type": "string", "enum": [ "Hardware" ] }, { "type": "string", "enum": [ "Health & Beauty Electronics" ] }, { "type": "string", "enum": [ "Home Decor, Kitchen, & Other" ] }, { "type": "string", "enum": [ "Household Cleaning Products & Supplies" ] }, { "type": "string", "enum": [ "Instrument Accessories" ] }, { "type": "string", "enum": [ "Jewelry" ] }, { "type": "string", "enum": [ "Land Vehicles" ] }, { "type": "string", "enum": [ "Large Appliances" ] }, { "type": "string", "enum": [ "Medical Aids & Equipment" ] }, { "type": "string", "enum": [ "Medicine & Supplements" ] }, { "type": "string", "enum": [ "Movies" ] }, { "type": "string", "enum": [ "Music Cases & Bags" ] }, { "type": "string", "enum": [ "Music" ] }, { "type": "string", "enum": [ "Musical Instruments" ] }, { "type": "string", "enum": [ "Office" ] }, { "type": "string", "enum": [ "Optical" ] }, { "type": "string", "enum": [ "Optics" ] }, { "type": "string", "enum": [ "Other" ] }, { "type": "string", "enum": [ "Photo Accessories" ] }, { "type": "string", "enum": [ "Plumbing & HVAC" ] }, { "type": "string", "enum": [ "Printers, Scanners, & Imaging" ] }, { "type": "string", "enum": [ "Safety & Emergency" ] }, { "type": "string", "enum": [ "Software" ] }, { "type": "string", "enum": [ "Sound & Recording" ] }, { "type": "string", "enum": [ "Sports & Recreation Other" ] }, { "type": "string", "enum": [ "Storage" ] }, { "type": "string", "enum": [ "TV Shows" ] }, { "type": "string", "enum": [ "TVs & Video Displays" ] }, { "type": "string", "enum": [ "Tires" ] }, { "type": "string", "enum": [ "Tools & Hardware Other" ] }, { "type": "string", "enum": [ "Tools" ] }, { "type": "string", "enum": [ "Toys" ] }, { "type": "string", "enum": [ "Vehicle Other" ] }, { "type": "string", "enum": [ "Vehicle Parts & Accessories" ] }, { "type": "string", "enum": [ "Video Games" ] }, { "type": "string", "enum": [ "Video Projectors" ] }, { "type": "string", "enum": [ "Watches" ] }, { "type": "string", "enum": [ "Watercraft" ] }, { "type": "string", "enum": [ "Wheels & Wheel Components" ] } ] }, "stateRestrictions": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "stateRestrictionsText": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "None" ] }, { "type": "string", "enum": [ "Illegal for Sale" ] }, { "type": "string", "enum": [ "Commercial" ] } ] }, "states": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "AK - Alaska" ] }, { "type": "string", "enum": [ "AL - Alabama" ] }, { "type": "string", "enum": [ "AR - Arkansas" ] }, { "type": "string", "enum": [ "AS - American Samoa" ] }, { "type": "string", "enum": [ "AZ - Arizona" ] }, { "type": "string", "enum": [ "CA - California" ] }, { "type": "string", "enum": [ "CO - Colorado" ] }, { "type": "string", "enum": [ "CT - Connecticut" ] }, { "type": "string", "enum": [ "DC - District of Columbia" ] }, { "type": "string", "enum": [ "DE - Delaware" ] }, { "type": "string", "enum": [ "FL - Florida" ] }, { "type": "string", "enum": [ "FM - Federated States of Micronesia" ] }, { "type": "string", "enum": [ "GA - Georgia" ] }, { "type": "string", "enum": [ "GU - Guam" ] }, { "type": "string", "enum": [ "HI - Hawaii" ] }, { "type": "string", "enum": [ "IA - Iowa" ] }, { "type": "string", "enum": [ "ID - Idaho" ] }, { "type": "string", "enum": [ "IL - Illinois" ] }, { "type": "string", "enum": [ "IN - Indiana" ] }, { "type": "string", "enum": [ "KS - Kansas" ] }, { "type": "string", "enum": [ "KY - Kentucky" ] }, { "type": "string", "enum": [ "LA - Louisiana" ] }, { "type": "string", "enum": [ "MA - Massachusetts" ] }, { "type": "string", "enum": [ "MD - Maryland" ] }, { "type": "string", "enum": [ "ME - Maine" ] }, { "type": "string", "enum": [ "MH - Marshall Islands" ] }, { "type": "string", "enum": [ "MI - Michigan" ] }, { "type": "string", "enum": [ "MN - Minnesota" ] }, { "type": "string", "enum": [ "MO - Missouri" ] }, { "type": "string", "enum": [ "MP - Commonwealth of the Northern Mariana Islands" ] }, { "type": "string", "enum": [ "MS - Mississippi" ] }, { "type": "string", "enum": [ "MT - Montana" ] }, { "type": "string", "enum": [ "NC - North Carolina" ] }, { "type": "string", "enum": [ "ND - North Dakota" ] }, { "type": "string", "enum": [ "NE - Nebraska" ] }, { "type": "string", "enum": [ "NH - New Hampshire" ] }, { "type": "string", "enum": [ "NJ - New Jersey" ] }, { "type": "string", "enum": [ "NM - New Mexico" ] }, { "type": "string", "enum": [ "NV - Nevada" ] }, { "type": "string", "enum": [ "NY - New York" ] }, { "type": "string", "enum": [ "OH - Ohio" ] }, { "type": "string", "enum": [ "OK - Oklahoma" ] }, { "type": "string", "enum": [ "OR - Oregon" ] }, { "type": "string", "enum": [ "PA - Pennsylvania" ] }, { "type": "string", "enum": [ "PR - Puerto Rico" ] }, { "type": "string", "enum": [ "PW - Palau" ] }, { "type": "string", "enum": [ "RI - Rhode Island" ] }, { "type": "string", "enum": [ "SC - South Carolina" ] }, { "type": "string", "enum": [ "SD - South Dakota" ] }, { "type": "string", "enum": [ "TN - Tennessee" ] }, { "type": "string", "enum": [ "TX - Texas" ] }, { "type": "string", "enum": [ "UM - U.S. Minor Outlying Islands" ] }, { "type": "string", "enum": [ "UT - Utah" ] }, { "type": "string", "enum": [ "VA - Virginia" ] }, { "type": "string", "enum": [ "VI - U.S. Virgin Islands" ] }, { "type": "string", "enum": [ "VT - Vermont" ] }, { "type": "string", "enum": [ "WA - Washington" ] }, { "type": "string", "enum": [ "WI - Wisconsin" ] }, { "type": "string", "enum": [ "WV - West Virginia" ] }, { "type": "string", "enum": [ "WY - Wyoming" ] } ] }, "zipCodes": { "type": "object" } } } } ] }, "additionalProductAttributes": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "productAttributeName": { "type": "string" }, "productAttributeValue": { "type": "string" } }, "required": [ "productAttributeName", "productAttributeValue" ] } } ] }, "additionalOfferAttributes": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "additionalOfferAttributeName": { "type": "string" }, "additionalOfferAttributeValue": { "type": "string" } }, "required": [ "additionalOfferAttributeName", "additionalOfferAttributeValue" ] } } ] } }, "required": [ "sku", "productIdentifiers", "price", "ShippingWeight", "condition" ] } }, "required": [ "Item" ] }, { "type": "object", "properties": { "Orderable": { "type": "object", "properties": { "sku": { "type": "string" }, "productIdentifiers": { "type": "object" }, "price": { "type": "number" }, "ShippingWeight": { "type": "number" }, "stateRestrictions": { "type": "object" }, "electronicsIndicator": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "Yes" ] }, { "type": "string", "enum": [ "No" ] } ] }, "chemicalAerosolPesticide": { "type": "object" }, "batteryTechnologyType": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "Mercury" ] }, { "type": "string", "enum": [ "Carbon Zinc" ] }, { "type": "string", "enum": [ "Lead Acid (Non-Spillable)" ] }, { "type": "string", "enum": [ "Alkaline" ] }, { "type": "string", "enum": [ "Does Not Contain a Battery" ] }, { "type": "string", "enum": [ "Lithium Primary (Lithium Metal)" ] }, { "type": "string", "enum": [ "Nickel Cadmium" ] }, { "type": "string", "enum": [ "Lithium Ion" ] }, { "type": "string", "enum": [ "Nickel Metal Hydride" ] }, { "type": "string", "enum": [ "Lead Acid" ] }, { "type": "string", "enum": [ "Silver" ] }, { "type": "string", "enum": [ "Magnesium" ] } ] }, "fulfillmentLagTime": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "shipsInOriginalPackaging": { "type": "object" }, "MustShipAlone": { "type": "object" }, "IsPreorder": { "type": "object" }, "releaseDate": { "type": "object" }, "startDate": { "type": "object" }, "endDate": { "type": "object" }, "quantity": { "type": "object" }, "fulfillmentCenterID": { "type": "object" }, "inventoryAvailabilityDate": { "type": "object" }, "ProductIdUpdate": { "type": "object" }, "SkuUpdate": { "type": "object" }, "msrp": { "type": "object" } }, "required": [ "sku", "productIdentifiers", "price", "ShippingWeight" ] }, "Visible": { "type": "object", "additionalProperties": { "type": "object", "properties": { "productName": { "type": "string" }, "brand": { "type": "string" }, "shortDescription": { "type": "string" }, "keyFeatures": { "type": "object" }, "mainImageUrl": { "type": "string" }, "isProp65WarningRequired": { "type": "string", "enum": [ "Yes", "No" ] }, "smallPartsWarnings": { "type": "string", "enum": [ "0 - No warning applicable", "1 - Choking hazard is a small ball", "2 - Choking hazard contains small ball", "3 - Choking hazard contains small parts", "4 - Choking hazard balloon", "5 - Choking hazard is a marble", "6 - Choking hazard contains a marble" ] }, "has_written_warranty": { "type": "string", "enum": [ "No", "Yes - Warranty Text", "Yes - Warranty URL" ] }, "netContent": { "type": "object", "properties": { "productNetContentMeasure": { "type": "number" }, "productNetContentUnit": { "type": "string", "enum": [ "Count", "Cubic Foot", "Case", "Centiliter", "Centimeter", "Each", "Fluid Ounces", "Foot", "Gallon", "Gram", "Inch", "Kilogram", "Liter", "Meter", "Milliliter", "Ounce", "Pallet/Unit Load", "Pint", "Pound", "Quart Dry", "Quart", "Square Foot", "Yard" ] } }, "required": [ "productNetContentMeasure", "productNetContentUnit" ] }, "productSecondaryImageURL": { "type": "object" }, "assembledProductLength": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "measure": { "type": "number" }, "unit": { "type": "string", "enum": [ "mm", "ft", "cm", "in" ] } }, "required": [ "measure", "unit" ] } ] }, "assembledProductWidth": { "type": "object" }, "assembledProductHeight": { "type": "object" }, "assembledProductWeight": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "measure": { "type": "number" }, "unit": { "type": "string", "enum": [ "lb", "oz" ] } }, "required": [ "measure", "unit" ] } ] }, "prop65WarningText": { "type": "object" }, "color": { "type": "object" }, "colorCategory": { "type": "array", "items": { "type": "string", "enum": [ "Silver", "Beige", "Black", "Blue", "Bronze", "Brown", "Clear", "Gold", "Gray", "Green", "Multicolor", "Off-White", "Orange", "Pink", "Purple", "Red", "White", "Yellow" ] } }, "countPerPack": { "type": "object" }, "condition": { "type": "object" }, "manufacturer": { "type": "object" }, "manufacturerPartNumber": { "type": "object" }, "material": { "type": "object" }, "modelNumber": { "type": "object" }, "multipackQuantity": { "type": "object" }, "netContentStatement": { "type": "object" }, "pieceCount": { "type": "object" }, "occasion": { "type": "object" }, "productLine": { "type": "object" }, "skateboard_riser_type": { "type": "object" }, "sportsLeague": { "type": "object" }, "sportsTeam": { "type": "object" }, "thirdPartyAccreditationSymbolOnProductPackageCode": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "Fair 'n Green", "Mom's Choice Award", "Parent Tested Parent Approved (PTPA) Winner's Seal of Approval", "Water Quality Association (WQA's)- Tested and Certified", "100 Percent Canadian Milk", "100% Veganskt", "ACMI", "ADCCPA", "AFIA Pet Food Facility", "AGRI Confiance", "AMA Organic Seal", "ATG", "Absence of Eggs and Milk is a Certified Allergen Control (CAC)", "Absence of Eggs, Milk and Peanuts is a Certified Allergen Control (CAC)", "Absence of Peanuts & Almonds is a Certified Allergen Control (CAC)", "Agence Bio", "Agri Natura", "Agriculture Biologique", "Air cleaner performance standard e.g., humidifiers", "Aise 2005", "Aise 2010", "Aise", "Aliments BIO Prepares au Quebec", "Aliments Prepares au Quebec", "Aliments du Quebec BIO", "Aliments du Quebec", "Alpinavera", "Aluminium Gesamtverband der Aluminiumindustrie", "Ama Organic Seal Black", "Ama Seal of Approval", "American Dental Association", "American Heart Association Certified", "Animal Welfare Approved Grassfed", "Appellation Origine Controlee", "Approved by the Asthma and Allergy Association", "Aqua GAP", "Aquaculture Stewardship Council", "Arla Farmer Owned", "Asmi", "Asthma and Allergy Foundation of America", "Atlanta Kashrus Commission Certification", "BC SPCA", "BDIH Logo", "BRC Global Standards", "BSCI", "Bais Din of Crown Heights Vaad HaKashrus Certification", "Bebat", "Belgaqua", "Benor", "Berchtesgadener Land", "Best Aquaculture Practices 2 Stars", "Best Aquaculture Practices 3 Stars", "Best Aquaculture Practices 4 Stars", "Best Aquaculture Practices", "Beter Leven 1 Ster", "Beter Leven 2 Ster", "Beter Leven 3 Ster", "Better Business Bureau Accredited", "Better Cotton Initiative", "Biko Tirol", "Bio Fisch", "Bio Gourmet Knospe", "Bio Knospe Umstellung", "Bio Knospe", "Bio Partenaire", "Bio Ring Allgaeu", "Bio Solidaire", "Bio Suisse Knospe Umstellung", "Bio Suisse Knospe", "Bio-Bayern with Certificate of Provenance", "Bio-Bayern without Certificate of Provenance", "Bio-LABEL Baden-Württemberg", "Bio-LABEL Hessen", "Biodegradable Ingredients", "Biodegradable Products Institute", "Biodegradable", "Biodynamic Certification", "Biogarantie", "Biokreis", "Bioland Ennstal", "Bioland", "Biopark", "Bios Kontrolle", "Bird Friendly Coffee Smithsonian Certification", "Bk Check Vaad Hakashrus Of Buffalo", "Blue Angel", "Blue Ribbon Kosher", "Bluesign Technologies AG Approved e.g., footwear insoles", "BonSucro", "Bord Bia Approved Meat", "Bord Bia Approved", "BreatheWay", "Brewers Association Certified Independent Craft", "British Retail Consortium Certification", "Bullfrog Power", "CAC Absence of Almond", "CAC Absence of Egg", "CAC Absence of Milk", "CAC Absence of Peanut", "CAN/ BNQ Certified", "CCA Gluten Free", "CCF Rabbit Certification", "CCOF", "CEBEC", "CO2 Neutral Certified", "CO2 Reduceret Emballage", "CPE Scharrel Eieren", "CPE Vrije Uitloop Eieren", "CSA International", "CSA/NCA - Gluten Free", "Canada Organic Canadian Organic Logo", "CanadaGAP program certification mark of conformity", "Canadian Agricultural Products", "Canadian Association of Fire Chiefs Approved", "Canadian Certified Compostable", "Canadian Eco Logo", "Canadian Federal Government – CFIA Grade Stamps Canada A e.g. poultry & eggs", "Canadian Federal Government – CFIA Grade Stamps Canada C e.g. poultry & eggs", "Canadian Federal Government – CFIA Grade Stamps Canada Utility e.g. poultry & eggs", "Canadian Federal Government – Dairy Product Grade", "Canadian Federal Government – Processed Egg Products", "Canadian Food Inspection Agency (CFIA) as Federally Registered & Inspected Facility - Fish", "Canadian Food Inspection Agency (CFIA) as Federally Registered & Inspected Facility e.g., meat", "Canned in Canada to describe green beans", "Carbon Footprint Standard", "Carbon Neutral NCOS Certified", "Carbon Neutral packaging", "Carbon Neutral", "Caribbean Kosher", "Caring Consumer PETA", "Celiac Sprue Association", "Central Rabbinical Congress Kosher", "Certified Angus Beef", "Certified B Corporation", "Certified California Sustainable Vineyard and Winery (CCSW)", "Certified Carbon Free", "Certified Humane Organisation", "Certified Humane", "Certified Naturally Grown (CNG)", "Certified Naturally Grown", "Certified OE 100", "Certified Organic Baystate Organic Certifiers", "Certified Organic By Organic Certifiers", "Certified Paleo Friendly", "Certified Paleo", "Certified Sustainable Wine of Chile", "Certified WBENC", "Certified Wildlife Friendly", "Cheese – World Champion Cheese Contest", "Ches K", "Chicago Rabbinical Council", "Cincinnati Kosher", "Claro Fair Trade", "Climate Neutral", "Cocoa Life", "Consumer Choice Award", "Corrugated Recycles", "Cosmebio", "Cotton made in Africa", "Council of Orthodox Rabbis of Greater Detroit Certification", "Cradle To Cradle", "Crossed Grain Symbol", "Culinarium", "DLG Award", "DZG Gluten Free", "Dallas Kosher Certification", "Dansk IP Kvalitet", "Dansk Maelk", "Deer Protection Program", "Delinat", "Demeter Label", "Dermatology Review Panel (\"DRP\") independent dermatologists review", "Design for the Environment (DfE)", "Diamond K - Massachusetts Certification", "Direct Trade", "Distilled in Canada to describe bottled water", "Dolphin Safe", "Donau Soya Standard", "ECARF Seal", "ECOCert Cosmos Natural", "ECOCert Cosmos Organic", "ECOLAND", "EarthKosher Kosher Certification", "Earthsure", "Eco Kreis", "Eco Label Ladybug", "Eco Logo", "EcoCert Certificate", "Ecogarantie", "Ecovin", "Eczema Society of Canada- Accepted", "Eesti Okomark", "Eesti Parim Toiduaine", "Eko", "Enec", "Energy Star", "Epeat Bronze", "Epeat Gold", "Epeat Silver", "Equal Exchange Fairly Traded", "Equalitas Sustainable Wine", "Erde Saat", "Erkend Streek Product", "Ethical Tea Partnership", "Fair Flowers Fair Plants", "Fair Food Program Label", "Fair Trade USA Ingredients", "Fair Trade USA", "Fair for Life", "Fair trade mark", "FairTSA", "FairTrade Cotton", "FairTrade Sugar", "Fairtrade Sourced Ingredient Cashew Nuts", "Fairtrade Sourced Ingredient Cocoa", "Fairtrade Sourced Ingredient Coconut", "Fairtrade Sourced Ingredient Dried Apricots", "Fairtrade Sourced Ingredient Green Tea", "Fairtrade Sourced Ingredient Honey", "Fairtrade Sourced Ingredient Lime Juice", "Fairtrade Sourced Ingredient Mango Juice", "Fairtrade Sourced Ingredient Olive Oil", "Fairtrade Sourced Ingredient Pepper", "Fairtrade Sourced Ingredient Quinoa", "Fairtrade Sourced Ingredient Rice", "Fairtrade Sourced Ingredient Roses", "Fairtrade Sourced Ingredient Tea", "Fairtrade Sourced Ingredient Vanilla", "Falken", "Farmers & Growers (Organic Certification UK2)", "Federal Communications Commission (U.S.)", "Federally Registered Inspected Canada", "Fidelio", "Finnish Heart Symbol", "Finnish Pork Meat Certification System", "Fish Wise Certification", "Flamme Verte", "Flandria", "Food Alliance Certified", "Food Federation", "Food Justice Certified", "Food Safety System Certification 22000", "Foodland Ontario", "For Life (Social Responsibility)", "Forest Products - Product Lines From a Certified Forest", "Forest Stewardship Council 100 Percent", "Forest Stewardship Council Label", "Forest Stewardship Council Mix", "Forest Stewardship Council Recycled", "Foundation Art", "Freiland", "Freshcare", "Friend of the Sea", "GAA", "GCP – Global Coffee Platform", "GFCO", "GFCP", "GIG - Gluten Free Foodservice", "GMO Guard from Natural Food Certifiers", "GMO Marked", "GMP Certified", "GMP ISO 22716", "GRASKEURMERK", "GRASP – Risk Assessment on Social Practise", "Gaskeur", "Gastec", "Gebana", "Gepruefte Sicherheit", "Gezondere Keuze", "Global Care", "Global Gap", "Global Organic Latex Standard", "Global Organic Textile Standard", "Gluten-free Certified: Allergen Control Group/ National Foundation for Celiac Awareness (NFCA)", "Glycaemic Index Foundation", "Glycaemic Research Institute", "Good Housekeeping", "GoodWeave", "Green America Certified Business", "Green Dot", "Green Restaurant Association Endorsed", "Green Seal Certified", "Green Seal", "Green Shield Certified", "Green Star Certified", "Green-e Energy Certified", "Green-e Energy", "GreenChoice", "Groen Label Kas", "Guaranteed Irish", "Halal Certification Services", "Halal Certification Services, CH", "Halal Correct", "Halal Islamic Food and Nutrition Council of Canada (IFANCC)", "Halal Islamic Society of North America (ISNA)", "Halal Plus", "Haute Valeur Environnementale", "Hazard Analysis Critical Control Point", "Health Check", "Heumilch", "Hochstamm Suisse", "Humane Heartland", "Hypertension Canada Medical Device", "ICADA", "ICEA", "IFANCA Halal", "IFOAM", "IFS HPC", "IGP", "IHTK Seal", "IKB EIEREN", "IKB KIP", "IKB VARKEN", "INSTITUT FRESENIUS", "INT Protection", "IP Suisse", "ISEAL Alliance", "ISO Quality", "IVN Natural Leather", "IVN Natural Textiles Best", "IVO Seal – International Verified Omega-3 e.g., Fish oil", "Imported in bulk and packaged in Canada", "Indeklima Maerket", "Integrity and Sustainability Certified", "International Aloe Science Council Certificate", "International Taste & Quality (iTQi) Superior Taste Award", "Intertek Certificate", "Intertek Electrical Testing Laboratories (ETL) Mark", "Jay Kosher Pareve", "KAT", "KEMA KEUR", "KIWA", "KOF K Kosher", "KOMO", "KSA - Kosher", "KSA D - Kosher Dairy", "KVBG Approved", "KVH Kosher", "Kashruth Council of Canada Kosher Certification", "Kehilla Kosher California K", "Kehilla Kosher Heart K", "Klasa", "Kosher - Chicago Rabbinical Council (CRC) Dairy", "Kosher COR Dairy Equipment", "Kosher COR Dairy", "Kosher COR Fish", "Kosher Certification Service", "Kosher Check", "Kosher Chicago Rabbinical Council (CRC) Pareve", "Kosher Grand Rabbinate of Quebec Parve", "Kosher Inspection Service India", "Kosher KW Young Israel Of West Hempstead", "Kosher Kosher Greece", "Kosher Kosher Madrid Spain", "Kosher OK Dairy", "Kosher Oregon Kosher", "Kosher Organics", "Kosher Orthodox Jewish Congregation Parve", "Kosher Ottawa Vaad HaKashrut Canada", "Kosher Parve Natural Food Certifier", "Kosher Peru Certification", "Kosher Star-K -Parve and Passover", "Kosher Star-K-Parve", "Kosher Supervisors of Wisconsin Certification", "Kosher Western Kosher (WK)", "KosherMex", "Krav Mark", "LACON", "LGA", "LVA", "Label Rouge", "Label of the Allergy and Asthma Federation", "Laendle Qualitaet", "Leaping Bunny", "Lodi Rules \"Certified Green\"", "London Beth Din Kosher", "MCIA Organic", "MEHR WEG", "MPS A", "Made Green in Italy", "Made in Canada (a)", "Made in Canada from Domestic and Imported Ingredients", "Made in Canada", "Made with 100% Canadian Oats", "Made with Canadian (ingredient)", "Made with Canadian Beef", "Made with Canadian Mustard Seeds", "Made with Ontario Pork", "Marine Stewardship Council label", "Max Havelaar", "Midwest Kosher", "Minnesota Kosher Council", "Montreal Vaad Hair Mk Pareve", "Mortadella Bologna", "Mundusvini Gold", "Mundusvini Silver", "My Climate", "NAOOA Certified Quality", "NDOA", "NF Marque", "NMX", "NOM", "NPA", "NSF Certified For Sport", "NSF Gluten Free", "NSF Non GMO True North", "NSF Sustainability Certified", "NSF", "National Eczema Association Seal of Acceptance", "Natrue Label", "Natura- Beef", "Natura-Veal", "Nature Care Product", "Nature Et Progres", "Natureplus", "Naturland Fair Trade", "Naturland Wildfish", "Naturland", "Neuland", "No Product Package Certifications Apply", "Non GMO Project", "Non-GMO By Earthkosher", "Nyckelhalet", "OCIA", "OEKO Control", "OEKO Kreislauf", "OEKO Quality Guarantee Bavaria", "OEKO-Tex Made in Green", "OK Compost Home", "OK Compost Industrial", "OK Compost label by Vincotte", "OK Kosher Certification", "OKOTEST", "ORBI", "OU Kosher Dairy", "OU Kosher Fish", "OU Kosher Meat", "OU Kosher Passover", "Ocean Wise Recommended Sourced Responsibly", "Oeko Tex Label", "Official Eco label Sun", "On the way to planetproof", "Ontario - Localize", "Ontario approved legend - Inspected meat products, provincially licensed plants", "Oregon LIVE (Low Input Viticulture and Enology)", "Oregon Tilth", "Organic 100 Content Standard", "Organic Certifying Body - Centre for Systems Integration,", "Organic Certifying Body - International Certification Services, Inc. (ICS), North Dakota, USA", "Organic Certifying Body - JAS (Japanese Agricultural Standards)", "Organic Certifying Body - OTCO (OREGON TILTH CERTIFIED ORGANIC), Oregon, U.S.A.", "Organic Certifying Body – Agricultural Services Certified Organic (ASCO)", "Organic Certifying Body – Debio", "Organic Certifying Body – EcoCert, Quebec, Canada", "Organic Certifying Body – Global Organic Alliance (GOA), Ohio, U.S.A.", "Organic Certifying Body – Letis S.A.", "Organic Certifying Body – Organisme de Certification Québec Vrai (OCQV)", "Organic Certifying Body – Pro-Cert Organic Systems, Saskatchewan, Canada", "Organic Certifying Body – Province of British Columbia Certified Organic, British Columbia Association for Regenerative Agriculture (BCARA), Canada", "Organic Certifying Body – Quality Certification Services (QCS), Florida, U.S.A.", "Organic Certifying Body – Trans Canada Organic Certification Services (TCO), Saskatchewan, Canada", "Organic Certifying Body –Pacific Agricultural Certification Society (PACS), British Columbia, Canada", "Organic Cotton", "Orthodox Rabbinical Board", "Orthodox Union Kosher", "Ozone Friendly General Claim", "PCO", "PEFC Certified", "PEFC Recycled", "PEFC", "Paleo Approved", "Paleo By Earthkosher", "Pet to Pet", "Plastic Free Trust Mark", "Prepared in Canada", "Pro Specie Rara", "Pro-Terra Non-GMO Certification", "Processed in Canada", "Proderm", "Product of Canada", "Product of the Vinho Verde Region", "Product of the Year, Consumer Survey", "Produit en Bretagne", "Protected Designation of Origin", "Protected Geographical Indication", "Protected Harvest Certified", "Proudly Canadian", "Proven Quality Bavaria", "Puhtaasti Kotimainen", "QAI", "QS", "Qualenvi", "Qualitaet Tirol", "Quality Rhoen", "RAL Quality Candles", "REGIONALFENSTER", "RHP", "RSB – Roundtable on Sustainable Biomaterials", "RT-QuIC Tested", "RT-QuIC", "Rabbinical Council Of British Columbia BCK", "Rabbinical Council Of California", "Rabbinical Council Of New England", "Rainforest Alliance", "Real California Cheese", "Real California Milk", "Real Food Seal", "Recognized Canadian Dermatology Association Skin Health", "Recognized Canadian Dermatology Association Sun Protection", "Recupel", "Recyclable General Claim", "Refined in Canada", "Roasted and blended in Canada to describe coffee", "Round Table on Responsible Soy", "SCS Sustainably Grown", "SGS Organic", "SKG 1 star", "SKG 2 star", "SKG 3 star", "SKG Certificate", "SLG Child Safety", "SLG Type Tested", "SLK Bio", "SOIL Organic Cosmos", "SOSTain", "STAR K Kosher", "SUS", "Safe Feed Safe Food", "Safe Quality Food", "Salmon Safe Certification", "Schweizer Allergie Gütesiegel", "Schweizer Alpprodukt", "Schweizer Bergprodukt", "SeaChoice", "Seedling", "Shopper Army", "Society of the Plastics Industry (SPI)", "Soil Association Organic Symbol", "Star D Kosher", "Steel Recycling", "Stellar Certification Services", "Stiftung Warentest", "Stop Climate Change", "Streekproduct.be", "Suisse Garantie", "Sunshine State Kosher", "Sustainable Forestry Initiative", "Sustainable In Practice (SIP)", "Sustainable Palm Oil RSPO Certified", "Sustainable Palm Oil RSPO Credits", "Sustainable Palm Oil RSPO Mixed", "TCO Development", "TNO Approved", "TOOTHFRIENDLY", "Tarnopol Kashrus Kosher", "Terra Vitis", "The EcoLogo Certification", "The Fair Rubber Association", "The Natural and Organic Awards", "Three Line Kosher", "Traditional Specialty Guaranteed", "Transport Canada National Safety Mark (NSM)", "Triangle K Certification", "Triman", "True Foods Canada Trustmark", "True Source Certified", "U.S. Department of Agriculture (USDA) – Grade A e.g., eggs", "UNSER Land", "USDA Grade - AA", "USDA Inspection", "USDA Organic", "USDA", "UTZ Certified Cocoa", "UTZ Certified", "Underwriters laboratory", "Underwriters' Laboratory Certified, Canada \"C\" and U.S. US", "Uniquely Finnish", "United Egg Producers Certified", "V Label Vegan", "V Label Vegetarian", "V.I.V.A.", "VDE", "VDS Certificate", "VEILIG WONEN POLITIE KEURMERK", "Vaad Hakashrus of Denver Scroll K Certification", "Vaad Hoeir Kosher", "Vaelg Fuldkorn Forst", "Vegan - VegeCert", "Vegan Awareness Foundation", "Vegan By Earthkosher", "Vegan Natural Food Certifiers", "Vegan Society Vegan Logo", "Vegaplan", "Vegetarian Society - Vegetarian", "Vignerons en Développement Durable (VDD)", "WEIDEMELK", "WINERIES for Climate Protection (WfCP)", "WSDA", "WWF Panda Label", "Weight Watchers Endorsed", "Whole Grain 100 Percent Stamp", "Whole Grain Basic Stamp", "Whole Grain Council Stamp", "Whole grains 50 percent Stamp", "Zero Waste Business Council Certified" ] } } ] }, "count": { "type": "object" }, "warrantyText": { "type": "object" }, "warrantyURL": { "type": "object" }, "variantGroupId": { "type": "object" }, "variantAttributeNames": { "type": "object" }, "isPrimaryVariant": { "type": "object" }, "swatchImages": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "swatchVariantAttribute": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "color" ] }, { "type": "string", "enum": [ "assembledProductWidth" ] }, { "type": "string", "enum": [ "multipackQuantity" ] } ] }, "swatchImageUrl": { "type": "object" } } } } ] } }, "required": [ "productName", "brand", "shortDescription", "keyFeatures", "mainImageUrl", "isProp65WarningRequired", "smallPartsWarnings", "has_written_warranty", "netContent", "colorCategory", "condition" ] } }, "TradeItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "sku": { "type": "string" }, "countryOfOriginAssembly": { "type": "object" } }, "required": [ "sku", "countryOfOriginAssembly" ] } ] } }, "required": [ "Orderable", "Visible" ] }, { "type": "object", "properties": { "Promo&Discount": { "type": "object", "properties": { "sku": { "type": "string" }, "price": { "type": "number" }, "msrp": { "type": "number" } }, "required": [ "sku", "price", "msrp" ] } }, "required": [ "Promo&Discount" ] } ] } }, "feedId": { "type": "string" }, "feedType": { "type": "string", "enum": [ "price", "inventory", "MP_ITEM_MATCH", "MP_ITEM", "PRICE_AND_PROMOTION", "OMNI_WFS" ] }, "feedStatus": { "type": "string", "enum": [ "ERROR", "RECEIVED", "INPROGRESS", "PROCESSED", "Submitted" ] }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "buylist_ids": { "type": "object" } }, "required": [ "buylist_ids" ] } ] } }, "required": [ "MPItemFeedHeader", "MPItem", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "SupplierItemFeedHeader": { "type": "object", "properties": { "businessUnit": { "type": "string", "enum": [ "WALMART_US" ] }, "version": { "type": "string" }, "locale": { "type": "string", "enum": [ "en" ] } }, "required": [ "businessUnit", "version", "locale" ] }, "SupplierItem": { "type": "array", "items": { "type": "object", "properties": { "Visible": { "type": "object" }, "Orderable": { "type": "object" }, "TradeItem": { "type": "object" } }, "required": [ "Visible", "Orderable", "TradeItem" ] } }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "SupplierItemFeedHeader", "SupplierItem", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "InventoryHeader": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "1.4", "1.5" ] } }, "required": [ "version" ] }, "Inventory": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ] }, "amount": { "type": "number" } }, "required": [ "unit", "amount" ] } ] }, "inventoryAvailableDate": { "type": "object" }, "shipNodes": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "shipNode": { "type": "string" }, "quantity": { "type": "object" } }, "required": [ "shipNode", "quantity" ] } } ] } }, "required": [ "sku" ] } }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "InventoryHeader", "Inventory", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "inventoryHeader": { "type": "object" }, "inventory": { "type": "object" }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "inventoryHeader", "inventory", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "PriceHeader": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "1.7" ] } }, "required": [ "version" ] }, "Price": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "pricing": { "type": "array", "items": { "type": "object", "properties": { "currentPrice": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } }, "required": [ "currentPrice" ] } } }, "required": [ "sku", "pricing" ] } }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "PriceHeader", "Price", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] } ] } }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "A list of feeds to be processed when this one completes" }, "feed_type": { "type": "string", "enum": [ "MP_ITEM_MATCH", "MP_ITEM", "inventory", "PRICE_AND_PROMOTION", "OMNI_WFS", "price" ] }, "feed_status": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "PROCESSED", "ERROR", "Submitted" ] } }, "required": [ "feed_type", "feed_status" ] } } }, "required": [ "feeds" ] }, "SelectInboundPlansParams": { "type": "object", "properties": { "inboundPlanId": { "type": "string" }, "plan_id": { "type": [ "string", "null" ] }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "ACTIVE", "ERRORED", "SHIPPED", "VOIDED" ] } } } }, "SelectInboundPlansResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "inbound_plans": { "type": "array", "items": { "type": "object", "properties": { "inbound_plan_id": { "type": "string" }, "user_id": { "type": "string" }, "plan_id": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "name": { "type": "string" }, "ship_from_id": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "ERRORED", "SHIPPED", "VOIDED" ] }, "operation_id": { "type": [ "string", "null" ] }, "operation_status": { "type": "string", "enum": [ "FAILED", "IN_PROGRESS", "SUCCESS" ] }, "operation_problems": { "anyOf": [ {}, { "type": "null" } ] }, "set_packing_information_operation": { "anyOf": [ {}, { "type": "null" } ] }, "generate_packing_options_operation": { "anyOf": [ {}, { "type": "null" } ] }, "generate_placement_options_operation": { "anyOf": [ {}, { "type": "null" } ] }, "generate_shipment_content_update_previews_operation": { "anyOf": [ {}, { "type": "null" } ] }, "generate_delivery_window_options_operation": { "anyOf": [ {}, { "type": "null" } ] }, "generate_self_ship_appointment_slots_operation": { "anyOf": [ {}, { "type": "null" } ] }, "generate_transportation_options_operation": { "anyOf": [ {}, { "type": "null" } ] }, "confirm_transportation_options_operation": { "anyOf": [ {}, { "type": "null" } ] }, "cancel_inbound_plan_operation": { "anyOf": [ {}, { "type": "null" } ] }, "flow": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ] }, "synced": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "inbound_plan_id", "user_id", "plan_id", "created", "created_by", "updated", "updated_by", "marketplace_id", "name", "ship_from_id", "status", "operation_id", "operation_status", "operation_problems", "set_packing_information_operation", "generate_packing_options_operation", "generate_placement_options_operation", "generate_shipment_content_update_previews_operation", "generate_delivery_window_options_operation", "generate_self_ship_appointment_slots_operation", "generate_transportation_options_operation", "confirm_transportation_options_operation", "cancel_inbound_plan_operation", "flow", "synced" ] } } }, "required": [ "total_rows", "inbound_plans" ] }, "SelectIntegrationsResponse": { "type": "object", "properties": { "integrations": { "type": "array", "items": { "type": "object", "properties": { "integration_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": [ "string", "null" ] }, "logo": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" } } } } }, "required": [ "integrations" ] }, "SelectIntegrationUsersResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "users": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" } } } } }, "required": [ "users" ] }, "SelectIntegrationUsersSearchParams": { "type": "object", "properties": { "next": { "type": "string" }, "limit": { "type": "number" } } }, "SelectInventoryParams": { "type": "object", "properties": { "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "latest": { "type": "boolean", "description": "Only select inventory in the latest report" }, "limit": { "type": "number", "description": "Only select this number of records" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "Limit items to this marketplace" }, "country": { "type": "string", "enum": [ "AE", "AU", "BE", "BR", "CA", "CL", "CN", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ], "description": "Limit items to this country across channels (ie. az and wm)" }, "search": { "type": "string", "description": "Search inventory for matching values keyed by `search_by`" }, "search_by": { "type": "string", "enum": [ "sku", "gtin", "upc", "title", "external_id", "asin", "item_id", "fnsku" ], "description": "Search inventory for matching values keyed by `search_by`" }, "with_tags": { "type": "boolean", "description": "Return inventory tags" }, "with_data": { "type": "boolean", "description": "Return `data` element" }, "in_stock": { "type": "boolean", "description": "defaults to true, return only inventory with quantity" }, "next": { "type": "string", "description": "the next token for paging" } } }, "SelectInventoryResponse": { "type": "object", "properties": { "inventory": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "product": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "value" ] } }, { "type": "object" } ] }, "data": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sku": { "type": "object" }, "condition": { "type": "object" }, "wpid": { "type": "object" }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "productName": { "type": "object" }, "shelf": { "type": "object" }, "productType": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } ] }, "publishedStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PUBLISHED" ] }, { "type": "string", "enum": [ "READY_TO_PUBLISH" ] }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "UNPUBLISHED" ] }, { "type": "string", "enum": [ "STAGE" ] }, { "type": "string", "enum": [ "SYSTEM_PROBLEM." ] } ] }, "additionalAttributes": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "nameValueAttribute": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "variantResourceType": { "type": "object" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "object" }, "source": { "type": "object" }, "rank": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "isVariant": { "type": "object" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } ] } } } ] }, "unpublishedReasons": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "reason": { "oneOf": [ { "type": "object" }, { "type": "object" } ] } } } ] }, "lifecycleStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "ARCHIVED" ] }, { "type": "string", "enum": [ "RETIRED" ] } ] }, "isDuplicate": { "type": "object" }, "isCustomerFavorite": { "type": "object" }, "duplicateItemdetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "status": { "type": "object" }, "lastUpdatedDate": { "type": "object" }, "identifiedDate": { "type": "object" }, "destinationItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "type": "object" }, "wpid": { "type": "object" }, "gtin": { "type": "object" }, "upc": { "type": "object" }, "itemId": { "type": "object" }, "productName": { "type": "object" }, "productType": { "type": "object" }, "additionalAttributes": { "type": "object" } } } ] } } } ] } } } ] }, "getSearchResult": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "condition": { "type": "object" }, "isMarketPlaceItem": { "type": "object" }, "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } ] }, "customerRating": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } ] }, "description": { "type": "object" }, "title": { "type": "object" }, "brand": { "type": "object" }, "productType": { "type": "object" }, "properties": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variant_items_num": { "type": "object" }, "num_reviews": { "type": "object" }, "categories": { "type": "object" }, "variants": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variantMeta": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } ] }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "object" }, "itemId": { "type": "object" }, "isAvailable": { "type": "object" }, "title": { "type": "object" }, "variantValues": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "object" }, "value": { "type": "object" } } } } ] } } } } }, "required": [ "variantData" ] } ] }, "next_day_eligible": { "type": "object" } } } ] }, "parent": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } ] } } } ] } } }, { "type": "object" } ] }, "meltable": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "expiration_required": { "type": "object" }, "hazmat": { "type": "object" }, "size": { "type": "object" }, "category": { "type": "object" }, "dims": { "type": "object" }, "feed_data": { "type": "object" }, "gtins": { "type": "object" }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": "object" }, "icon": { "type": "object" } }, "required": [ "tag_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data", "gtins" ] }, "condition": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } } } } } }, "required": [ "sku", "items" ] } }, "next": { "type": "string" } }, "required": [ "inventory" ] }, "SelectItemLocationsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "item_locations": { "type": "array", "items": { "type": "object", "properties": { "item_location_id": { "type": "string" }, "user_id": { "type": "string" }, "location_id": { "type": "string" }, "sku": { "type": "string" }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "attachment_id": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "fulfillable": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "total": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that cannot be sold in its current state." }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "The sum of `fulfillable` and `damaged` quantity at this location." }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "location_name": { "type": "string" }, "inventory": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "product": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "value" ] } }, { "type": "object" } ] }, "data": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sku": { "type": "object" }, "condition": { "type": "object" }, "wpid": { "type": "object" }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "productName": { "type": "object" }, "shelf": { "type": "object" }, "productType": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } ] }, "publishedStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PUBLISHED" ] }, { "type": "string", "enum": [ "READY_TO_PUBLISH" ] }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "UNPUBLISHED" ] }, { "type": "string", "enum": [ "STAGE" ] }, { "type": "string", "enum": [ "SYSTEM_PROBLEM." ] } ] }, "additionalAttributes": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "nameValueAttribute": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "variantResourceType": { "type": "object" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "object" }, "source": { "type": "object" }, "rank": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "isVariant": { "type": "object" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } ] } } } ] }, "unpublishedReasons": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "reason": { "oneOf": [ { "type": "object" }, { "type": "object" } ] } } } ] }, "lifecycleStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "ARCHIVED" ] }, { "type": "string", "enum": [ "RETIRED" ] } ] }, "isDuplicate": { "type": "object" }, "isCustomerFavorite": { "type": "object" }, "duplicateItemdetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "status": { "type": "object" }, "lastUpdatedDate": { "type": "object" }, "identifiedDate": { "type": "object" }, "destinationItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "type": "object" }, "wpid": { "type": "object" }, "gtin": { "type": "object" }, "upc": { "type": "object" }, "itemId": { "type": "object" }, "productName": { "type": "object" }, "productType": { "type": "object" }, "additionalAttributes": { "type": "object" } } } ] } } } ] } } } ] }, "getSearchResult": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "condition": { "type": "object" }, "isMarketPlaceItem": { "type": "object" }, "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } ] }, "customerRating": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } ] }, "description": { "type": "object" }, "title": { "type": "object" }, "brand": { "type": "object" }, "productType": { "type": "object" }, "properties": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variant_items_num": { "type": "object" }, "num_reviews": { "type": "object" }, "categories": { "type": "object" }, "variants": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variantMeta": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } ] }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "object" }, "itemId": { "type": "object" }, "isAvailable": { "type": "object" }, "title": { "type": "object" }, "variantValues": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "object" }, "value": { "type": "object" } } } } ] } } } } }, "required": [ "variantData" ] } ] }, "next_day_eligible": { "type": "object" } } } ] }, "parent": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } ] } } } ] } } }, { "type": "object" } ] }, "meltable": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "expiration_required": { "type": "object" }, "hazmat": { "type": "object" }, "size": { "type": "object" }, "category": { "type": "object" }, "dims": { "type": "object" }, "feed_data": { "type": "object" }, "gtins": { "type": "object" }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": "object" }, "icon": { "type": "object" } }, "required": [ "tag_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data", "gtins" ] }, "condition": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } } } } } } } } }, "required": [ "item_locations" ] }, "SelectItemLocationsSearchParams": { "type": "object", "properties": { "next": { "type": "string" }, "expires_after": { "type": [ "string", "null" ], "format": "date-time" }, "expires_before": { "type": [ "string", "null" ], "format": "date-time" }, "item_location_ids": { "type": "array", "items": { "type": "string" } }, "limit": { "type": "number" }, "lot_codes": { "type": "array", "items": { "type": [ "string", "null" ] } }, "ship_from_id": { "type": "string" }, "skus": { "type": "array", "items": { "type": "string" } }, "with_damaged": { "type": "boolean" }, "with_fulfillable": { "type": "boolean" }, "with_location_name": { "type": "boolean" }, "with_inventory": { "type": "boolean" }, "with_tags": { "type": "boolean" } } }, "SelectItemsAcrossLocationsSearchParams": { "type": "object", "properties": { "next": { "type": "string" }, "expires_after": { "type": [ "string", "null" ], "format": "date-time" }, "expires_before": { "type": [ "string", "null" ], "format": "date-time" }, "item_location_ids": { "type": "array", "items": { "type": "string" } }, "limit": { "type": "number" }, "location_id": { "type": "string" }, "lot_codes": { "type": "array", "items": { "type": [ "string", "null" ] } }, "ship_from_id": { "type": "string" }, "skus": { "type": "array", "items": { "type": "string" } }, "with_damaged": { "type": "boolean" }, "with_fulfillable": { "type": "boolean" }, "with_location_name": { "type": "boolean" }, "with_inventory": { "type": "boolean" }, "with_tags": { "type": "boolean" } } }, "SelectLedgerParams": { "type": "object", "properties": { "input_sku": { "type": "string", "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU." }, "output_sku": { "type": "string", "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU." }, "purchase_order_item_id": { "type": [ "string", "null" ] }, "location_id": { "type": [ "number", "null" ] }, "plan_item_id": { "type": [ "number", "null" ] }, "az_shipment_id": { "type": [ "string", "null" ] }, "wm_shipment_id": { "type": [ "string", "null" ] }, "before": { "type": [ "string", "null" ], "format": "date-time" }, "after": { "type": [ "string", "null" ], "format": "date-time" }, "next": { "type": "string" }, "sort": { "type": "string", "enum": [ "asc", "desc" ] }, "limit": { "type": "number" }, "ledger_entry_types": { "type": "array", "items": { "type": "string", "enum": [ "ALLOCATION", "ALLOCATION_RELEASED", "BUNDLE_BUILD", "BUNDLE_UNBUILD", "CYCLE_COUNT_ADJUST", "DAMAGE_WRITE_OFF", "INVENTORY_IMPORT", "LOCATION_TRANSFER", "PO_CANCELLED", "PO_CREATED", "PO_RECEIPT_ADJUSTED", "PO_RECEIVED", "RETURN_TO_STOCK", "SHIPMENT_CANCELLED", "SHIPMENT_CONFIRMED", "SHIPMENT_PACKED", "TRANSFER_DAMAGED" ], "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `output_sku` represents the SKU that Amazon or Walmart will see. When bundling, this represents the \"bundled\" SKU." } }, "with_user_name": { "type": "boolean", "description": "Returns the user's name" }, "with_location_name": { "type": "boolean", "description": "Returns the location's name" }, "with_purchase_order_name": { "type": "boolean", "description": "Returns the purchase order's name" } } }, "SelectLedgerResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "ledger": { "type": "array", "items": { "type": "object", "properties": { "inventory_ledger_id": { "type": "string" }, "user_id": { "type": "string" }, "input_sku": { "type": "string", "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU." }, "output_sku": { "type": "string", "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU." }, "ledger_entry_type": { "type": "string", "enum": [ "ALLOCATION", "ALLOCATION_RELEASED", "BUNDLE_BUILD", "BUNDLE_UNBUILD", "CYCLE_COUNT_ADJUST", "DAMAGE_WRITE_OFF", "INVENTORY_IMPORT", "LOCATION_TRANSFER", "PO_CANCELLED", "PO_CREATED", "PO_RECEIPT_ADJUSTED", "PO_RECEIVED", "RETURN_TO_STOCK", "SHIPMENT_CANCELLED", "SHIPMENT_CONFIRMED", "SHIPMENT_PACKED", "TRANSFER_DAMAGED" ], "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `output_sku` represents the SKU that Amazon or Walmart will see. When bundling, this represents the \"bundled\" SKU." }, "quantity": { "type": "number", "description": "The quantity in (postive) or out (negative)" }, "running_quantity": { "type": "number", "description": "The quantity in (postive) or out (negative)" }, "purchase_order_item_id": { "type": [ "string", "null" ] }, "location_id": { "type": [ "number", "null" ] }, "plan_item_id": { "type": [ "number", "null" ] }, "az_shipment_id": { "type": [ "string", "null" ] }, "wm_shipment_id": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": "string" }, "created_by_name": { "type": "string" }, "location_name": { "type": "string" }, "po_name": { "type": "string" } } } }, "next": { "type": "string" } }, "required": [ "total_rows", "ledger" ] }, "SelectLedgerSearchParams": { "type": "object", "properties": { "input_sku": { "type": "string", "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU." }, "output_sku": { "type": "string", "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU." }, "purchase_order_item_id": { "type": [ "string", "null" ] }, "location_id": { "type": [ "number", "null" ] }, "plan_item_id": { "type": [ "number", "null" ] }, "az_shipment_id": { "type": [ "string", "null" ] }, "wm_shipment_id": { "type": [ "string", "null" ] }, "before": { "type": [ "string", "null" ], "format": "date-time" }, "after": { "type": [ "string", "null" ], "format": "date-time" }, "next": { "type": "string" }, "sort": { "type": "string", "enum": [ "asc", "desc" ] }, "limit": { "type": "number" }, "with_user_name": { "type": "boolean", "description": "Returns the user's name" }, "with_location_name": { "type": "boolean", "description": "Returns the location's name" }, "with_purchase_order_name": { "type": "boolean", "description": "Returns the purchase order's name" }, "ledger_entry_types": { "type": "string", "enum": [ "ALLOCATION", "ALLOCATION_RELEASED", "BUNDLE_BUILD", "BUNDLE_UNBUILD", "CYCLE_COUNT_ADJUST", "DAMAGE_WRITE_OFF", "INVENTORY_IMPORT", "LOCATION_TRANSFER", "PO_CANCELLED", "PO_CREATED", "PO_RECEIPT_ADJUSTED", "PO_RECEIVED", "RETURN_TO_STOCK", "SHIPMENT_CANCELLED", "SHIPMENT_CONFIRMED", "SHIPMENT_PACKED", "TRANSFER_DAMAGED" ], "description": "comma separated list of ledger entry types" } } }, "SelectLocationPathParams": { "type": "object", "properties": { "location_id": { "type": "string" } }, "required": [ "location_id" ] }, "SelectLocationResponse": { "type": "object", "properties": { "location": { "type": "object", "properties": { "location_id": { "type": "string" }, "location_name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "location_type": { "type": "string", "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ] }, "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "summary": { "type": "object", "properties": { "fulfillable": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": "number", "description": "The quantity of the item at this location that can be sold." } }, "required": [ "fulfillable", "damaged" ] } } } } }, "SelectLocationsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "location_id": { "type": "string" }, "location_name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "location_type": { "type": "string", "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ] }, "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "summary": { "type": "object", "properties": { "fulfillable": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": "number", "description": "The quantity of the item at this location that can be sold." } }, "required": [ "fulfillable", "damaged" ] } } } } }, "required": [ "total_rows", "locations" ] }, "SelectLocationsSearchParams": { "type": "object", "properties": { "next": { "type": "string" }, "location_name": { "type": "string" }, "ship_from_id": { "type": "string" }, "with_summary": { "type": "boolean" }, "limit": { "type": "number" }, "location_ids": { "type": "string", "description": "comma separated list of `location_id`s" } } }, "SelectMappingsParams": { "type": "object", "properties": { "mapping_type": { "type": "string", "enum": [ "inventory", "product" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)" }, "bundle_id": { "type": [ "string", "null" ], "description": "Set if the input_value refers to a SKU from a bundle" } } }, "SelectMappingsResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "mappings": { "type": "array", "items": { "type": "object", "properties": { "mapping_id": { "type": "string" }, "mapping_type": { "type": "string", "enum": [ "inventory", "product" ] }, "bundle_id": { "type": [ "string", "null" ], "description": "Set if the input_value refers to a SKU from a bundle" }, "input_value": { "type": "string", "description": "Set if the input_value refers to a SKU from a bundle" }, "output_value": { "type": "string", "description": "When mapping_type = inventory, this is the internal sku, otherwise it is an arbitrary string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)" } } } } }, "required": [ "total_rows", "mappings" ] }, "SelectOrListParams": { "type": "object", "properties": { "force": { "type": "boolean", "description": "pass `true` to force loading data from SP-API" } } }, "SelectPackingOptionsParams": { "type": "object", "properties": { "inboundPlanId": { "type": "string" }, "packingOptionId": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] } }, "expired": { "type": "boolean" } }, "required": [ "inboundPlanId" ] }, "SelectPackingOptionsResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "packing_options": { "type": "array", "items": { "type": "object", "properties": { "inbound_plan_id": { "type": "string" }, "packing_option_id": { "type": "string" }, "user_id": { "type": "string" }, "discounts": { "anyOf": [ {}, { "type": "null" } ] }, "expiration": { "type": [ "string", "null" ], "format": "date-time" }, "fees": { "anyOf": [ {}, { "type": "null" } ] }, "packing_groups": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "packingGroupId": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] } } }, "required": [ "packingGroupId" ] } }, "status": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] }, "supported_shipping_configurations": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "confirm_packing_option_operation": { "anyOf": [ {}, { "type": "null" } ] }, "plan_id": { "type": [ "string", "null" ] }, "ship_from_id": { "type": [ "string", "null" ] } }, "required": [ "inbound_plan_id", "packing_option_id", "user_id", "discounts", "expiration", "fees", "packing_groups", "status", "supported_shipping_configurations", "created", "created_by", "updated", "updated_by", "confirm_packing_option_operation", "plan_id", "ship_from_id" ] } } }, "required": [ "total_rows", "packing_options" ] }, "SelectPackingOptionsSearchParams": { "type": "object", "properties": { "inboundPlanId": { "type": "string" }, "packingOptionId": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] } }, "expired": { "type": "boolean" }, "force": { "type": "boolean", "description": "pass `true` to force loading data from SP-API" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "SelectPackTemplateItemsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "pack_template_items": { "type": "array", "items": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "sku": { "type": "string" }, "quantity": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } } } } }, "required": [ "pack_template_items" ] }, "SelectPackTemplateResponse": { "type": "object", "properties": { "pack_template": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "owner": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": [ "number", "null" ] }, "unit_of_weight": { "type": [ "string", "null" ], "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "type": "number" } } } } } } }, "required": [ "pack_template" ] }, "SelectPackTemplatesParams": { "type": "object", "properties": { "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "next": { "type": "string" }, "pack_template_ids": { "type": "array", "items": { "type": "string" } }, "limit": { "type": "number" }, "with_items": { "type": "boolean" }, "skus": { "type": "array", "items": { "type": "string" }, "description": "pack templates by the skus they contain" } } }, "SelectPackTemplatesResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "pack_templates": { "type": "array", "items": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "owner": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": [ "number", "null" ] }, "unit_of_weight": { "type": [ "string", "null" ], "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "type": "number" } } } } } } } }, "required": [ "pack_templates" ] }, "SelectPlacementOptionsParams": { "type": "object", "properties": { "inboundPlanId": { "type": "string" }, "placementOptionId": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] } }, "expired": { "type": "boolean" } }, "required": [ "inboundPlanId" ] }, "SelectPlacementOptionsResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "placement_options": { "type": "array", "items": { "type": "object", "properties": { "placement_option_id": { "type": "string" }, "user_id": { "type": "string" }, "inbound_plan_id": { "type": "string" }, "discounts": { "anyOf": [ {}, { "type": "null" } ] }, "expiration": { "type": [ "string", "null" ], "format": "date-time" }, "fees": { "anyOf": [ {}, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] }, "shipment_ids": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "confirm_placement_option_operation": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "placement_option_id", "user_id", "inbound_plan_id", "discounts", "expiration", "fees", "status", "shipment_ids", "created", "created_by", "updated", "updated_by", "confirm_placement_option_operation" ] } } }, "required": [ "total_rows", "placement_options" ] }, "SelectPlacementOptionsSearchParams": { "type": "object", "properties": { "inboundPlanId": { "type": "string" }, "placementOptionId": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] } }, "expired": { "type": "boolean" }, "force": { "type": "boolean", "description": "pass `true` to force loading data from SP-API" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "SelectPlanAuditLogParams": { "type": "object", "properties": { "plan_id": { "type": "number" }, "created_by": { "type": "string" }, "before": { "type": [ "string", "null" ], "format": "date-time" }, "after": { "type": [ "string", "null" ], "format": "date-time" }, "next": { "type": "string" }, "sort": { "type": "string", "enum": [ "asc", "desc" ] }, "limit": { "type": "number" }, "with_user_name": { "type": "boolean", "description": "Returns the user's name" }, "with_plan_name": { "type": "boolean", "description": "Returns the plan's name" } } }, "SelectPlanAuditLogResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "plan_audit_log": { "type": "array", "items": { "type": "object", "properties": { "plan_audit_log_id": { "type": "string" }, "plan_id": { "type": "number" }, "event_type": { "type": "string", "enum": [ "change_plan_status", "print_box_label", "print_item_label" ] }, "status": { "type": [ "string", "null" ], "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ] }, "sku": { "type": [ "string", "null" ] }, "box_id": { "type": [ "number", "null" ] }, "quantity": { "type": [ "number", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": "string" }, "created_by_name": { "type": "string" }, "plan_name": { "type": "string" } } } }, "next": { "type": "string" } }, "required": [ "total_rows", "plan_audit_log" ] }, "SelectPlanItemPathParams": { "type": "object", "properties": { "plan_id": { "type": "string" }, "plan_item_id": { "type": "string" } } }, "SelectPlanItemResponse": { "type": "object", "properties": { "plan_item": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "inventory": { "type": "object", "properties": { "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "product": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "value" ] } }, { "type": "object" } ] }, "data": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sku": { "type": "object" }, "condition": { "type": "object" }, "wpid": { "type": "object" }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "productName": { "type": "object" }, "shelf": { "type": "object" }, "productType": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } ] }, "publishedStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PUBLISHED" ] }, { "type": "string", "enum": [ "READY_TO_PUBLISH" ] }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "UNPUBLISHED" ] }, { "type": "string", "enum": [ "STAGE" ] }, { "type": "string", "enum": [ "SYSTEM_PROBLEM." ] } ] }, "additionalAttributes": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "nameValueAttribute": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "variantResourceType": { "type": "object" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "object" }, "source": { "type": "object" }, "rank": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "isVariant": { "type": "object" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } ] } } } ] }, "unpublishedReasons": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "reason": { "oneOf": [ { "type": "object" }, { "type": "object" } ] } } } ] }, "lifecycleStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "ARCHIVED" ] }, { "type": "string", "enum": [ "RETIRED" ] } ] }, "isDuplicate": { "type": "object" }, "isCustomerFavorite": { "type": "object" }, "duplicateItemdetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "status": { "type": "object" }, "lastUpdatedDate": { "type": "object" }, "identifiedDate": { "type": "object" }, "destinationItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "type": "object" }, "wpid": { "type": "object" }, "gtin": { "type": "object" }, "upc": { "type": "object" }, "itemId": { "type": "object" }, "productName": { "type": "object" }, "productType": { "type": "object" }, "additionalAttributes": { "type": "object" } } } ] } } } ] } } } ] }, "getSearchResult": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "condition": { "type": "object" }, "isMarketPlaceItem": { "type": "object" }, "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } ] }, "customerRating": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } ] }, "description": { "type": "object" }, "title": { "type": "object" }, "brand": { "type": "object" }, "productType": { "type": "object" }, "properties": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variant_items_num": { "type": "object" }, "num_reviews": { "type": "object" }, "categories": { "type": "object" }, "variants": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variantMeta": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } ] }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "object" }, "itemId": { "type": "object" }, "isAvailable": { "type": "object" }, "title": { "type": "object" }, "variantValues": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "object" }, "value": { "type": "object" } } } } ] } } } } }, "required": [ "variantData" ] } ] }, "next_day_eligible": { "type": "object" } } } ] }, "parent": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } ] } } } ] } } }, { "type": "object" } ] }, "meltable": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "expiration_required": { "type": "object" }, "hazmat": { "type": "object" }, "size": { "type": "object" }, "category": { "type": "object" }, "dims": { "type": "object" }, "feed_data": { "type": "object" }, "gtins": { "type": "object" }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": "object" }, "icon": { "type": "object" } }, "required": [ "tag_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data", "gtins" ] }, "condition": { "type": "string" } }, "required": [ "product", "condition" ] }, "prep_matrices": { "type": "array", "items": { "type": "object" } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "bundle_item_id": { "type": "string" }, "bundle_id": { "type": "string" }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } } } } } } } } } }, "required": [ "inventory" ] } } }, "SelectPlanItemsFunctionResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "plan_items": { "type": "array", "items": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "inventory": { "type": "object", "properties": { "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "product": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "value" ] } }, { "type": "object" } ] }, "data": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sku": { "type": "object" }, "condition": { "type": "object" }, "wpid": { "type": "object" }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "productName": { "type": "object" }, "shelf": { "type": "object" }, "productType": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } ] }, "publishedStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PUBLISHED" ] }, { "type": "string", "enum": [ "READY_TO_PUBLISH" ] }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "UNPUBLISHED" ] }, { "type": "string", "enum": [ "STAGE" ] }, { "type": "string", "enum": [ "SYSTEM_PROBLEM." ] } ] }, "additionalAttributes": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "nameValueAttribute": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "variantResourceType": { "type": "object" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "object" }, "source": { "type": "object" }, "rank": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "isVariant": { "type": "object" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } ] } } } ] }, "unpublishedReasons": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "reason": { "oneOf": [ { "type": "object" }, { "type": "object" } ] } } } ] }, "lifecycleStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "ARCHIVED" ] }, { "type": "string", "enum": [ "RETIRED" ] } ] }, "isDuplicate": { "type": "object" }, "isCustomerFavorite": { "type": "object" }, "duplicateItemdetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "status": { "type": "object" }, "lastUpdatedDate": { "type": "object" }, "identifiedDate": { "type": "object" }, "destinationItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "type": "object" }, "wpid": { "type": "object" }, "gtin": { "type": "object" }, "upc": { "type": "object" }, "itemId": { "type": "object" }, "productName": { "type": "object" }, "productType": { "type": "object" }, "additionalAttributes": { "type": "object" } } } ] } } } ] } } } ] }, "getSearchResult": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "condition": { "type": "object" }, "isMarketPlaceItem": { "type": "object" }, "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } ] }, "customerRating": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } ] }, "description": { "type": "object" }, "title": { "type": "object" }, "brand": { "type": "object" }, "productType": { "type": "object" }, "properties": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variant_items_num": { "type": "object" }, "num_reviews": { "type": "object" }, "categories": { "type": "object" }, "variants": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variantMeta": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } ] }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "object" }, "itemId": { "type": "object" }, "isAvailable": { "type": "object" }, "title": { "type": "object" }, "variantValues": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "object" }, "value": { "type": "object" } } } } ] } } } } }, "required": [ "variantData" ] } ] }, "next_day_eligible": { "type": "object" } } } ] }, "parent": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } ] } } } ] } } }, { "type": "object" } ] }, "meltable": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "expiration_required": { "type": "object" }, "hazmat": { "type": "object" }, "size": { "type": "object" }, "category": { "type": "object" }, "dims": { "type": "object" }, "feed_data": { "type": "object" }, "gtins": { "type": "object" }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": "object" }, "icon": { "type": "object" } }, "required": [ "tag_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data", "gtins" ] }, "condition": { "type": "string" } }, "required": [ "product", "condition" ] }, "prep_matrices": { "type": "array", "items": { "type": "object" } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "bundle_item_id": { "type": "string" }, "bundle_id": { "type": "string" }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } } } } } } } } } }, "required": [ "inventory" ] } } }, "required": [ "total_rows", "plan_items" ] }, "SelectPlanItemsPathParams": { "type": "object", "properties": { "plan_id": { "type": "string" } } }, "SelectPlanItemsResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "plan_items": { "type": "array", "items": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "inventory": { "type": "object", "properties": { "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "product": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "title": { "type": [ "string", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "weight": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "oneOf": [ { "type": "object" }, { "type": "string" } ] } }, "required": [ "value" ] } }, { "type": "object" } ] }, "data": { "oneOf": [ { "type": "object", "properties": { "getAnItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sku": { "type": "object" }, "condition": { "type": "object" }, "wpid": { "type": "object" }, "upc": { "type": "object" }, "gtin": { "type": "object" }, "productName": { "type": "object" }, "shelf": { "type": "object" }, "productType": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } ] }, "publishedStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "PUBLISHED" ] }, { "type": "string", "enum": [ "READY_TO_PUBLISH" ] }, { "type": "string", "enum": [ "IN_PROGRESS" ] }, { "type": "string", "enum": [ "UNPUBLISHED" ] }, { "type": "string", "enum": [ "STAGE" ] }, { "type": "string", "enum": [ "SYSTEM_PROBLEM." ] } ] }, "additionalAttributes": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "nameValueAttribute": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "variantResourceType": { "type": "object" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "object" }, "source": { "type": "object" }, "rank": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "isVariant": { "type": "object" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } ] } } } ] }, "unpublishedReasons": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "reason": { "oneOf": [ { "type": "object" }, { "type": "object" } ] } } } ] }, "lifecycleStatus": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "ARCHIVED" ] }, { "type": "string", "enum": [ "RETIRED" ] } ] }, "isDuplicate": { "type": "object" }, "isCustomerFavorite": { "type": "object" }, "duplicateItemdetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "status": { "type": "object" }, "lastUpdatedDate": { "type": "object" }, "identifiedDate": { "type": "object" }, "destinationItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "mart": { "type": "object" }, "wpid": { "type": "object" }, "gtin": { "type": "object" }, "upc": { "type": "object" }, "itemId": { "type": "object" }, "productName": { "type": "object" }, "productType": { "type": "object" }, "additionalAttributes": { "type": "object" } } } ] } } } ] } } } ] }, "getSearchResult": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "condition": { "type": "object" }, "isMarketPlaceItem": { "type": "object" }, "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } ] }, "customerRating": { "type": "object" }, "price": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } ] }, "description": { "type": "object" }, "title": { "type": "object" }, "brand": { "type": "object" }, "productType": { "type": "object" }, "properties": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variant_items_num": { "type": "object" }, "num_reviews": { "type": "object" }, "categories": { "type": "object" }, "variants": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "variantMeta": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } ] }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "object" }, "itemId": { "type": "object" }, "isAvailable": { "type": "object" }, "title": { "type": "object" }, "variantValues": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "object" }, "value": { "type": "object" } } } } ] } } } } }, "required": [ "variantData" ] } ] }, "next_day_eligible": { "type": "object" } } } ] }, "parent": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } ] } } } ] } } }, { "type": "object" } ] }, "meltable": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "expiration_required": { "type": "object" }, "hazmat": { "type": "object" }, "size": { "type": "object" }, "category": { "type": "object" }, "dims": { "type": "object" }, "feed_data": { "type": "object" }, "gtins": { "type": "object" }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": "object" }, "icon": { "type": "object" } }, "required": [ "tag_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } ] } }, "required": [ "external_id", "marketplace_id", "title", "images", "created", "updated", "weight", "data", "meltable", "expiration_required", "hazmat", "size", "category", "dims", "feed_data", "gtins" ] }, "condition": { "type": "string" } }, "required": [ "product", "condition" ] }, "prep_matrices": { "type": "array", "items": { "type": "object" } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "bundle_item_id": { "type": "string" }, "bundle_id": { "type": "string" }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } } } } } } } } } }, "required": [ "inventory" ] } } }, "required": [ "total_rows", "plan_items" ] }, "SelectPlanItemsSearchParams": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "with_tags": { "type": "boolean", "description": "true to include tags for each plan item" }, "with_prep_matrices": { "type": "boolean", "description": "true to return `prep_matrices` for each plan item" }, "with_bundles": { "type": "boolean", "description": "true to return `bundles` whose output matches this item's sku/marketplace" } } }, "SelectPlanPathParams": { "type": "object", "properties": { "plan_id": { "type": "string" } }, "required": [ "plan_id" ] }, "SelectPlanResponse": { "type": "object", "properties": { "plan": { "type": "object", "properties": { "plan_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": "string" }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "errors": { "anyOf": [ { "description": "The method by which the plan was created" }, { "type": "null" } ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id" }, "flow": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ], "description": "For Walmart plans, this is the inbound_order_id" }, "location_id": { "type": [ "string", "null" ] }, "pick_list": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string" }, "location_name": { "type": "string" }, "quantity": { "type": "number" }, "location_id": { "type": "string", "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] } }, "content_information_source": { "type": [ "string", "null" ], "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "description": "When PO items are imported into a plan, this is a list of what locations in the warehouse contain the imported items." }, "status": { "type": "string", "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ] }, "prep_matrix_type": { "type": [ "string", "null" ] }, "prep_matrix_price": { "type": [ "number", "null" ] }, "prep_matrix_currency_code": { "type": [ "string", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "type": [ "object", "null" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "customPlacement": { "type": "array", "items": { "type": "object", "properties": { "warehouseId": { "type": "string" }, "mskus": { "type": "array", "items": { "type": "string" } } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": "string", "description": "Expected delivery date for shipment" } }, "description": "Data used to generate WM Inbound Preview or AZ Inbound Plan" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "wm_shipment_ids": { "type": "array", "items": { "type": "string" }, "description": "A list of shipment ids in the Walmart marketplace created from this plan" }, "az_shipment_ids": { "type": "array", "items": { "type": "string" }, "description": "A list of shipment ids in the Amazon marketplace created from this plan" }, "placement_options": { "type": "array", "items": { "type": "object" }, "description": "present when `with_placement_options` option was passed; az shipments on this plan, grouped by placement option" }, "skus": { "type": "number", "description": "The total number of unique SKUs in the plan" }, "units": { "type": "number", "description": "The total quantity of all items in the plan" }, "inbound_previews": { "type": "array", "items": { "type": "object", "properties": { "previewType": { "type": "string", "enum": [ "inbound", "selfMirroring" ] }, "preview": { "type": "array", "items": { "type": "object", "properties": { "shipNode": { "type": "string" }, "isSortable": { "type": "boolean" }, "isNonSortable": { "type": "boolean" }, "nodeType": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "totalNetTransferCharge": { "type": "number" }, "currencyUnit": { "type": "string" }, "shipmentItems": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] } }, "shippingSummary": { "type": "object", "properties": { "boxes": { "type": "array", "items": {} } }, "required": [ "boxes" ] } }, "required": [ "shipNode", "isSortable", "isNonSortable", "nodeType", "shipToAddress", "totalNetTransferCharge", "currencyUnit", "shipmentItems", "shippingSummary" ] } } }, "required": [ "previewType", "preview" ] }, "description": "A list of inbound previews for the plan" }, "items": { "type": "array", "items": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "gtin": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "prep_details": { "type": "object", "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] } }, "required": [ "gtin", "title" ] }, "description": "present if `with_items` option was passed" }, "ship_from": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "place_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ], "description": "present if `with_ship_from` option was passed" } }, "required": [ "skus", "units" ] } }, "required": [ "plan" ] }, "SelectPlansParams": { "type": "object", "properties": { "next": { "type": "string" }, "archived": { "type": [ "boolean", "null" ], "description": "pass `&archived` to only search archived plans" }, "plan_id": { "type": "string", "description": "Select a specific plan by id" }, "plan_name": { "type": "string", "description": "Search by plan name prefix" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "Limit to specific creation source" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ] }, "description": "Limit to plans in any of the given statuses" }, "with_shipments": { "type": "boolean", "description": "pass `true` to only return plans that already have shipments, `false` excludes plans that already have shipments, omit to include all plans with or without shipments" }, "with_shipment_ids": { "type": "boolean", "description": "pass `true` to include `wm_shipment_ids`/`az_shipment_ids` for each plan" }, "with_placement_options": { "type": "boolean", "description": "pass `true` to include `az_shipments` with placement option fees and destination for each az shipment" }, "limit": { "type": "number", "description": "Limit the number of results" }, "ship_from_id": { "type": "string", "description": "Limit to a specific ship_from_id" }, "with_items": { "type": "boolean", "description": "when selecting a single plan by `plan_id`, pass `true` to include plan items in the response" }, "with_ship_from": { "type": "boolean", "description": "return a ship_from object" }, "with_tags": { "type": "boolean", "description": "pass `true` to include `tags` for each plan" } } }, "SelectPlansResponse": { "type": "object", "properties": { "next": { "type": "string" }, "plans": { "type": "array", "items": { "type": "object", "properties": { "plan_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": "string" }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "errors": { "anyOf": [ { "description": "The method by which the plan was created" }, { "type": "null" } ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id" }, "flow": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ], "description": "For Walmart plans, this is the inbound_order_id" }, "location_id": { "type": [ "string", "null" ] }, "pick_list": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string" }, "location_name": { "type": "string" }, "quantity": { "type": "number" }, "location_id": { "type": "string", "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] } }, "content_information_source": { "type": [ "string", "null" ], "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "description": "When PO items are imported into a plan, this is a list of what locations in the warehouse contain the imported items." }, "status": { "type": "string", "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ] }, "prep_matrix_type": { "type": [ "string", "null" ] }, "prep_matrix_price": { "type": [ "number", "null" ] }, "prep_matrix_currency_code": { "type": [ "string", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "type": [ "object", "null" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "customPlacement": { "type": "array", "items": { "type": "object", "properties": { "warehouseId": { "type": "string" }, "mskus": { "type": "array", "items": { "type": "string" } } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": "string", "description": "Expected delivery date for shipment" } }, "description": "Data used to generate WM Inbound Preview or AZ Inbound Plan" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "wm_shipment_ids": { "type": "array", "items": { "type": "string" }, "description": "A list of shipment ids in the Walmart marketplace created from this plan" }, "az_shipment_ids": { "type": "array", "items": { "type": "string" }, "description": "A list of shipment ids in the Amazon marketplace created from this plan" }, "placement_options": { "type": "array", "items": { "type": "object" }, "description": "present when `with_placement_options` option was passed; az shipments on this plan, grouped by placement option" }, "skus": { "type": "number", "description": "The total number of unique SKUs in the plan" }, "units": { "type": "number", "description": "The total quantity of all items in the plan" }, "inbound_previews": { "type": "array", "items": { "type": "object", "properties": { "previewType": { "type": "string", "enum": [ "inbound", "selfMirroring" ] }, "preview": { "type": "array", "items": { "type": "object", "properties": { "shipNode": { "type": "string" }, "isSortable": { "type": "boolean" }, "isNonSortable": { "type": "boolean" }, "nodeType": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "totalNetTransferCharge": { "type": "number" }, "currencyUnit": { "type": "string" }, "shipmentItems": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] } }, "shippingSummary": { "type": "object", "properties": { "boxes": { "type": "array", "items": {} } }, "required": [ "boxes" ] } }, "required": [ "shipNode", "isSortable", "isNonSortable", "nodeType", "shipToAddress", "totalNetTransferCharge", "currencyUnit", "shipmentItems", "shippingSummary" ] } } }, "required": [ "previewType", "preview" ] }, "description": "A list of inbound previews for the plan" }, "items": { "type": "array", "items": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "errors": { "anyOf": [ {}, { "type": "null" } ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "string", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "type": "object", "description": "TODO see what populates these values and make them more consistent" }, "labelOwner": { "type": "object" }, "prepOwner": { "type": "object" }, "prepInstructions": { "type": "array", "items": { "type": "object" } }, "label_type": { "type": "string" }, "prep_category": { "type": "string" } }, "description": "Includes `addOnServices` in Walmart; `labelOwner`, `prepOwner`, and `prepInstructions` in Amazon" }, "gtin": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "prep_details": { "type": "object", "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] } }, "required": [ "gtin", "title" ] }, "description": "present if `with_items` option was passed" }, "ship_from": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "place_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ], "description": "present if `with_ship_from` option was passed" } }, "required": [ "skus", "units" ] } }, "total_rows": { "type": "number" } }, "required": [ "plans" ] }, "SelectProxyeesResponse": { "type": "object", "properties": { "next": { "type": "string" }, "proxyees": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" } } } }, "total_rows": { "type": "number" } }, "required": [ "proxyees" ] }, "SelectPurchaseOrder": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "purchase_order_name": { "type": "string" }, "user_id": { "type": "string" }, "ship_from_id": { "type": "string", "description": "The ID of the supplier." }, "created": { "type": "string", "format": "date-time", "description": "The ID of the supplier." }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_status": { "type": "string", "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view" }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time", "description": "A transitional column marking this PO created in the WFS plan view" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "summary": { "type": [ "object", "null" ], "properties": { "skus": { "type": [ "number", "null" ] }, "ordered": { "type": [ "number", "null" ] }, "received": { "type": [ "number", "null" ] }, "damaged": { "type": [ "number", "null" ] }, "missing": { "type": [ "number", "null" ] }, "not_ordered": { "type": [ "number", "null" ] } }, "required": [ "skus", "ordered", "received", "damaged", "missing", "not_ordered" ] } } }, "SelectPurchaseOrderItem": { "type": "object", "properties": { "purchase_order_item_id": { "type": "string" }, "user_id": { "type": "string" }, "purchase_order_id": { "type": "string" }, "gtin": { "type": "string" }, "condition_id": { "type": "number", "description": "The GTIN of the item" }, "sku": { "type": "string" }, "notes": { "type": [ "string", "null" ] }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item." }, "missing": { "type": "number", "description": "Any damaged quantity" }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities" }, "intent": { "type": [ "object", "null" ], "properties": { "marketplace": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": "array", "items": { "type": "object" } } }, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "shopper": { "type": [ "string", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "purchased": { "type": "string", "format": "date-time" }, "price": { "type": [ "number", "null" ] }, "cost": { "type": [ "number", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "product_tax_code": { "type": [ "string", "null" ], "enum": [ "A_AUTOMOTIVE_MOTOROIL", "A_BABY_BRSTPUMP", "A_BABY_CARSEAT", "A_BABY_CLOTH", "A_BABY_DIAPER", "A_BOOKS_GEN", "A_BOOKS_RELIG", "A_BOOKS_RENTAL", "A_BUNDLE_PERDCL", "A_CLSFD_52W-4Q", "A_CLSFD_52WKLY", "A_CLSFD_ANNUAL", "A_CLSFD_SEMIANNL", "A_CLTH_ATHL", "A_CLTH_BATH", "A_CLTH_BOOKBAG", "A_CLTH_BUCKLS", "A_CLTH_COMPON", "A_CLTH_CSTUMS", "A_CLTH_FORMAL", "A_CLTH_FUR", "A_CLTH_GEN", "A_CLTH_HAIRACCESSORIES", "A_CLTH_HANDKE", "A_CLTH_HBAGS", "A_CLTH_IFUR", "A_CLTH_PROTECTIVE", "A_CLTH_UMBRELLA", "A_COLLECTIBLE_COIN", "A_COMP_COMPUTER", "A_COMP_EDUSOFT", "A_COMP_GAMPER", "A_COMP_PDA", "A_COMP_PERIPH", "A_COMP_PRINT", "A_COMP_PRTSUP", "A_COMP_SCANNER", "A_COMP_SOFTOP", "A_COMP_SOFTRC", "A_COMP_STORAGEMEDIA", "A_EGOODS_DIGITALAUDIOBOOKS", "A_EGOODS_DIGITALBOOKS", "A_EGOODS_DIGITALBOOK_RENTAL", "A_EGOODS_DIGITALGAMES", "A_EGOODS_DIGITALMUSIC", "A_EGOODS_DIGITALNEWS", "A_EGOODS_DIGITALNEWSSUBS", "A_EGOODS_DIGITALPERDCL", "A_EGOODS_DIGITALPERDCLSUBS", "A_EGOODS_MISC1", "A_EGOODS_ONLINEGAMINGSUBS", "A_EGOODS_SOFT", "A_EMERGENCY_SUPPLIES", "A_FOOD_BKTCDY50-90", "A_FOOD_BKTGN50-75", "A_FOOD_BKTGN76-90", "A_FOOD_CARBSFTDK", "A_FOOD_CARBWTR", "A_FOOD_CNDY", "A_FOOD_CNDYFL", "A_FOOD_GEN", "A_FOOD_JUICE0-50", "A_FOOD_JUICE51-99", "A_FOOD_NCARBWTR", "A_FOOD_PETFOOD", "A_FOOD_WINE", "A_GEN_NOTAX", "A_GEN_RENTAL", "A_GEN_TAX", "A_HLTH_BABYSUPPLS", "A_HLTH_BANDKIT", "A_HLTH_CONTACTSOLN", "A_HLTH_CONTRCEPV", "A_HLTH_COSMETIC", "A_HLTH_DIABSUPPLS", "A_HLTH_DIETSUPMT", "A_HLTH_DISPOSABLE_PACK", "A_HLTH_FAMPLANTEST", "A_HLTH_FEMHYG", "A_HLTH_HEARINGAID_BATT", "A_HLTH_INCONT", "A_HLTH_MEDHAIRLOSS", "A_HLTH_MOBILITY", "A_HLTH_MONITOR", "A_HLTH_OTCMED", "A_HLTH_PROSTHETIC", "A_HLTH_SPFCORALHYG", "A_HLTH_SPFCOTCMED", "A_HLTH_SUNSCRN", "A_HLTH_THRMTR", "A_HLTH_TISSUETOW", "A_HLTH_TOOTHPASTEFL", "A_HOUSEHOLD_LINEN", "A_HOUSEHOLD_PAPERPRODS", "A_NEWS_104PLUS", "A_NEWS_12MTHLY", "A_NEWS_26BIWKLY", "A_NEWS_4QTLY", "A_NEWS_52WKLY", "A_PERDCL_104PLUS", "A_PERDCL_52W-4Q", "A_PERDCL_52WKLY", "A_PERDCL_ANNUAL", "A_PERDCL_SEMIANNL", "A_SCHL_GRAPHCALC", "A_SCHL_INSTRUMENT", "A_SCHL_SUPPLS", "A_SERV_INSTALL", "A_SPORT_ASUPPORT", "A_SPORT_ATHLSHOES", "A_SPORT_BIKEHLMT", "A_SPORT_MISCSPORTS1", "A_SPORT_SKISUIT", "A_SPORT_WINTERSPORTBOOTS", "A_WARR_PARTSNSRVC", "A_WARR_PARTSNSVCE" ], "description": "Amazon's product tax code identifier" }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "Amazon's product tax code identifier" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "condition_name": { "type": [ "string", "null" ] }, "products": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "images": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" } }, "required": [ "images", "title" ] } }, "propertyNames": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "required": [ "condition_name", "products" ] }, "SelectPurchaseOrderItemsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_item_id": { "type": "string" }, "user_id": { "type": "string" }, "purchase_order_id": { "type": "string" }, "gtin": { "type": "string" }, "condition_id": { "type": "number", "description": "The GTIN of the item" }, "sku": { "type": "string" }, "notes": { "type": [ "string", "null" ] }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item." }, "missing": { "type": "number", "description": "Any damaged quantity" }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities" }, "intent": { "type": [ "object", "null" ], "properties": { "marketplace": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": "array", "items": { "type": "object" } } }, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "shopper": { "type": [ "string", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "purchased": { "type": "string", "format": "date-time" }, "price": { "type": [ "number", "null" ] }, "cost": { "type": [ "number", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "product_tax_code": { "type": [ "string", "null" ], "enum": [ "A_AUTOMOTIVE_MOTOROIL", "A_BABY_BRSTPUMP", "A_BABY_CARSEAT", "A_BABY_CLOTH", "A_BABY_DIAPER", "A_BOOKS_GEN", "A_BOOKS_RELIG", "A_BOOKS_RENTAL", "A_BUNDLE_PERDCL", "A_CLSFD_52W-4Q", "A_CLSFD_52WKLY", "A_CLSFD_ANNUAL", "A_CLSFD_SEMIANNL", "A_CLTH_ATHL", "A_CLTH_BATH", "A_CLTH_BOOKBAG", "A_CLTH_BUCKLS", "A_CLTH_COMPON", "A_CLTH_CSTUMS", "A_CLTH_FORMAL", "A_CLTH_FUR", "A_CLTH_GEN", "A_CLTH_HAIRACCESSORIES", "A_CLTH_HANDKE", "A_CLTH_HBAGS", "A_CLTH_IFUR", "A_CLTH_PROTECTIVE", "A_CLTH_UMBRELLA", "A_COLLECTIBLE_COIN", "A_COMP_COMPUTER", "A_COMP_EDUSOFT", "A_COMP_GAMPER", "A_COMP_PDA", "A_COMP_PERIPH", "A_COMP_PRINT", "A_COMP_PRTSUP", "A_COMP_SCANNER", "A_COMP_SOFTOP", "A_COMP_SOFTRC", "A_COMP_STORAGEMEDIA", "A_EGOODS_DIGITALAUDIOBOOKS", "A_EGOODS_DIGITALBOOKS", "A_EGOODS_DIGITALBOOK_RENTAL", "A_EGOODS_DIGITALGAMES", "A_EGOODS_DIGITALMUSIC", "A_EGOODS_DIGITALNEWS", "A_EGOODS_DIGITALNEWSSUBS", "A_EGOODS_DIGITALPERDCL", "A_EGOODS_DIGITALPERDCLSUBS", "A_EGOODS_MISC1", "A_EGOODS_ONLINEGAMINGSUBS", "A_EGOODS_SOFT", "A_EMERGENCY_SUPPLIES", "A_FOOD_BKTCDY50-90", "A_FOOD_BKTGN50-75", "A_FOOD_BKTGN76-90", "A_FOOD_CARBSFTDK", "A_FOOD_CARBWTR", "A_FOOD_CNDY", "A_FOOD_CNDYFL", "A_FOOD_GEN", "A_FOOD_JUICE0-50", "A_FOOD_JUICE51-99", "A_FOOD_NCARBWTR", "A_FOOD_PETFOOD", "A_FOOD_WINE", "A_GEN_NOTAX", "A_GEN_RENTAL", "A_GEN_TAX", "A_HLTH_BABYSUPPLS", "A_HLTH_BANDKIT", "A_HLTH_CONTACTSOLN", "A_HLTH_CONTRCEPV", "A_HLTH_COSMETIC", "A_HLTH_DIABSUPPLS", "A_HLTH_DIETSUPMT", "A_HLTH_DISPOSABLE_PACK", "A_HLTH_FAMPLANTEST", "A_HLTH_FEMHYG", "A_HLTH_HEARINGAID_BATT", "A_HLTH_INCONT", "A_HLTH_MEDHAIRLOSS", "A_HLTH_MOBILITY", "A_HLTH_MONITOR", "A_HLTH_OTCMED", "A_HLTH_PROSTHETIC", "A_HLTH_SPFCORALHYG", "A_HLTH_SPFCOTCMED", "A_HLTH_SUNSCRN", "A_HLTH_THRMTR", "A_HLTH_TISSUETOW", "A_HLTH_TOOTHPASTEFL", "A_HOUSEHOLD_LINEN", "A_HOUSEHOLD_PAPERPRODS", "A_NEWS_104PLUS", "A_NEWS_12MTHLY", "A_NEWS_26BIWKLY", "A_NEWS_4QTLY", "A_NEWS_52WKLY", "A_PERDCL_104PLUS", "A_PERDCL_52W-4Q", "A_PERDCL_52WKLY", "A_PERDCL_ANNUAL", "A_PERDCL_SEMIANNL", "A_SCHL_GRAPHCALC", "A_SCHL_INSTRUMENT", "A_SCHL_SUPPLS", "A_SERV_INSTALL", "A_SPORT_ASUPPORT", "A_SPORT_ATHLSHOES", "A_SPORT_BIKEHLMT", "A_SPORT_MISCSPORTS1", "A_SPORT_SKISUIT", "A_SPORT_WINTERSPORTBOOTS", "A_WARR_PARTSNSRVC", "A_WARR_PARTSNSVCE" ], "description": "Amazon's product tax code identifier" }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "Amazon's product tax code identifier" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "condition_name": { "type": [ "string", "null" ] }, "products": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "images": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" } }, "required": [ "images", "title" ] } }, "propertyNames": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "required": [ "condition_name", "products" ] } } }, "required": [ "purchase_order_items" ] }, "SelectPurchaseOrderItemsSearchParams": { "type": "object", "properties": { "next": { "type": "string" }, "limit": { "type": "number" }, "with_tags": { "type": "boolean" }, "search": { "type": "string", "description": "Search items for matching values keyed by `search_by`" }, "search_by": { "type": "string", "enum": [ "sku", "gtin" ], "description": "Search items for matching values keyed by `search_by`" } } }, "SelectPurchaseOrderParams": {}, "SelectPurchaseOrderResponse": { "type": "object", "properties": { "purchase_order": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "purchase_order_name": { "type": "string" }, "user_id": { "type": "string" }, "ship_from_id": { "type": "string", "description": "The ID of the supplier." }, "created": { "type": "string", "format": "date-time", "description": "The ID of the supplier." }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_status": { "type": "string", "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view" }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time", "description": "A transitional column marking this PO created in the WFS plan view" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "summary": { "type": [ "object", "null" ], "properties": { "skus": { "type": [ "number", "null" ] }, "ordered": { "type": [ "number", "null" ] }, "received": { "type": [ "number", "null" ] }, "damaged": { "type": [ "number", "null" ] }, "missing": { "type": [ "number", "null" ] }, "not_ordered": { "type": [ "number", "null" ] } }, "required": [ "skus", "ordered", "received", "damaged", "missing", "not_ordered" ] } } } }, "required": [ "purchase_order" ] }, "SelectPurchaseOrdersParams": { "type": "object", "properties": { "next": { "type": "string" }, "archived": { "type": "boolean" }, "purchase_order_id": { "type": "string" }, "purchase_order_name": { "type": "string" }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "ship_from_id": { "type": "string", "description": "The ID of the supplier." }, "with_tags": { "type": "boolean" }, "with_summary": { "type": "boolean" }, "wfs": { "type": "boolean" }, "limit": { "type": "number" } } }, "SelectPurchaseOrdersResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "purchase_orders": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "purchase_order_name": { "type": "string" }, "user_id": { "type": "string" }, "ship_from_id": { "type": "string", "description": "The ID of the supplier." }, "created": { "type": "string", "format": "date-time", "description": "The ID of the supplier." }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_status": { "type": "string", "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view" }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time", "description": "A transitional column marking this PO created in the WFS plan view" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "summary": { "type": [ "object", "null" ], "properties": { "skus": { "type": [ "number", "null" ] }, "ordered": { "type": [ "number", "null" ] }, "received": { "type": [ "number", "null" ] }, "damaged": { "type": [ "number", "null" ] }, "missing": { "type": [ "number", "null" ] }, "not_ordered": { "type": [ "number", "null" ] } }, "required": [ "skus", "ordered", "received", "damaged", "missing", "not_ordered" ] } } } } }, "required": [ "total_rows", "purchase_orders" ] }, "SelectReportsParams": { "type": "object", "properties": { "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "report_type": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] }, "status": { "oneOf": [ { "type": "string", "enum": [ "WAIT", "PREPARING", "QUEUEING", "SUBMITTED", "IN_PROGRESS", "CANCELLED", "DONE", "DONE_NO_DATA", "ERROR", "FATAL" ] }, { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ] } ] }, "created_after": { "type": "string", "format": "date-time" }, "created_before": { "type": "string", "format": "date-time" }, "id": { "oneOf": [ { "type": "string" }, { "type": "string", "description": "System-generated ID that uniquely identifies the report request." } ] } } }, "SelectReportsResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "reports": { "type": "array", "items": { "type": "object", "properties": { "report_id": { "type": "number", "description": "Internal database identifier" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "report_type_id": { "type": "number" }, "report_status_id": { "type": "number" }, "id": { "type": "string", "description": "The reportId or requestId from the API" }, "created": { "type": "string", "format": "date-time", "description": "The reportId or requestId from the API" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "finished": { "type": [ "string", "null" ], "format": "date-time", "description": "When the report finished" }, "row_count": { "type": [ "number", "null" ], "description": "When the report finished" }, "synced_count": { "type": [ "number", "null" ], "description": "The total number of rows in the report. We may not know this until the report has finished syncing" }, "errors": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "The number of rows that have been synced thus far. Is updated continuously while the report is syncing." }, "data": { "anyOf": [ { "description": "Miscellaneous other data related to the report" }, { "type": "null" } ] }, "report_type": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] }, "status": { "oneOf": [ { "type": "string", "enum": [ "WAIT", "PREPARING", "QUEUEING", "SUBMITTED", "IN_PROGRESS", "CANCELLED", "DONE", "DONE_NO_DATA", "ERROR", "FATAL" ] }, { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ] } ] }, "is_done": { "type": "boolean" } }, "required": [ "report_type", "status", "is_done" ] } } }, "required": [ "total_rows", "reports" ] }, "SelectSchemaDataResponse": { "type": "object", "properties": { "schema": {}, "version": { "type": "string" } }, "required": [ "schema", "version" ] }, "SelectSchemaDataSearchParams": { "type": "object", "properties": { "feed_type_version": { "type": "string" } } }, "SelectSellerResponse": { "type": "object", "properties": { "total_rows": { "type": "number" }, "sellers": { "type": "array", "items": { "type": "object", "properties": { "seller_id": { "type": "string", "description": "Amazon/Walmart identifier for the seller" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } } } }, "required": [ "total_rows", "sellers" ] }, "SelectSettingsParams": { "type": "object", "properties": { "mine": { "type": "boolean" }, "key": { "type": "string", "enum": [ "accept_first_packing_option", "box_label_include_ship_from", "box_label_orientation", "box_label_single_sku_box_include_fnsku_barcode", "box_label_single_sku_box_include_sku", "box_label_single_sku_box_include_sold_as_set", "box_label_type", "fnsku_label_template", "selected_marketplace_country", "selected_marketplace_id", "selected_ship_from_id", "sourceAddress_email", "sourceAddress_name", "sourceAddress_phoneNumber", "use_my_webhook", "zero_quantity" ] } } }, "SelectShipFromPathParams": { "type": "object", "properties": { "ship_from_id": { "type": "string" } }, "required": [ "ship_from_id" ] }, "SelectShipFromResponse": { "type": "object", "properties": { "ship_from": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": "object" }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": "object" }, "email": { "type": "object" }, "phone": { "type": "object" }, "place_id": { "type": "object" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": "object" }, "archived": { "type": "object" }, "archived_by": { "type": "object" }, "can_edit": { "type": "boolean" } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by", "can_edit" ] } }, "required": [ "ship_from" ] }, "SelectShipFromRow": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": "object" }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": "object" }, "email": { "type": "object" }, "phone": { "type": "object" }, "place_id": { "type": "object" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": "object" }, "archived": { "type": "object" }, "archived_by": { "type": "object" }, "can_edit": { "type": "boolean" } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by", "can_edit" ] }, "SelectShipFromsParams": { "type": "object", "properties": { "next": { "type": "string" }, "limit": { "type": "number" }, "with_prep_center_name": { "type": "boolean", "description": "If true, ship_from name becomes \":prepCenterName Attn: :clientName\", otherwise just \":clientName\" for prep centers and clients." }, "archived": { "type": "boolean", "description": "If true, return only archived, if false, return non-archived, and if omitted, return all" }, "ship_from_id": { "type": "string", "description": "If provided, returns only the matching row regardless of archived status" } } }, "SelectShipFromsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "ship_froms": { "type": "array", "items": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": "object" }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": "object" }, "email": { "type": "object" }, "phone": { "type": "object" }, "place_id": { "type": "object" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": "object" }, "archived": { "type": "object" }, "archived_by": { "type": "object" }, "can_edit": { "type": "boolean" } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by", "can_edit" ] } }, "total_rows": { "type": "number" } }, "required": [ "ship_froms" ] }, "SelectShipmentsParams": { "type": "object", "properties": { "inboundPlanId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipmentConfirmationId": { "type": [ "string", "null" ] } } }, "SelectShipmentsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "shipments": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": [ "string", "null" ] }, "shipment_id": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "number", "null" ] }, "marketplace_id": { "type": [ "string", "null" ] }, "ship_from_id": { "type": [ "number", "null" ] }, "status": { "type": [ "string", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": [ "string", "null" ] }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "synced": { "type": [ "string", "null" ], "format": "date-time" }, "inbound_plan_id": { "type": [ "string", "null" ] }, "placement_option_id": { "type": [ "string", "null" ] }, "shipping_solution": { "type": [ "string", "null" ], "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ] }, "selected_transportation_option_id": { "type": [ "string", "null" ] }, "confirmed_transportation_option_id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "amazon_reference_id": { "type": [ "string", "null" ] }, "contact_information": { "anyOf": [ {}, { "type": "null" } ] }, "dates": { "anyOf": [ {}, { "type": "null" } ] }, "destination": { "anyOf": [ {}, { "type": "null" } ] }, "freight_information": { "anyOf": [ {}, { "type": "null" } ] }, "selected_delivery_window": { "anyOf": [ {}, { "type": "null" } ] }, "self_ship_appointment_details": { "anyOf": [ {}, { "type": "null" } ] }, "shipment_confirmation_id": { "type": [ "string", "null" ] }, "tracking_details": { "anyOf": [ {}, { "type": "null" } ] }, "update_shipment_tracking_details_operation": { "anyOf": [ {}, { "type": "null" } ] }, "update_shipment_tracking_details_operation_at": { "type": [ "string", "null" ], "format": "date-time" }, "boxes": { "anyOf": [ {}, { "type": "null" } ] }, "boxes_update": { "anyOf": [ {}, { "type": "null" } ] }, "items": { "anyOf": [ {}, { "type": "null" } ] }, "ship_date": { "type": [ "string", "null" ], "format": "date-time" }, "shipping_mode": { "type": [ "string", "null" ], "enum": [ "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS", "FREIGHT_FTL_NONPALLET", "FREIGHT_FTL_PALLET", "FREIGHT_LTL", "GROUND_SMALL_PARCEL", "OCEAN_FCL", "OCEAN_LCL" ] }, "dirty": { "type": [ "boolean", "null" ] }, "selected_delivery_window_option_id": { "type": [ "string", "null" ] }, "shipment_units": { "type": [ "number", "null" ] }, "received_units": { "type": [ "number", "null" ] }, "items_submitted": { "type": [ "number", "null" ] }, "received_units_at_fc": { "type": [ "number", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "updated_expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "actual_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "tracking_no": { "type": [ "array", "null" ], "items": { "type": "string" } }, "carrier_name": { "type": [ "string", "null" ] }, "channel_method": { "type": [ "string", "null" ] }, "ship_node": { "type": [ "string", "null" ] }, "shipment_type": { "type": [ "string", "null" ] }, "po_type": { "type": [ "string", "null" ] }, "shipment_carrier_type": { "type": [ "string", "null" ] }, "is_exception_occurred": { "type": [ "boolean", "null" ] }, "exception_status": { "type": [ "string", "null" ] }, "is_po_box_enabled": { "type": [ "boolean", "null" ] }, "transfer_shipments": { "anyOf": [ {}, { "type": "null" } ] }, "consolidated_transfer_shipments": { "anyOf": [ {}, { "type": "null" } ] }, "receipt_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "receipt_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "anyOf": [ {}, { "type": "null" } ] }, "carrier_rate_quotes": { "anyOf": [ {}, { "type": "null" } ] }, "inbound_order_id": { "type": [ "string", "null" ] }, "single_sku_box_count": { "type": [ "number", "null" ] }, "mixed_sku_box_count": { "type": [ "number", "null" ] }, "user_shipment_carrier_type": { "type": [ "string", "null" ] }, "preferred_pickup_date": { "type": [ "string", "null" ], "format": "date-time" }, "freight_class": { "type": [ "number", "null" ] }, "declared_value": { "type": [ "number", "null" ] }, "pickup_instructions": { "type": [ "string", "null" ] }, "pickup_seller_schedule": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "channel", "shipment_id", "user_id", "plan_id", "marketplace_id", "ship_from_id", "status", "created", "created_by", "creation_source", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by", "synced", "inbound_plan_id", "placement_option_id", "shipping_solution", "selected_transportation_option_id", "confirmed_transportation_option_id", "name", "amazon_reference_id", "contact_information", "dates", "destination", "freight_information", "selected_delivery_window", "self_ship_appointment_details", "shipment_confirmation_id", "tracking_details", "update_shipment_tracking_details_operation", "update_shipment_tracking_details_operation_at", "boxes", "boxes_update", "items", "ship_date", "shipping_mode", "dirty", "selected_delivery_window_option_id", "shipment_units", "received_units", "items_submitted", "received_units_at_fc", "expected_delivery_date", "updated_expected_delivery_date", "actual_delivery_date", "tracking_no", "carrier_name", "channel_method", "ship_node", "shipment_type", "po_type", "shipment_carrier_type", "is_exception_occurred", "exception_status", "is_po_box_enabled", "transfer_shipments", "consolidated_transfer_shipments", "receipt_start_date", "receipt_end_date", "data", "carrier_rate_quotes", "inbound_order_id", "single_sku_box_count", "mixed_sku_box_count", "user_shipment_carrier_type", "preferred_pickup_date", "freight_class", "declared_value", "pickup_instructions", "pickup_seller_schedule" ] } }, "total_rows": { "type": "number" } }, "required": [ "shipments" ] }, "SelectSuppliersParams": { "type": "object", "properties": { "next": { "type": "string" }, "archived": { "type": "boolean" }, "supplier_ids": { "type": "array", "items": { "type": "string" } }, "supplier_name": { "type": "string" }, "limit": { "type": "number" } } }, "SelectSuppliersResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "suppliers": { "type": "array", "items": { "type": "object", "properties": { "supplier_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "supplier_name": { "type": "string" }, "created_by": { "type": [ "string", "null" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } } } } }, "required": [ "total_rows", "suppliers" ] }, "SelectTagsParams": { "type": "object", "properties": { "next": { "type": "string" }, "tag_ids": { "type": "array", "items": { "type": "string" } }, "tag_name": { "type": "string" }, "tag_types": { "type": "array", "items": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] } }, "uri": { "type": "string" }, "limit": { "type": "number" } } }, "SelectTagsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "total_rows": { "type": "number" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } } }, "required": [ "tags" ] }, "SelectThreePlBillingParams": { "type": "object", "properties": { "query_type": { "type": "string", "enum": [ "new", "legacy" ] }, "region": { "oneOf": [ { "type": "string", "enum": [ "east", "west", "uk" ] }, { "type": "string", "enum": [ "all" ] } ] }, "user_id": { "type": "string" }, "user_email": { "type": "string" }, "ship_from_id": { "type": "number" }, "client_id": { "type": "string" }, "client_email": { "type": "string" }, "channel": { "type": "string", "enum": [ "az", "wm" ] }, "start": { "type": "string" }, "end": { "type": "string" }, "limit": { "type": "number" }, "offset": { "type": "number" } } }, "SelectThreePlBillingResponse": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "row_id": { "type": "string" }, "region": { "type": "string", "enum": [ "east", "west", "uk" ] }, "three_pl_user_id": { "type": "string" }, "three_pl_email": { "type": [ "string", "null" ] }, "three_pl_name": { "type": [ "string", "null" ] }, "ship_from_id": { "type": "number" }, "ship_from_place_id": { "type": [ "string", "null" ] }, "ship_from_name": { "type": "string" }, "client_id": { "type": "string" }, "client_name": { "type": "string" }, "client_email": { "type": "string" }, "channel": { "type": "string", "enum": [ "az", "wm" ] }, "marketplace_id": { "type": "string" }, "shipment_count": { "type": "number" }, "shipment_units": { "type": "number" }, "earliest_shipment_created": { "type": "string" }, "latest_shipment_created": { "type": "string" }, "prep_client_subscription": { "type": [ "string", "null" ] } }, "required": [ "row_id", "region", "three_pl_user_id", "three_pl_email", "three_pl_name", "ship_from_id", "ship_from_place_id", "ship_from_name", "client_id", "client_name", "client_email", "channel", "marketplace_id", "shipment_count", "shipment_units", "earliest_shipment_created", "latest_shipment_created", "prep_client_subscription" ] } }, "total_rows": { "type": "number" } }, "required": [ "rows", "total_rows" ] }, "SelectTransportationOptionsParams": { "type": "object", "properties": { "inboundPlanId": { "type": "string" }, "transportationOptionIds": { "type": "array", "items": { "type": "string" } }, "placementOptionId": { "type": "string" }, "shipmentId": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "OFFERED" ] } } }, "required": [ "inboundPlanId" ] }, "SelectTransportationOptionsSearchParams": { "type": "object", "properties": { "inboundPlanId": { "type": "string" }, "transportationOptionIds": { "type": "array", "items": { "type": "string" } }, "placementOptionId": { "type": "string" }, "shipmentId": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "OFFERED" ] } }, "force": { "type": "boolean", "description": "pass `true` to force loading data from SP-API" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "SelectUsersParams": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Only active sub-users or inactive. Defaults to true" }, "with_ship_froms": { "type": "boolean", "description": "Include ship froms users has access to" }, "with_clients": { "type": "boolean", "description": "Include clients users users has access to" }, "with_roles": { "type": "boolean", "description": "Include roles users has access to" } } }, "SelectUsersResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "abbreviated_name": { "type": [ "string", "null" ], "description": "The user provided abbreviated version of their business name" }, "active": { "type": "boolean", "description": "Whether or not the user is active. Generally used for toggling sub user access" }, "clients": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string" }, "user_name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" }, "business_name": { "type": [ "string", "null" ], "description": "The name of the user" } } } }, "email": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "ship_froms": { "type": "array", "items": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" } } } }, "roles": { "type": "array", "items": { "type": "object", "properties": { "role_id": { "type": "string", "enum": [ "3pl-billing", "admin", "api", "integration", "manage-team", "prep-center", "prep-client" ] }, "role_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "role_id", "role_name", "description" ] } }, "user_id": { "type": "string" }, "user_name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" } }, "required": [ "abbreviated_name", "active", "email", "parent_id", "user_id", "user_name" ] } } }, "required": [ "users" ] }, "SelectWebHooksResponse": { "type": "object", "properties": { "web_hooks": { "type": "array", "items": { "type": "object", "properties": { "web_hook_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "endpoint": { "type": "string" }, "enabled": { "type": "boolean" }, "options": { "anyOf": [ {}, { "type": "null" } ] }, "has_secret_key": { "type": "boolean" } }, "required": [ "has_secret_key" ] } } }, "required": [ "web_hooks" ] }, "SelectWmShipmentResponse": { "type": "object", "properties": { "wm_shipment": { "type": "object", "properties": { "shipment_id": { "type": "string" }, "user_id": { "type": "string" }, "plan_id": { "type": [ "number", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": "number" }, "status": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "synced": { "type": [ "string", "null" ], "format": "date-time" }, "ship_to_address": { "type": [ "object", "null" ], "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "shipment_units": { "type": [ "number", "null" ] }, "received_units": { "type": [ "number", "null" ] }, "items_submitted": { "type": [ "number", "null" ] }, "received_units_at_fc": { "type": [ "number", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "updated_expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "actual_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "tracking_no": { "type": [ "array", "null" ], "items": { "type": "string" } }, "carrier_name": { "type": [ "string", "null" ] }, "channel_method": { "type": [ "string", "null" ] }, "ship_node": { "type": [ "string", "null" ] }, "shipment_type": { "type": [ "string", "null" ] }, "po_type": { "type": [ "string", "null" ] }, "shipment_carrier_type": { "type": [ "string", "null" ] }, "is_exception_occurred": { "type": [ "boolean", "null" ] }, "exception_status": { "type": [ "string", "null" ] }, "is_po_box_enabled": { "type": [ "boolean", "null" ] }, "transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "consolidated_transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "receipt_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "receipt_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "anyOf": [ {}, { "type": "null" } ] }, "carrier_rate_quotes": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "assessorialCharge": { "type": "number" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "declaredValue": { "type": "string" }, "discountCharge": { "type": "number" }, "effectiveDate": { "type": "string" }, "equipmentTypeCode": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string" }, "expiryDate": { "type": "string" }, "freightCharge": { "type": "number" }, "freightReadyDate": { "type": "string" }, "fuelCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "mixedSKUs": { "type": "number" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "netCharge": { "type": "number" }, "nominalCharge": { "type": "number" }, "numberOfPallets": { "type": "number" }, "quoteId": { "type": "string" }, "sellerFreightClassCode": { "type": "string" }, "serviceCharge": { "type": "number" }, "serviceCode": { "type": "string" }, "singleSKUs": { "type": "number" }, "status": { "type": "string" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "totalWeight": { "type": "number" }, "transitDays": { "type": "string" }, "sp_status": { "type": "string" } } } }, "inbound_order_id": { "type": "string" }, "single_sku_box_count": { "type": [ "number", "null" ] }, "mixed_sku_box_count": { "type": [ "number", "null" ] }, "user_shipment_carrier_type": { "type": [ "string", "null" ], "description": "The user-provided non/partnered SPT/LTL/FTL status" }, "preferred_pickup_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The user-provided non/partnered SPT/LTL/FTL status" }, "freight_class": { "type": [ "number", "null" ] }, "declared_value": { "type": [ "number", "null" ] }, "pickup_instructions": { "type": [ "string", "null" ] }, "pickup_seller_schedule": { "anyOf": [ {}, { "type": "null" } ] }, "shipment_items": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" }, "images": { "type": "array", "items": { "type": "string" } } } } } }, "required": [ "shipment_items" ] } }, "required": [ "wm_shipment" ] }, "SelectWmShipmentsParams": { "type": "object", "properties": { "next": { "type": "string" }, "shipment_id": { "type": "string" }, "inbound_order_id": { "type": "string" }, "ship_from_id": { "type": "number" }, "limit": { "type": "number" }, "with_tags": { "type": "boolean" } } }, "SelectWmShipmentsResponse": { "type": "object", "properties": { "next": { "type": "string" }, "wm_shipments": { "type": "array", "items": { "type": "object", "properties": { "shipment_id": { "type": "string" }, "user_id": { "type": "string" }, "plan_id": { "type": [ "number", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": "number" }, "status": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "synced": { "type": [ "string", "null" ], "format": "date-time" }, "ship_to_address": { "type": [ "object", "null" ], "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "shipment_units": { "type": [ "number", "null" ] }, "received_units": { "type": [ "number", "null" ] }, "items_submitted": { "type": [ "number", "null" ] }, "received_units_at_fc": { "type": [ "number", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "updated_expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "actual_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "tracking_no": { "type": [ "array", "null" ], "items": { "type": "string" } }, "carrier_name": { "type": [ "string", "null" ] }, "channel_method": { "type": [ "string", "null" ] }, "ship_node": { "type": [ "string", "null" ] }, "shipment_type": { "type": [ "string", "null" ] }, "po_type": { "type": [ "string", "null" ] }, "shipment_carrier_type": { "type": [ "string", "null" ] }, "is_exception_occurred": { "type": [ "boolean", "null" ] }, "exception_status": { "type": [ "string", "null" ] }, "is_po_box_enabled": { "type": [ "boolean", "null" ] }, "transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "consolidated_transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "receipt_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "receipt_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "anyOf": [ {}, { "type": "null" } ] }, "carrier_rate_quotes": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "assessorialCharge": { "type": "number" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "declaredValue": { "type": "string" }, "discountCharge": { "type": "number" }, "effectiveDate": { "type": "string" }, "equipmentTypeCode": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string" }, "expiryDate": { "type": "string" }, "freightCharge": { "type": "number" }, "freightReadyDate": { "type": "string" }, "fuelCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "mixedSKUs": { "type": "number" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "netCharge": { "type": "number" }, "nominalCharge": { "type": "number" }, "numberOfPallets": { "type": "number" }, "quoteId": { "type": "string" }, "sellerFreightClassCode": { "type": "string" }, "serviceCharge": { "type": "number" }, "serviceCode": { "type": "string" }, "singleSKUs": { "type": "number" }, "status": { "type": "string" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "totalWeight": { "type": "number" }, "transitDays": { "type": "string" }, "sp_status": { "type": "string" } } } }, "inbound_order_id": { "type": "string" }, "single_sku_box_count": { "type": [ "number", "null" ] }, "mixed_sku_box_count": { "type": [ "number", "null" ] }, "user_shipment_carrier_type": { "type": [ "string", "null" ], "description": "The user-provided non/partnered SPT/LTL/FTL status" }, "preferred_pickup_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The user-provided non/partnered SPT/LTL/FTL status" }, "freight_class": { "type": [ "number", "null" ] }, "declared_value": { "type": [ "number", "null" ] }, "pickup_instructions": { "type": [ "string", "null" ] }, "pickup_seller_schedule": { "anyOf": [ {}, { "type": "null" } ] }, "shipment_items": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" }, "images": { "type": "array", "items": { "type": "string" } } } } } }, "required": [ "shipment_items" ] } }, "total_rows": { "type": "number" } }, "required": [ "wm_shipments" ] }, "SellerSummary": { "type": "object", "properties": { "seller_id": { "type": "string", "description": "Amazon/Walmart identifier for the seller" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "setting_key": { "type": "string", "enum": [ "accept_first_packing_option", "box_label_include_ship_from", "box_label_orientation", "box_label_single_sku_box_include_fnsku_barcode", "box_label_single_sku_box_include_sku", "box_label_single_sku_box_include_sold_as_set", "box_label_type", "fnsku_label_template", "selected_marketplace_country", "selected_marketplace_id", "selected_ship_from_id", "sourceAddress_email", "sourceAddress_name", "sourceAddress_phoneNumber", "use_my_webhook", "zero_quantity" ] }, "Settings": { "type": "object", "properties": { "zero_quantity": { "type": "boolean" } } }, "ShipFrom": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "place_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ] }, "Shipment": { "type": "object", "properties": { "channel": { "type": [ "string", "null" ] }, "shipment_id": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "number", "null" ] }, "marketplace_id": { "type": [ "string", "null" ] }, "ship_from_id": { "type": [ "number", "null" ] }, "status": { "type": [ "string", "null" ] }, "created": { "type": [ "string", "null" ], "format": "date-time" }, "created_by": { "type": [ "string", "null" ] }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "synced": { "type": [ "string", "null" ], "format": "date-time" }, "inbound_plan_id": { "type": [ "string", "null" ] }, "placement_option_id": { "type": [ "string", "null" ] }, "shipping_solution": { "type": [ "string", "null" ], "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ] }, "selected_transportation_option_id": { "type": [ "string", "null" ] }, "confirmed_transportation_option_id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "amazon_reference_id": { "type": [ "string", "null" ] }, "contact_information": { "anyOf": [ {}, { "type": "null" } ] }, "dates": { "anyOf": [ {}, { "type": "null" } ] }, "destination": { "anyOf": [ {}, { "type": "null" } ] }, "freight_information": { "anyOf": [ {}, { "type": "null" } ] }, "selected_delivery_window": { "anyOf": [ {}, { "type": "null" } ] }, "self_ship_appointment_details": { "anyOf": [ {}, { "type": "null" } ] }, "shipment_confirmation_id": { "type": [ "string", "null" ] }, "tracking_details": { "anyOf": [ {}, { "type": "null" } ] }, "update_shipment_tracking_details_operation": { "anyOf": [ {}, { "type": "null" } ] }, "update_shipment_tracking_details_operation_at": { "type": [ "string", "null" ], "format": "date-time" }, "boxes": { "anyOf": [ {}, { "type": "null" } ] }, "boxes_update": { "anyOf": [ {}, { "type": "null" } ] }, "items": { "anyOf": [ {}, { "type": "null" } ] }, "ship_date": { "type": [ "string", "null" ], "format": "date-time" }, "shipping_mode": { "type": [ "string", "null" ], "enum": [ "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS", "FREIGHT_FTL_NONPALLET", "FREIGHT_FTL_PALLET", "FREIGHT_LTL", "GROUND_SMALL_PARCEL", "OCEAN_FCL", "OCEAN_LCL" ] }, "dirty": { "type": [ "boolean", "null" ] }, "selected_delivery_window_option_id": { "type": [ "string", "null" ] }, "shipment_units": { "type": [ "number", "null" ] }, "received_units": { "type": [ "number", "null" ] }, "items_submitted": { "type": [ "number", "null" ] }, "received_units_at_fc": { "type": [ "number", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "updated_expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "actual_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "tracking_no": { "type": [ "array", "null" ], "items": { "type": "string" } }, "carrier_name": { "type": [ "string", "null" ] }, "channel_method": { "type": [ "string", "null" ] }, "ship_node": { "type": [ "string", "null" ] }, "shipment_type": { "type": [ "string", "null" ] }, "po_type": { "type": [ "string", "null" ] }, "shipment_carrier_type": { "type": [ "string", "null" ] }, "is_exception_occurred": { "type": [ "boolean", "null" ] }, "exception_status": { "type": [ "string", "null" ] }, "is_po_box_enabled": { "type": [ "boolean", "null" ] }, "transfer_shipments": { "anyOf": [ {}, { "type": "null" } ] }, "consolidated_transfer_shipments": { "anyOf": [ {}, { "type": "null" } ] }, "receipt_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "receipt_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "anyOf": [ {}, { "type": "null" } ] }, "carrier_rate_quotes": { "anyOf": [ {}, { "type": "null" } ] }, "inbound_order_id": { "type": [ "string", "null" ] }, "single_sku_box_count": { "type": [ "number", "null" ] }, "mixed_sku_box_count": { "type": [ "number", "null" ] }, "user_shipment_carrier_type": { "type": [ "string", "null" ] }, "preferred_pickup_date": { "type": [ "string", "null" ], "format": "date-time" }, "freight_class": { "type": [ "number", "null" ] }, "declared_value": { "type": [ "number", "null" ] }, "pickup_instructions": { "type": [ "string", "null" ] }, "pickup_seller_schedule": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "channel", "shipment_id", "user_id", "plan_id", "marketplace_id", "ship_from_id", "status", "created", "created_by", "creation_source", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by", "synced", "inbound_plan_id", "placement_option_id", "shipping_solution", "selected_transportation_option_id", "confirmed_transportation_option_id", "name", "amazon_reference_id", "contact_information", "dates", "destination", "freight_information", "selected_delivery_window", "self_ship_appointment_details", "shipment_confirmation_id", "tracking_details", "update_shipment_tracking_details_operation", "update_shipment_tracking_details_operation_at", "boxes", "boxes_update", "items", "ship_date", "shipping_mode", "dirty", "selected_delivery_window_option_id", "shipment_units", "received_units", "items_submitted", "received_units_at_fc", "expected_delivery_date", "updated_expected_delivery_date", "actual_delivery_date", "tracking_no", "carrier_name", "channel_method", "ship_node", "shipment_type", "po_type", "shipment_carrier_type", "is_exception_occurred", "exception_status", "is_po_box_enabled", "transfer_shipments", "consolidated_transfer_shipments", "receipt_start_date", "receipt_end_date", "data", "carrier_rate_quotes", "inbound_order_id", "single_sku_box_count", "mixed_sku_box_count", "user_shipment_carrier_type", "preferred_pickup_date", "freight_class", "declared_value", "pickup_instructions", "pickup_seller_schedule" ] }, "shipping_mode": { "type": "string", "enum": [ "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS", "FREIGHT_FTL_NONPALLET", "FREIGHT_FTL_PALLET", "FREIGHT_LTL", "GROUND_SMALL_PARCEL", "OCEAN_FCL", "OCEAN_LCL" ] }, "shipping_solution": { "type": "string", "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ] }, "SignQzRequestParams": { "type": "object", "properties": { "request": { "type": "string", "description": "The challenge string QZ Tray asks the page to sign.", "nullable": false } }, "required": [ "request" ] }, "SpApiAddInventoryBody": { "type": "object", "properties": { "inventoryItems": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sellerSku": { "type": "string", "description": "The seller SKU of the item.", "nullable": false }, "marketplaceId": { "type": "string", "description": "The marketplaceId.", "nullable": false }, "quantity": { "type": "number", "description": "The quantity of item to add.", "nullable": false } }, "required": [ "sellerSku", "marketplaceId", "quantity" ] } } } }, "SpApiAddInventoryErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "SpApiAddInventoryResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "SpApiAddInventorySearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiCancelInboundPlanErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiCancelInboundPlanResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiCancelInboundPlanSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiCancelReportErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "Error response returned when the request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiCancelReportScheduleErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "Error response returned when the request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiCancelReportScheduleSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiCancelReportSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiCancelSelfShipAppointmentBody": { "type": "object", "properties": { "reasonComment": { "type": [ "string", "null" ], "enum": [ "APPOINTMENT_REQUESTED_BY_MISTAKE", "VEHICLE_DELAY", "SLOT_NOT_SUITABLE", "OUTSIDE_CARRIER_BUSINESS_HOURS", "UNFAVOURABLE_EXTERNAL_CONDITIONS", "PROCUREMENT_DELAY", "SHIPPING_PLAN_CHANGED", "INCREASED_QUANTITY", "OTHER" ] } } }, "SpApiCancelSelfShipAppointmentErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiCancelSelfShipAppointmentResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiCancelSelfShipAppointmentSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiConfirmDeliveryWindowOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiConfirmDeliveryWindowOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiConfirmDeliveryWindowOptionsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiConfirmPackingOptionErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiConfirmPackingOptionResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiConfirmPackingOptionSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiConfirmPlacementOptionErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiConfirmPlacementOptionResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiConfirmShipmentContentUpdatePreviewErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiConfirmShipmentContentUpdatePreviewResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiConfirmShipmentContentUpdatePreviewSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiConfirmTransportationOptionsBody": { "type": "object", "properties": { "transportationSelections": { "type": "array", "items": { "type": "object", "properties": { "contactInformation": { "type": [ "object", "null" ], "properties": { "email": { "type": [ "string", "null" ], "description": "The email address." }, "name": { "type": "string", "description": "The contact's name.", "nullable": false }, "phoneNumber": { "type": "string", "description": "The phone number.", "nullable": false } }, "required": [ "name", "phoneNumber" ] }, "shipmentId": { "type": "string", "description": "Shipment ID that the transportation Option is for.", "nullable": false }, "transportationOptionId": { "type": "string", "description": "Transportation option being selected for the provided shipment.", "nullable": false } }, "required": [ "shipmentId", "transportationOptionId" ] }, "description": "Information needed to confirm one of the available transportation options.", "nullable": false } }, "required": [ "transportationSelections" ] }, "SpApiConfirmTransportationOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiConfirmTransportationOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiConfirmTransportationOptionsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiCreateDestinationBody": { "type": "object", "properties": { "resourceSpecification": { "type": "object", "properties": { "sqs": { "type": [ "object", "null" ], "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue.", "nullable": false } }, "required": [ "arn" ] }, "eventBridge": { "type": [ "object", "null" ], "properties": { "region": { "type": "string", "description": "The AWS region in which you will be receiving the notifications.", "nullable": false }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications.", "nullable": false } }, "required": [ "region", "accountId" ] } }, "nullable": false }, "name": { "type": "string", "description": "A developer-defined name to help identify this destination.", "nullable": false } }, "required": [ "resourceSpecification", "name" ] }, "SpApiCreateDestinationErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } }, "description": "The destination identifier generated when you created the destination." } }, "required": [ "name", "destinationId", "resource" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiCreateDestinationResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } }, "description": "The destination identifier generated when you created the destination." } }, "required": [ "name", "destinationId", "resource" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiCreateDestinationSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiCreateInboundPlanBody": { "type": "object", "properties": { "destinationMarketplaces": { "type": "array", "items": { "type": "string" }, "description": "Marketplaces where the items need to be shipped to. Currently only one marketplace can be selected in this request.", "nullable": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped.", "nullable": false } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "Items included in this plan.", "nullable": false }, "name": { "type": [ "string", "null" ], "description": "Name for the Inbound Plan. If one isn't provided, a default name will be provided." }, "sourceAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information.", "nullable": false }, "addressLine2": { "type": [ "string", "null" ], "description": "Additional street address information." }, "city": { "type": "string", "description": "The city.", "nullable": false }, "companyName": { "type": [ "string", "null" ], "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format.", "nullable": false }, "districtOrCounty": { "type": [ "string", "null" ], "description": "The district or county." }, "email": { "type": [ "string", "null" ], "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact.", "nullable": false }, "phoneNumber": { "type": "string", "description": "The phone number.", "nullable": false }, "postalCode": { "type": "string", "description": "The postal code.", "nullable": false }, "stateOrProvinceCode": { "type": [ "string", "null" ], "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "phoneNumber", "postalCode" ], "description": "Name for the Inbound Plan. If one isn't provided, a default name will be provided.", "nullable": false } }, "required": [ "destinationMarketplaces", "items", "sourceAddress" ] }, "SpApiCreateInboundPlanErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiCreateInboundPlanResponse": { "type": "object", "properties": { "inboundPlanId": { "type": "string", "description": "Identifier of an inbound plan." }, "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "inboundPlanId", "operationId" ] }, "SpApiCreateInboundPlanSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiCreateInventoryItemBody": { "type": "object", "properties": { "sellerSku": { "type": "string", "description": "The seller SKU of the item.", "nullable": false }, "marketplaceId": { "type": "string", "description": "The marketplaceId.", "nullable": false }, "productName": { "type": "string", "description": "The name of the item.", "nullable": false } }, "required": [ "sellerSku", "marketplaceId", "productName" ] }, "SpApiCreateInventoryItemErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "SpApiCreateInventoryItemResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "SpApiCreateInventoryItemSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiCreateMarketplaceItemLabelsBody": { "type": "object", "properties": { "height": { "type": [ "number", "null" ], "description": "The height of the item label." }, "labelType": { "type": "string", "enum": [ "STANDARD_FORMAT", "THERMAL_PRINTING" ], "description": "The height of the item label.", "nullable": false }, "localeCode": { "type": [ "string", "null" ], "description": "The locale code constructed from ISO 639 language code and ISO 3166-1 alpha-2 standard of country codes separated by an underscore character." }, "marketplaceId": { "type": "string", "description": "The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "nullable": false }, "mskuQuantities": { "type": "array", "items": { "type": "object", "properties": { "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "A positive integer.", "nullable": false } }, "required": [ "msku", "quantity" ] }, "description": "Represents the quantity of an MSKU to print item labels for.", "nullable": false }, "pageType": { "type": [ "string", "null" ], "enum": [ "A4_21", "A4_24", "A4_24_64x33", "A4_24_66x35", "A4_24_70x36", "A4_24_70x37", "A4_24i", "A4_27", "A4_40_52x29", "A4_44_48x25", "Letter_30" ], "description": "Represents the quantity of an MSKU to print item labels for." }, "width": { "type": [ "number", "null" ], "description": "The width of the item label." } }, "required": [ "labelType", "marketplaceId", "mskuQuantities" ] }, "SpApiCreateMarketplaceItemLabelsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiCreateMarketplaceItemLabelsResponse": { "type": "object", "properties": { "documentDownloads": { "type": "array", "items": { "type": "object", "properties": { "downloadType": { "type": "string", "description": "The type of download. Possible values: `URL`." }, "expiration": { "type": "string", "description": "The URI's expiration time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "uri": { "type": "string", "description": "Uniform resource identifier to identify where the document is located." } }, "required": [ "downloadType", "uri" ] }, "description": "Resources to download the requested document." } }, "required": [ "documentDownloads" ] }, "SpApiCreateMarketplaceItemLabelsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiCreateReportBody": { "type": "object", "properties": { "reportOptions": { "anyOf": [ {}, { "type": "null" } ] }, "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.", "nullable": false }, "dataStartTime": { "type": [ "string", "null" ], "description": "The start of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this." }, "dataEndTime": { "type": [ "string", "null" ], "description": "The end of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.", "nullable": false } }, "required": [ "reportType", "marketplaceIds" ] }, "SpApiCreateReportErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "Error response returned when the request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiCreateReportResponse": { "type": "object", "properties": { "reportId": { "type": "string", "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." } }, "required": [ "reportId" ] }, "SpApiCreateReportScheduleBody": { "type": "object", "properties": { "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.", "nullable": false }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers for the report schedule.", "nullable": false }, "reportOptions": { "anyOf": [ { "description": "A list of marketplace identifiers for the report schedule." }, { "type": "null" } ] }, "period": { "type": "string", "enum": [ "PT5M", "PT15M", "PT30M", "PT1H", "PT2H", "PT4H", "PT8H", "PT12H", "P1D", "P2D", "P3D", "PT84H", "P7D", "P14D", "P15D", "P18D", "P30D", "P1M" ], "description": "One of a set of predefined ISO 8601 periods that specifies how often a report should be created.", "nullable": false }, "nextReportCreationTime": { "type": [ "string", "null" ], "description": "The date and time when the schedule will create its next report, in ISO 8601 date time format." } }, "required": [ "reportType", "marketplaceIds", "period" ] }, "SpApiCreateReportScheduleErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "Error response returned when the request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiCreateReportScheduleSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiCreateReportSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiCreateSubscriptionBody": { "type": "object", "properties": { "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification.", "nullable": false }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered.", "nullable": false }, "processingDirective": { "type": [ "object", "null" ], "properties": { "eventFilter": { "type": [ "object", "null" ], "properties": {} }, "filterExpression": { "type": [ "string", "null" ], "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } }, "description": "The identifier for the destination where notifications will be delivered." } }, "required": [ "payloadVersion", "destinationId" ] }, "SpApiCreateSubscriptionErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier generated when the subscription is created." }, "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "type": "object", "properties": { "eventFilter": { "type": "object", "properties": {} }, "filterExpression": { "type": "string", "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } }, "description": "The identifier for the destination where notifications will be delivered." } }, "required": [ "subscriptionId", "payloadVersion", "destinationId" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiCreateSubscriptionResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier generated when the subscription is created." }, "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "type": "object", "properties": { "eventFilter": { "type": "object", "properties": {} }, "filterExpression": { "type": "string", "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } }, "description": "The identifier for the destination where notifications will be delivered." } }, "required": [ "subscriptionId", "payloadVersion", "destinationId" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiCreateSubscriptionSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiDeleteDestinationErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiDeleteDestinationResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiDeleteDestinationSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiDeleteInventoryItemErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "SpApiDeleteInventoryItemResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "SpApiDeleteInventoryItemSearchParams": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceId", "mp" ] }, "SpApiDeleteListingsItemErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses." } }, "required": [ "errors" ] }, "SpApiDeleteListingsItemResponse": { "type": "object", "properties": { "sku": { "type": "string", "description": "A selling partner-provided identifier for an Amazon listing." }, "status": { "type": "string", "enum": [ "ACCEPTED", "INVALID", "VALID" ], "description": "The status of the listings item submission." }, "submissionId": { "type": "string", "description": "The unique identifier of the listings item submission." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] }, "description": "Listings item issues related to the listings item submission." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." } } }, "description": "Listings item issues related to the listings item submission." } }, "required": [ "sku", "status", "submissionId" ] }, "SpApiDeleteListingsItemSearchParams": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" } }, "issueLocale": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceIds", "mp" ] }, "SpApiDeleteSubscriptionByIdErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiDeleteSubscriptionByIdResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiDeleteSubscriptionByIdSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGenerateDeliveryWindowOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGenerateDeliveryWindowOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiGenerateDeliveryWindowOptionsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGeneratePackingOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGeneratePackingOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiGeneratePackingOptionsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGeneratePlacementOptionsBody": { "type": "object", "properties": { "customPlacement": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped.", "nullable": false } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "Items included while creating Inbound Plan.", "nullable": false }, "warehouseId": { "type": "string", "description": "Warehouse Id.", "nullable": false } }, "required": [ "items", "warehouseId" ] }, "description": "Custom placement options you want to add to the plan. This is only used for the India (IN - A21TJRUUN4KGV) marketplace." } } }, "SpApiGeneratePlacementOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGeneratePlacementOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiGeneratePlacementOptionsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGenerateSelfShipAppointmentSlotsBody": { "type": "object", "properties": { "desiredEndDate": { "type": [ "string", "null" ], "description": "The desired end date. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format." }, "desiredStartDate": { "type": [ "string", "null" ], "description": "The desired start date. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format." } } }, "SpApiGenerateSelfShipAppointmentSlotsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGenerateSelfShipAppointmentSlotsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGenerateShipmentContentUpdatePreviewsBody": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "nullable": false }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package.", "nullable": false }, "length": { "type": "number", "description": "The length of a package.", "nullable": false }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package.", "nullable": false }, "width": { "type": "number", "description": "The width of a package.", "nullable": false } }, "required": [ "height", "length", "unitOfMeasurement", "width" ], "nullable": false }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped.", "nullable": false } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`." }, "packageId": { "type": [ "string", "null" ], "description": "Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed" }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ], "nullable": false }, "value": { "type": "number", "description": "Value of a weight.", "nullable": false } }, "required": [ "unit", "value" ], "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false } }, "required": [ "contentInformationSource", "dimensions", "quantity", "weight" ] }, "description": "A list of boxes that will be present in the shipment after the update.", "nullable": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped.", "nullable": false } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "A list of all items that will be present in the shipment after the update.", "nullable": false } }, "required": [ "boxes", "items" ] }, "SpApiGenerateShipmentContentUpdatePreviewsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGenerateShipmentContentUpdatePreviewsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiGenerateShipmentContentUpdatePreviewsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGenerateTransportationOptionsBody": { "type": "object", "properties": { "placementOptionId": { "type": "string", "description": "The placement option to generate transportation options for.", "nullable": false }, "shipmentTransportationConfigurations": { "type": "array", "items": { "type": "object", "properties": { "contactInformation": { "type": [ "object", "null" ], "properties": { "email": { "type": [ "string", "null" ], "description": "The email address." }, "name": { "type": "string", "description": "The contact's name.", "nullable": false }, "phoneNumber": { "type": "string", "description": "The phone number.", "nullable": false } }, "required": [ "name", "phoneNumber" ] }, "freightInformation": { "type": [ "object", "null" ], "properties": { "declaredValue": { "type": [ "object", "null" ], "properties": { "amount": { "type": "number", "description": "Decimal value of the currency.", "nullable": false }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code.", "nullable": false } }, "required": [ "amount", "code" ] }, "freightClass": { "type": [ "string", "null" ], "description": "Freight class. Possible values: `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`." } } }, "pallets": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "dimensions": { "type": [ "object", "null" ], "properties": { "height": { "type": "number", "description": "The height of a package.", "nullable": false }, "length": { "type": "number", "description": "The length of a package.", "nullable": false }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package.", "nullable": false }, "width": { "type": "number", "description": "The width of a package.", "nullable": false } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false }, "stackability": { "type": [ "string", "null" ], "enum": [ "STACKABLE", "NON_STACKABLE" ], "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": [ "object", "null" ], "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ], "nullable": false }, "value": { "type": "number", "description": "Value of a weight.", "nullable": false } }, "required": [ "unit", "value" ] } }, "required": [ "quantity" ] }, "description": "List of pallet configuration inputs." }, "readyToShipWindow": { "type": "object", "properties": { "start": { "type": "string", "description": "The start date of the window. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with minute precision. Supports patterns `yyyy-MM-ddTHH:mmZ`, `yyyy-MM-ddTHH:mm:ssZ`, or `yyyy-MM-ddTHH:mm:ss.sssZ`. Note that non-zero second and millisecond components are removed.", "nullable": false } }, "required": [ "start" ], "description": "List of pallet configuration inputs.", "nullable": false }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded.", "nullable": false } }, "required": [ "readyToShipWindow", "shipmentId" ] }, "description": "List of shipment transportation configurations.", "nullable": false } }, "required": [ "placementOptionId", "shipmentTransportationConfigurations" ] }, "SpApiGenerateTransportationOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGenerateTransportationOptionsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiGenerateTransportationOptionsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetBillOfLadingErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "DownloadURL": { "type": "string", "description": "URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds" } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetBillOfLadingResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "DownloadURL": { "type": "string", "description": "URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds" } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetBillOfLadingSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetCatalogItemErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses returned when a request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiGetCatalogItemResponse": { "type": "object", "properties": { "asin": { "type": "string" }, "attributes": {}, "classifications": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ] }, "description": "Classifications (browse nodes) that are associated with the item in the Amazon catalog." } }, "required": [ "marketplaceId" ] } }, "dimensions": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "item": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } }, "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "package": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } } } }, "required": [ "marketplaceId" ] } }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).identifier." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "identifierType": { "type": "string", "description": "Type of identifier, such as UPC, EAN, or ISBN." }, "identifier": { "type": "string", "description": "Identifier of the item." } }, "required": [ "identifierType", "identifier" ] }, "description": "Identifiers associated with the item in the Amazon catalog for the indicated `marketplaceId`." } }, "required": [ "marketplaceId", "identifiers" ] } }, "images": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "images": { "type": "array", "items": { "type": "object", "properties": { "variant": { "type": "string", "enum": [ "MAIN", "PT01", "PT02", "PT03", "PT04", "PT05", "PT06", "PT07", "PT08", "SWCH" ], "description": "Variant of the image, such as `MAIN` or `PT01`." }, "link": { "type": "string", "description": "URL for the image." }, "height": { "type": "number", "description": "Height of the image in pixels." }, "width": { "type": "number", "description": "Width of the image in pixels." } }, "required": [ "variant", "link", "height", "width" ] }, "description": "Images for an item in the Amazon catalog, grouped by `marketplaceId`." } }, "required": [ "marketplaceId", "images" ] } }, "productTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "productType": { "type": "string", "description": "Name of the product type that is associated with the Amazon catalog item." } } } }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are children of this item." }, "parentAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are parents of this item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "Names of the Amazon catalog item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family." } }, "description": "ASINs of the related items that are parents of this item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "Type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the item." } }, "required": [ "marketplaceId", "relationships" ] } }, "salesRanks": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classificationRanks": { "type": "array", "items": { "type": "object", "properties": { "classificationId": { "type": "string", "description": "Identifier of the classification that is associated with the sales rank." }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales category." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "classificationId", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification." }, "displayGroupRanks": { "type": "array", "items": { "type": "object", "properties": { "websiteDisplayGroup": { "type": "string", "description": "Name of the website display group that is associated with the sales rank" }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales rank." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "websiteDisplayGroup", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group." } }, "required": [ "marketplaceId" ] } }, "summaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "adultProduct": { "type": "boolean", "description": "When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature." }, "autographed": { "type": "boolean", "description": "When `true`, the Amazon catalog item is autographed." }, "brand": { "type": "string", "description": "Name of the brand that is associated with the Amazon catalog item." }, "browseClassification": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ], "description": "Name of the brand that is associated with the Amazon catalog item." }, "color": { "type": "string", "description": "The color that is associated with the Amazon catalog item." }, "contributors": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name of the role in the requested locale, such as `Author` or `Actor`." }, "value": { "type": "string", "description": "Role value for the Amazon catalog item, such as `author` or `actor`." } }, "required": [ "value" ] }, "value": { "type": "string", "description": "Name of the contributor, such as `Jane Austen`." } }, "required": [ "role", "value" ] }, "description": "Individual contributors to the creation of the item, such as the authors or actors." }, "itemClassification": { "type": "string", "enum": [ "BASE_PRODUCT", "OTHER", "PRODUCT_BUNDLE", "VARIATION_PARENT" ], "description": "Classification type that is associated with the Amazon catalog item." }, "itemName": { "type": "string", "description": "The name that is associated with the Amazon catalog item." }, "manufacturer": { "type": "string", "description": "The name of the manufacturer that is associated with the Amazon catalog item." }, "memorabilia": { "type": "boolean", "description": "When true, the item is classified as memorabilia." }, "modelNumber": { "type": "string", "description": "The model number that is associated with the Amazon catalog item." }, "packageQuantity": { "type": "number", "description": "The quantity of the Amazon catalog item within one package." }, "partNumber": { "type": "string", "description": "The part number that is associated with the Amazon catalog item." }, "releaseDate": { "type": "string", "description": "The earliest date on which the Amazon catalog item can be shipped to customers." }, "size": { "type": "string", "description": "The name of the size of the Amazon catalog item." }, "style": { "type": "string", "description": "The name of the style that is associated with the Amazon catalog item." }, "tradeInEligible": { "type": "boolean", "description": "When true, the Amazon catalog item is eligible for trade-in." }, "websiteDisplayGroup": { "type": "string", "description": "The identifier of the website display group that is associated with the Amazon catalog item." }, "websiteDisplayGroupName": { "type": "string", "description": "The display name of the website display group that is associated with the Amazon catalog item." } }, "required": [ "marketplaceId" ] } }, "vendorDetails": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "brandCode": { "type": "string", "description": "The brand code that is associated with an Amazon catalog item." }, "manufacturerCode": { "type": "string", "description": "The manufacturer code that is associated with an Amazon catalog item." }, "manufacturerCodeParent": { "type": "string", "description": "The parent vendor code of the manufacturer code." }, "productCategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The parent vendor code of the manufacturer code." }, "productGroup": { "type": "string", "description": "The product group that is associated with an Amazon catalog item." }, "productSubcategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The product group that is associated with an Amazon catalog item." }, "replenishmentCategory": { "type": "string", "enum": [ "ALLOCATED", "BASIC_REPLENISHMENT", "IN_SEASON", "LIMITED_REPLENISHMENT", "MANUFACTURER_OUT_OF_STOCK", "NEW_PRODUCT", "NON_REPLENISHABLE", "NON_STOCKUPABLE", "OBSOLETE", "PLANNED_REPLENISHMENT" ], "description": "The replenishment category that is associated with an Amazon catalog item." } }, "required": [ "marketplaceId" ] } } }, "required": [ "asin" ] }, "SpApiGetCatalogItemSearchParams": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" } }, "includedData": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "images", "attributes", "classifications", "dimensions", "identifiers", "productTypes", "relationships", "salesRanks", "summaries", "vendorDetails" ] } } ] }, "locale": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceIds", "mp" ] }, "SpApiGetCompetitiveSummaryBody": { "type": "object", "properties": { "requests": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "nullable": false }, "marketplaceId": { "type": "string", "nullable": false }, "includedData": { "type": "array", "items": { "type": "string", "enum": [ "featuredBuyingOptions", "referencePrices", "lowestPricedOffers", "similarItems" ] }, "description": "The list of requested competitive pricing data for the product.", "nullable": false }, "lowestPricedOffersInputs": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "itemCondition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ], "nullable": false }, "offerType": { "type": "string", "enum": [ "Consumer" ], "description": "The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`.", "nullable": false } }, "required": [ "itemCondition", "offerType" ] }, "description": "The list of `lowestPricedOffersInput` parameters that are used to build `lowestPricedOffers` in the response. This attribute is only valid if `lowestPricedOffers` is requested in `includedData`" }, "method": { "type": "string", "enum": [ "GET", "PUT", "PATCH", "DELETE", "POST" ], "description": "The list of `lowestPricedOffersInput` parameters that are used to build `lowestPricedOffers` in the response. This attribute is only valid if `lowestPricedOffers` is requested in `includedData`", "nullable": false }, "uri": { "type": "string", "nullable": false } }, "required": [ "asin", "marketplaceId", "includedData", "method", "uri" ] }, "nullable": false } }, "required": [ "requests" ] }, "SpApiGetCompetitiveSummaryErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } }, "required": [ "errors" ] }, "SpApiGetCompetitiveSummaryResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "The HTTP response status code." }, "reasonPhrase": { "type": "string", "description": "The HTTP response reason phrase." } } }, "body": { "type": "object", "properties": { "asin": { "type": "string" }, "marketplaceId": { "type": "string" }, "featuredBuyingOptions": { "type": "array", "items": { "type": "object", "properties": { "buyingOptionType": { "type": "string", "enum": [ "New" ], "description": "The buying option type for the featured offer. `buyingOptionType` represents the buying options that a customer receives on the detail page, such as `B2B`, `Fresh`, and `Subscribe n Save`. `buyingOptionType` currently supports `NEW` as a value." }, "segmentedFeaturedOffers": { "type": "array", "items": { "type": "object", "properties": {} }, "description": "A list of segmented featured offers for the current buying option type. A segment can be considered as a group of regional contexts that all have the same featured offer. A regional context is a combination of factors such as customer type, region, or postal code and buying option." } }, "required": [ "buyingOptionType", "segmentedFeaturedOffers" ] }, "description": "A list of featured buying options for the specified ASIN `marketplaceId` combination." }, "lowestPricedOffers": { "type": "array", "items": { "type": "object", "properties": { "lowestPricedOffersInput": { "type": "object", "properties": { "itemCondition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ] }, "offerType": { "type": "string", "enum": [ "Consumer" ], "description": "The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`." } }, "required": [ "itemCondition", "offerType" ] }, "offers": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string", "description": "The seller identifier for the offer." }, "condition": { "type": "string", "enum": [ "New", "Used", "Collectible", "Refurbished", "Club" ], "description": "The seller identifier for the offer." }, "subCondition": { "type": "string", "enum": [ "New", "Mint", "VeryGood", "Good", "Acceptable", "Poor", "Club", "OEM", "Warranty", "RefurbishedWarranty", "Refurbished", "OpenBox", "Other" ], "description": "The item subcondition of the offer." }, "fulfillmentType": { "type": "string", "enum": [ "AFN", "MFN" ], "description": "The item subcondition of the offer." }, "listingPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "shippingOptions": { "type": "array", "items": { "type": "object", "properties": { "shippingOptionType": { "type": "string", "enum": [ "DEFAULT" ], "description": "The type of shipping option." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of shipping option." } }, "required": [ "shippingOptionType", "price" ] }, "description": "A list of shipping options associated with this offer" }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points." }, "pointsMonetaryValue": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points." } }, "description": "A list of shipping options associated with this offer" }, "primeDetails": { "type": "object", "properties": { "eligibility": { "type": "string", "enum": [ "NATIONAL", "REGIONAL", "NONE" ], "description": "Indicates whether the offer is an Amazon Prime offer." } }, "required": [ "eligibility" ] }, "promotions": { "type": "array", "items": { "type": "object", "properties": { "promotionType": { "type": "string" }, "promotionSavings": { "type": "object", "properties": { "discount": { "type": "object", "properties": { "type": { "type": "string" }, "amountOff": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } }, "percentOff": { "type": "number", "description": "The percentage discount applied to the original price (1-100). Only valid when type is PERCENTAGE_OFF." } } }, "discountedPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } } } } }, "purchaseRequirements": { "type": "object", "properties": { "condition": { "type": "object", "properties": { "quantityThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the quantity requirement is evaluated. Possible values include: - AT_LEAST: The customer must purchase at least the specified quantity of items to qualify for the benefit. - FOR_EACH: The benefit applies for every group of the specified quantity purchased (for example, the discount applies for each set of 2 items purchased)." }, "quantity": { "type": "number", "description": "Number of items required to meet this purchase condition." } }, "required": [ "type", "quantity" ] }, "amountThreshold": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." }, "currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Indicates how the amount requirement is evaluated. For spend-based conditions, the supported value is AT_LEAST, meaning the customer must spend at least the specified dollar amount to qualify." } }, "required": [ "type", "currency" ] } } } } } }, "required": [ "promotionType", "promotionSavings" ] } } }, "required": [ "sellerId", "condition", "fulfillmentType", "listingPrice" ] }, "description": "A list of up to 20 lowest priced offers that match the criteria specified in `lowestPricedOffersInput`." } }, "required": [ "lowestPricedOffersInput", "offers" ] }, "description": "A list of lowest priced offers for the specified ASIN `marketplaceId` combination." }, "referencePrices": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "amount": { "type": "number", "description": "The monetary value." } }, "description": "Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, refer to the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api)." } }, "required": [ "name", "price" ] }, "description": "A list of reference prices for the specified ASIN `marketplaceId` combination." }, "similarItems": { "type": "array", "items": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" } }, "required": [ "asin" ] }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." } } }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of similar items for the specified ASIN `marketplaceId` combination." } }, "required": [ "asin", "marketplaceId" ] } }, "required": [ "status", "body" ] } } }, "required": [ "responses" ] }, "SpApiGetCompetitiveSummarySearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetDefinitionsProductTypeErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses." } }, "required": [ "errors" ] }, "SpApiGetDefinitionsProductTypeResponse": { "type": "object", "properties": { "metaSchema": { "type": "object", "properties": { "link": { "type": "object", "properties": { "resource": { "type": "string", "description": "URI resource for the link." }, "verb": { "type": "string", "enum": [ "GET" ], "description": "HTTP method for the link operation." } }, "required": [ "resource", "verb" ], "description": "Link to retrieve the schema." }, "checksum": { "type": "string", "description": "Checksum hash of the schema (Base64 MD5). Use this to verify schema contents, identify changes between schema versions, and for caching." } }, "required": [ "link", "checksum" ] }, "schema": { "type": "object", "properties": { "link": { "type": "object", "properties": { "resource": { "type": "string", "description": "URI resource for the link." }, "verb": { "type": "string", "enum": [ "GET" ], "description": "HTTP method for the link operation." } }, "required": [ "resource", "verb" ], "description": "Link to retrieve the schema." }, "checksum": { "type": "string", "description": "Checksum hash of the schema (Base64 MD5). Use this to verify schema contents, identify changes between schema versions, and for caching." } }, "required": [ "link", "checksum" ] }, "requirements": { "type": "string", "enum": [ "LISTING", "LISTING_PRODUCT_ONLY", "LISTING_OFFER_ONLY" ], "description": "Name of the requirements set represented in this product type definition." }, "requirementsEnforced": { "type": "string", "enum": [ "ENFORCED", "NOT_ENFORCED" ], "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)." }, "propertyGroups": { "description": "Mapping of property group names to property groups. Property groups represent logical groupings of schema properties that can be used for display or informational purposes." }, "locale": { "type": "string", "description": "Locale of the display elements contained in the product type definition." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "Amazon marketplace identifiers for which the product type definition is applicable." }, "productType": { "type": "string", "description": "The name of the Amazon product type that this product type definition applies to." }, "displayName": { "type": "string", "description": "Human-readable and localized description of the Amazon product type." }, "productTypeVersion": { "type": "object", "properties": { "version": { "type": "string", "description": "Version identifier." }, "latest": { "type": "boolean", "description": "When true, the version indicated by the version identifier is the latest available for the Amazon product type." }, "releaseCandidate": { "type": "boolean", "description": "When true, the version indicated by the version identifier is the prerelease (release candidate) for the Amazon product type." } }, "required": [ "version", "latest" ], "description": "Human-readable and localized description of the Amazon product type." } }, "required": [ "schema", "requirements", "requirementsEnforced", "propertyGroups", "locale", "marketplaceIds", "productType", "displayName", "productTypeVersion" ] }, "SpApiGetDefinitionsProductTypeSearchParams": { "type": "object", "properties": { "sellerId": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "marketplaceIds": { "type": "array", "items": { "type": "string" } }, "productTypeVersion": { "type": "object" }, "requirements": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "LISTING" ] }, { "type": "string", "enum": [ "LISTING_PRODUCT_ONLY" ] }, { "type": "string", "enum": [ "LISTING_OFFER_ONLY" ] } ] }, "requirementsEnforced": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ENFORCED" ] }, { "type": "string", "enum": [ "NOT_ENFORCED" ] } ] }, "locale": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "DEFAULT" ] }, { "type": "string", "enum": [ "ar" ] }, { "type": "string", "enum": [ "ar_AE" ] }, { "type": "string", "enum": [ "de" ] }, { "type": "string", "enum": [ "de_DE" ] }, { "type": "string", "enum": [ "en" ] }, { "type": "string", "enum": [ "en_AE" ] }, { "type": "string", "enum": [ "en_AU" ] }, { "type": "string", "enum": [ "en_CA" ] }, { "type": "string", "enum": [ "en_GB" ] }, { "type": "string", "enum": [ "en_IN" ] }, { "type": "string", "enum": [ "en_SG" ] }, { "type": "string", "enum": [ "en_US" ] }, { "type": "string", "enum": [ "es" ] }, { "type": "string", "enum": [ "es_ES" ] }, { "type": "string", "enum": [ "es_MX" ] }, { "type": "string", "enum": [ "es_US" ] }, { "type": "string", "enum": [ "fr" ] }, { "type": "string", "enum": [ "fr_CA" ] }, { "type": "string", "enum": [ "fr_FR" ] }, { "type": "string", "enum": [ "it" ] }, { "type": "string", "enum": [ "it_IT" ] }, { "type": "string", "enum": [ "ja" ] }, { "type": "string", "enum": [ "ja_JP" ] }, { "type": "string", "enum": [ "nl" ] }, { "type": "string", "enum": [ "nl_NL" ] }, { "type": "string", "enum": [ "pl" ] }, { "type": "string", "enum": [ "pl_PL" ] }, { "type": "string", "enum": [ "pt" ] }, { "type": "string", "enum": [ "pt_BR" ] }, { "type": "string", "enum": [ "pt_PT" ] }, { "type": "string", "enum": [ "sv" ] }, { "type": "string", "enum": [ "sv_SE" ] }, { "type": "string", "enum": [ "tr" ] }, { "type": "string", "enum": [ "tr_TR" ] }, { "type": "string", "enum": [ "zh" ] }, { "type": "string", "enum": [ "zh_CN" ] }, { "type": "string", "enum": [ "zh_TW" ] } ] }, "parentageLevel": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "NONE" ] }, { "type": "string", "enum": [ "CHILD" ] }, { "type": "string", "enum": [ "PARENT" ] } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceIds", "mp" ] }, "SpApiGetDeliveryChallanDocumentErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGetDeliveryChallanDocumentResponse": { "type": "object", "properties": { "documentDownload": { "type": "object", "properties": { "downloadType": { "type": "string", "description": "The type of download. Possible values: `URL`." }, "expiration": { "type": "string", "description": "The URI's expiration time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "uri": { "type": "string", "description": "Uniform resource identifier to identify where the document is located." } }, "required": [ "downloadType", "uri" ] } }, "required": [ "documentDownload" ] }, "SpApiGetDeliveryChallanDocumentSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetDestinationErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } }, "description": "The destination identifier generated when you created the destination." } }, "required": [ "name", "destinationId", "resource" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetDestinationResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "name": { "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } }, "description": "The destination identifier generated when you created the destination." } }, "required": [ "name", "destinationId", "resource" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetDestinationSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetDestinationsErrorResponse": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } }, "description": "The destination identifier generated when you created the destination." } }, "required": [ "name", "destinationId", "resource" ] } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetDestinationsResponse": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "type": "object", "properties": { "sqs": { "type": "object", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "required": [ "arn" ] }, "eventBridge": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "The AWS region in which you receive the notifications. For AWS regions that Amazon EventBridge supports, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "required": [ "name", "region", "accountId" ] } }, "description": "The destination identifier generated when you created the destination." } }, "required": [ "name", "destinationId", "resource" ] } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetDestinationsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetFeaturedOfferExpectedPriceBatchBody": { "type": "object", "properties": { "requests": { "type": [ "array", "null" ], "items": { "type": "object", "properties": {} } } } }, "SpApiGetFeaturedOfferExpectedPriceBatchErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } }, "required": [ "errors" ] }, "SpApiGetFeaturedOfferExpectedPriceBatchResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "SpApiGetFeaturedOfferExpectedPriceBatchSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetInboundOperationStatusErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGetInboundOperationStatusResponse": { "type": "object", "properties": { "operation": { "type": "string", "description": "The name of the operation in the asynchronous API call." }, "operationId": { "type": "string", "description": "The operation ID returned by the asynchronous API call." }, "operationProblems": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "severity": { "type": "string", "description": "The severity of the problem. Possible values: `WARNING`, `ERROR`." } }, "required": [ "code", "message", "severity" ] }, "description": "The problems in the processing of the asynchronous operation." }, "operationStatus": { "type": "string", "enum": [ "SUCCESS", "FAILED", "IN_PROGRESS" ], "description": "The problems in the processing of the asynchronous operation." } }, "required": [ "operation", "operationId", "operationProblems", "operationStatus" ] }, "SpApiGetInboundOperationStatusSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetInboundPlanErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGetInboundPlanResponse": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "The time at which the inbound plan was created. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "inboundPlanId": { "type": "string", "description": "Identifier of an inbound plan." }, "lastUpdatedAt": { "type": "string", "description": "The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace IDs." }, "name": { "type": "string", "description": "Human-readable name of the inbound plan." }, "packingOptions": { "type": "array", "items": { "type": "object", "properties": { "packingOptionId": { "type": "string", "description": "Identifier of a packing option." }, "status": { "type": "string", "description": "The status of a packing option. Possible values: 'OFFERED', 'ACCEPTED', 'EXPIRED'." } }, "required": [ "packingOptionId", "status" ] }, "description": "Packing options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, only packing options for that placement option will be returned. If there are confirmed shipments, only packing options for those shipments will be returned. Query the packing option for more details." }, "placementOptions": { "type": "array", "items": { "type": "object", "properties": { "placementOptionId": { "type": "string", "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "status": { "type": "string", "description": "The status of a placement option. Possible values: `OFFERED`, `ACCEPTED`." } }, "required": [ "placementOptionId", "status" ] }, "description": "Placement options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, that will be the only returned option. Query the placement option for more details." }, "shipments": { "type": "array", "items": { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "status": { "type": "string", "description": "The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`" } }, "required": [ "shipmentId", "status" ] }, "description": "A list of shipment IDs for the inbound plan. This property is populated when it has been generated with the `confirmPlacementOptions` operation. Only shipments from the chosen placement option are returned. Query the shipment for more details." }, "sourceAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ], "description": "A list of shipment IDs for the inbound plan. This property is populated when it has been generated with the `confirmPlacementOptions` operation. Only shipments from the chosen placement option are returned. Query the shipment for more details." }, "status": { "type": "string", "description": "Current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`." } }, "required": [ "createdAt", "inboundPlanId", "lastUpdatedAt", "marketplaceIds", "name", "sourceAddress", "status" ] }, "SpApiGetInboundPlanSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetInventorySummariesErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "granularity": { "type": "object", "properties": { "granularityType": { "type": "string", "description": "The granularity type for the inventory aggregation level." }, "granularityId": { "type": "string", "description": "The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId." } } }, "inventorySummaries": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } } } } }, "required": [ "granularity", "inventorySummaries" ] }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "SpApiGetInventorySummariesResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "granularity": { "type": "object", "properties": { "granularityType": { "type": "string", "description": "The granularity type for the inventory aggregation level." }, "granularityId": { "type": "string", "description": "The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId." } } }, "inventorySummaries": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } } } } }, "required": [ "granularity", "inventorySummaries" ] }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "SpApiGetItemEligibilityPreviewErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "asin": { "type": "string", "description": "The ASIN for which eligibility was determined." }, "marketplaceId": { "type": "string", "description": "The marketplace for which eligibility was determined." }, "program": { "type": "string", "enum": [ "INBOUND", "COMMINGLING" ], "description": "The program for which eligibility was determined." }, "isEligibleForProgram": { "type": "boolean", "description": "Indicates if the item is eligible for the program." }, "ineligibilityReasonList": { "type": "array", "items": { "type": "object" }, "description": "Potential Ineligibility Reason Codes." } }, "required": [ "asin", "program", "isEligibleForProgram" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "SpApiGetItemEligibilityPreviewResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "asin": { "type": "string", "description": "The ASIN for which eligibility was determined." }, "marketplaceId": { "type": "string", "description": "The marketplace for which eligibility was determined." }, "program": { "type": "string", "enum": [ "INBOUND", "COMMINGLING" ], "description": "The program for which eligibility was determined." }, "isEligibleForProgram": { "type": "boolean", "description": "Indicates if the item is eligible for the program." }, "ineligibilityReasonList": { "type": "array", "items": { "type": "object" }, "description": "Potential Ineligibility Reason Codes." } }, "required": [ "asin", "program", "isEligibleForProgram" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional information that can help the caller understand or fix the issue." } }, "required": [ "code" ] } } } }, "SpApiGetItemEligibilityPreviewSearchParams": { "type": "object", "properties": { "marketplaceIds": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "asin": { "type": "string" }, "program": { "type": "string", "enum": [ "INBOUND", "COMMINGLING" ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "asin", "program", "mp" ] }, "SpApiGetLabelsErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "DownloadURL": { "type": "string", "description": "URL to download the label for the package. Note: The URL will only be valid for 15 seconds" } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetLabelsResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "DownloadURL": { "type": "string", "description": "URL to download the label for the package. Note: The URL will only be valid for 15 seconds" } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetLabelsSearchParams": { "type": "object", "properties": { "PageType": { "type": "string", "enum": [ "PackageLabel_Letter_2", "PackageLabel_Letter_4", "PackageLabel_Letter_6", "PackageLabel_Letter_6_CarrierLeft", "PackageLabel_A4_2", "PackageLabel_A4_4", "PackageLabel_Plain_Paper", "PackageLabel_Plain_Paper_CarrierBottom", "PackageLabel_Thermal", "PackageLabel_Thermal_Unified", "PackageLabel_Thermal_NonPCP", "PackageLabel_Thermal_No_Carrier_Rotation" ] }, "LabelType": { "type": "string", "enum": [ "BARCODE_2D", "UNIQUE", "PALLET" ] }, "NumberOfPackages": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "PackageLabelsToPrint": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "NumberOfPallets": { "type": "object" }, "PageSize": { "type": "object" }, "PageStartIndex": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "PageType", "LabelType", "mp" ] }, "SpApiGetListingsItemErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses." } }, "required": [ "errors" ] }, "SpApiGetListingsItemResponse": { "type": "object", "properties": { "sku": { "type": "string", "description": "A selling partner-provided identifier for an Amazon listing." }, "summaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "A marketplace identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." }, "productType": { "type": "string", "description": "The listings item's Amazon product type." }, "conditionType": { "type": "string", "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" ], "description": "Identifies the condition of the listings item." }, "status": { "type": "array", "items": { "type": "object" }, "description": "Statuses that apply to the listings item." }, "fnSku": { "type": "string", "description": "Fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item." }, "itemName": { "type": "string", "description": "Name, or title, associated with an Amazon catalog item." }, "createdDate": { "type": "string", "description": "Date the listings item was created, in ISO 8601 format." }, "lastUpdatedDate": { "type": "string", "description": "Date the listings item was last updated, in ISO 8601 format." }, "mainImage": { "type": "object", "properties": { "link": { "type": "string", "description": "The image's link or URL." }, "height": { "type": "number", "description": "The image's height, in pixels." }, "width": { "type": "number", "description": "The image's width, in pixels." } }, "required": [ "link", "height", "width" ], "description": "Date the listings item was last updated, in ISO 8601 format." } }, "required": [ "marketplaceId", "productType", "status", "createdDate", "lastUpdatedDate" ] }, "description": "A selling partner-provided identifier for an Amazon listing." }, "attributes": {}, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] } }, "offers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "offerType": { "type": "string", "enum": [ "B2C", "B2B" ], "description": "The listings item's offer type." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ], "description": "The listings item's offer type." }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points offered with the purchase of an item, and their monetary value." } }, "required": [ "pointsNumber" ] }, "audience": { "type": "object", "properties": { "value": { "type": "string", "description": "Name of the audience an offer is applicable to. Common values: * 'ALL' - Standard offer audience for buyers on Amazon retail websites. * 'B2B' - Offer audience for Amazon Business website buyers." }, "displayName": { "type": "string", "description": "Localized display name for the audience." } } } }, "required": [ "marketplaceId", "offerType", "price" ] } }, "fulfillmentAvailability": { "type": "array", "items": { "type": "object", "properties": { "fulfillmentChannelCode": { "type": "string", "description": "Designates which fulfillment network is used." }, "quantity": { "type": "number", "description": "The item quantity that you're making available for sale." } }, "required": [ "fulfillmentChannelCode" ] }, "description": "The listings item's fulfillment availability." }, "procurement": { "type": "array", "items": { "type": "object", "properties": { "costPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ] } }, "required": [ "costPrice" ] }, "description": "The listings item's vendor procurement information." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are children of this listing item." }, "parentSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "The names of the listing item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "The variation theme that indicates the combination of listing item attributes that define the variation family." } }, "required": [ "attributes", "theme" ], "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "The type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the listing item." } }, "required": [ "marketplaceId", "relationships" ] }, "description": "The listings item's vendor procurement information." }, "productTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "productType": { "type": "string", "description": "The name of the product type that is submitted by the Selling Partner." } }, "required": [ "marketplaceId", "productType" ] } } }, "required": [ "sku" ] }, "SpApiGetListingsItemSearchParams": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" } }, "issueLocale": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "includedData": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "attributes", "productTypes", "relationships", "summaries", "issues", "offers", "fulfillmentAvailability", "procurement" ] } } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceIds", "mp" ] }, "SpApiGetListingsRestrictionsErrorResponse": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } }, "SpApiGetListingsRestrictionsResponse": { "type": "object", "properties": { "restrictions": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "A marketplace identifier. Identifies the Amazon marketplace where the restriction is enforced." }, "conditionType": { "type": "string", "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" ], "description": "The condition that applies to the restriction." }, "reasons": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "description": "A message describing the reason for the restriction." }, "reasonCode": { "type": "string", "enum": [ "APPROVAL_REQUIRED", "ASIN_NOT_FOUND", "NOT_ELIGIBLE" ], "description": "A code indicating why the listing is restricted." }, "links": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string", "description": "The URI of the related resource." }, "verb": { "type": "string", "enum": [ "GET" ], "description": "The HTTP verb used to interact with the related resource." }, "title": { "type": "string", "description": "The title of the related resource." }, "type": { "type": "string", "description": "The media type of the related resource." } }, "required": [ "resource", "verb" ] }, "description": "A list of path forward links that may allow Selling Partners to remove the restriction." } }, "required": [ "message" ] }, "description": "A list of reasons for the restriction." } }, "required": [ "marketplaceId" ] }, "description": "A list of restrictions." } }, "required": [ "restrictions" ] }, "SpApiGetListingsRestrictionsSearchParams": { "type": "object", "properties": { "asin": { "type": "string" }, "conditionType": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "new_new" ] }, { "type": "string", "enum": [ "new_open_box" ] }, { "type": "string", "enum": [ "new_oem" ] }, { "type": "string", "enum": [ "refurbished_refurbished" ] }, { "type": "string", "enum": [ "used_like_new" ] }, { "type": "string", "enum": [ "used_very_good" ] }, { "type": "string", "enum": [ "used_good" ] }, { "type": "string", "enum": [ "used_acceptable" ] }, { "type": "string", "enum": [ "collectible_like_new" ] }, { "type": "string", "enum": [ "collectible_very_good" ] }, { "type": "string", "enum": [ "collectible_good" ] }, { "type": "string", "enum": [ "collectible_acceptable" ] }, { "type": "string", "enum": [ "club_club" ] } ] }, "sellerId": { "type": "string" }, "marketplaceIds": { "type": "array", "items": { "type": "string" } }, "reasonLocale": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "productType": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "asin", "sellerId", "marketplaceIds", "mp" ] }, "SpApiGetMyFeesEstimateForASINBody": { "type": "object", "properties": { "FeesEstimateRequest": { "type": [ "object", "null" ], "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier.", "nullable": false }, "IsAmazonFulfilled": { "type": [ "boolean", "null" ], "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "nullable": false }, "Shipping": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } } }, "Points": { "type": [ "object", "null" ], "properties": { "PointsNumber": { "type": [ "number", "null" ], "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon.", "nullable": false }, "Identifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request.", "nullable": false }, "OptionalFulfillmentProgram": { "type": [ "string", "null" ], "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "required": [ "MarketplaceId", "PriceToEstimateFees", "Identifier" ] } } }, "SpApiGetMyFeesEstimateForASINErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "FeesEstimateResult": { "type": "object", "properties": { "Status": { "type": "string", "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimateIdentifier": { "type": "object", "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier." }, "SellerId": { "type": "string", "description": "The seller identifier." }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "description": "The seller identifier." }, "IdValue": { "type": "string", "description": "The item identifier." }, "IsAmazonFulfilled": { "type": "boolean", "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Shipping": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Points": { "type": "object", "properties": { "PointsNumber": { "type": "number", "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon." }, "SellerInputIdentifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request." }, "OptionalFulfillmentProgram": { "type": "string", "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimate": { "type": "object", "properties": { "TimeOfFeesEstimation": { "type": "string", "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "TotalFeesEstimate": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "FeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "TimeOfFeesEstimation" ] }, "Error": { "type": "object", "properties": { "Type": { "type": "string", "description": "An error type, identifying either the receiver or the sender as the originator of the error." }, "Code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "Message": { "type": "string", "description": "A message that describes the error condition." }, "Detail": { "type": "array", "items": { "type": "object" }, "description": "A message that describes the error condition." } }, "required": [ "Type", "Code", "Message", "Detail" ] } } } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetMyFeesEstimateForASINResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "FeesEstimateResult": { "type": "object", "properties": { "Status": { "type": "string", "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimateIdentifier": { "type": "object", "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier." }, "SellerId": { "type": "string", "description": "The seller identifier." }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "description": "The seller identifier." }, "IdValue": { "type": "string", "description": "The item identifier." }, "IsAmazonFulfilled": { "type": "boolean", "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Shipping": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Points": { "type": "object", "properties": { "PointsNumber": { "type": "number", "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon." }, "SellerInputIdentifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request." }, "OptionalFulfillmentProgram": { "type": "string", "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimate": { "type": "object", "properties": { "TimeOfFeesEstimation": { "type": "string", "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "TotalFeesEstimate": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "FeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "TimeOfFeesEstimation" ] }, "Error": { "type": "object", "properties": { "Type": { "type": "string", "description": "An error type, identifying either the receiver or the sender as the originator of the error." }, "Code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "Message": { "type": "string", "description": "A message that describes the error condition." }, "Detail": { "type": "array", "items": { "type": "object" }, "description": "A message that describes the error condition." } }, "required": [ "Type", "Code", "Message", "Detail" ] } } } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetMyFeesEstimateForASINSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetMyFeesEstimateForSKUBody": { "type": "object", "properties": { "FeesEstimateRequest": { "type": [ "object", "null" ], "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier.", "nullable": false }, "IsAmazonFulfilled": { "type": [ "boolean", "null" ], "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "nullable": false }, "Shipping": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } } }, "Points": { "type": [ "object", "null" ], "properties": { "PointsNumber": { "type": [ "number", "null" ], "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon.", "nullable": false }, "Identifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request.", "nullable": false }, "OptionalFulfillmentProgram": { "type": [ "string", "null" ], "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "required": [ "MarketplaceId", "PriceToEstimateFees", "Identifier" ] } } }, "SpApiGetMyFeesEstimateForSKUErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "FeesEstimateResult": { "type": "object", "properties": { "Status": { "type": "string", "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimateIdentifier": { "type": "object", "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier." }, "SellerId": { "type": "string", "description": "The seller identifier." }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "description": "The seller identifier." }, "IdValue": { "type": "string", "description": "The item identifier." }, "IsAmazonFulfilled": { "type": "boolean", "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Shipping": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Points": { "type": "object", "properties": { "PointsNumber": { "type": "number", "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon." }, "SellerInputIdentifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request." }, "OptionalFulfillmentProgram": { "type": "string", "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimate": { "type": "object", "properties": { "TimeOfFeesEstimation": { "type": "string", "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "TotalFeesEstimate": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "FeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "TimeOfFeesEstimation" ] }, "Error": { "type": "object", "properties": { "Type": { "type": "string", "description": "An error type, identifying either the receiver or the sender as the originator of the error." }, "Code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "Message": { "type": "string", "description": "A message that describes the error condition." }, "Detail": { "type": "array", "items": { "type": "object" }, "description": "A message that describes the error condition." } }, "required": [ "Type", "Code", "Message", "Detail" ] } } } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetMyFeesEstimateForSKUResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "FeesEstimateResult": { "type": "object", "properties": { "Status": { "type": "string", "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimateIdentifier": { "type": "object", "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier." }, "SellerId": { "type": "string", "description": "The seller identifier." }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "description": "The seller identifier." }, "IdValue": { "type": "string", "description": "The item identifier." }, "IsAmazonFulfilled": { "type": "boolean", "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Shipping": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Points": { "type": "object", "properties": { "PointsNumber": { "type": "number", "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon." }, "SellerInputIdentifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request." }, "OptionalFulfillmentProgram": { "type": "string", "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimate": { "type": "object", "properties": { "TimeOfFeesEstimation": { "type": "string", "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "TotalFeesEstimate": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "FeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "TimeOfFeesEstimation" ] }, "Error": { "type": "object", "properties": { "Type": { "type": "string", "description": "An error type, identifying either the receiver or the sender as the originator of the error." }, "Code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "Message": { "type": "string", "description": "A message that describes the error condition." }, "Detail": { "type": "array", "items": { "type": "object" }, "description": "A message that describes the error condition." } }, "required": [ "Type", "Code", "Message", "Detail" ] } } } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetMyFeesEstimateForSKUSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetMyFeesEstimatesBody": { "type": "array", "items": { "type": "object", "properties": { "FeesEstimateRequest": { "type": [ "object", "null" ], "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier.", "nullable": false }, "IsAmazonFulfilled": { "type": [ "boolean", "null" ], "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "nullable": false }, "Shipping": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } } }, "Points": { "type": [ "object", "null" ], "properties": { "PointsNumber": { "type": [ "number", "null" ], "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": [ "object", "null" ], "properties": { "CurrencyCode": { "type": [ "string", "null" ], "description": "The currency code in ISO 4217 format." }, "Amount": { "type": [ "number", "null" ], "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon.", "nullable": false }, "Identifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request.", "nullable": false }, "OptionalFulfillmentProgram": { "type": [ "string", "null" ], "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "required": [ "MarketplaceId", "PriceToEstimateFees", "Identifier" ] }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "nullable": false }, "IdValue": { "type": "string", "description": "The item identifier.", "nullable": false } }, "required": [ "IdType", "IdValue" ] } }, "SpApiGetMyFeesEstimatesErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses returned when a request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiGetMyFeesEstimatesResponse": { "type": "array", "items": { "type": "object", "properties": { "Status": { "type": "string", "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimateIdentifier": { "type": "object", "properties": { "MarketplaceId": { "type": "string", "description": "A marketplace identifier." }, "SellerId": { "type": "string", "description": "The seller identifier." }, "IdType": { "type": "string", "enum": [ "ASIN", "SellerSKU" ], "description": "The seller identifier." }, "IdValue": { "type": "string", "description": "The item identifier." }, "IsAmazonFulfilled": { "type": "boolean", "description": "When true, the offer is fulfilled by Amazon." }, "PriceToEstimateFees": { "type": "object", "properties": { "ListingPrice": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Shipping": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "Points": { "type": "object", "properties": { "PointsNumber": { "type": "number", "description": "The number of Amazon Points" }, "PointsMonetaryValue": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The number of Amazon Points" } } } }, "required": [ "ListingPrice" ], "description": "When true, the offer is fulfilled by Amazon." }, "SellerInputIdentifier": { "type": "string", "description": "A unique identifier provided by the caller to track this request." }, "OptionalFulfillmentProgram": { "type": "string", "enum": [ "FBA_CORE", "FBA_SNL", "FBA_EFN" ], "description": "A unique identifier provided by the caller to track this request." } }, "description": "The status of the fee request. Possible values: Success, ClientError, ServiceError." }, "FeesEstimate": { "type": "object", "properties": { "TimeOfFeesEstimation": { "type": "string", "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "TotalFeesEstimate": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The time at which the fees were estimated. This defaults to the time the request is made." }, "FeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "IncludedFeeDetailList": { "type": "array", "items": { "type": "object", "properties": { "FeeType": { "type": "string", "description": "The type of fee charged to a seller." }, "FeeAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } }, "description": "The type of fee charged to a seller." }, "FeePromotion": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "TaxAmount": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } }, "FinalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "description": "The currency code in ISO 4217 format." }, "Amount": { "type": "number", "description": "The monetary value." } } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "FeeType", "FeeAmount", "FinalFee" ] } } }, "required": [ "TimeOfFeesEstimation" ] }, "Error": { "type": "object", "properties": { "Type": { "type": "string", "description": "An error type, identifying either the receiver or the sender as the originator of the error." }, "Code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "Message": { "type": "string", "description": "A message that describes the error condition." }, "Detail": { "type": "array", "items": { "type": "object" }, "description": "A message that describes the error condition." } }, "required": [ "Type", "Code", "Message", "Detail" ] } } } }, "SpApiGetMyFeesEstimatesSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetOrderErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of errors." } }, "required": [ "errors" ] }, "SpApiGetOrderResponse": { "type": "object", "properties": { "order": { "type": "object", "properties": { "orderId": { "type": "string", "description": "An Amazon-defined order identifier." }, "orderAliases": { "type": "array", "items": { "type": "object", "properties": { "aliasId": { "type": "string", "description": "The alternative identifier value that can be used to reference this order." }, "aliasType": { "type": "string", "description": "The kind of alternative identifier this represents. **Possible values**: `SELLER_ORDER_ID`" } }, "required": [ "aliasId", "aliasType" ] }, "description": "Alternative identifiers that can be used to reference this order, such as seller-defined order numbers." }, "createdTime": { "type": "string", "description": "The time when the customer placed the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "lastUpdatedTime": { "type": "string", "description": "The most recent time when any aspect of this order was modified by Amazon or the seller. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "programs": { "type": "array", "items": { "type": "string" }, "description": "Special programs associated with this order that may affect fulfillment or customer experience. **Possible values**: `AMAZON_BAZAAR`, `AMAZON_BUSINESS`, `AMAZON_EASY_SHIP`, `AMAZON_HAUL`, `DELIVERY_BY_AMAZON`, `FBM_SHIP_PLUS`, `INVOICE_BY_AMAZON`, `IN_STORE_PICK_UP`, `PREMIUM`, `PREORDER`, `PRIME`" }, "associatedOrders": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The unique identifier of the related order that is associated with the current order." }, "associationType": { "type": "string", "description": "The relationship between the current order and the associated order. **Possible values**: `REPLACEMENT_ORIGINAL_ID`, `EXCHANGE_ORIGINAL_ID`" } } }, "description": "Other orders that have a direct relationship to this order, such as replacement or exchange orders." }, "salesChannel": { "type": "object", "properties": { "channelName": { "type": "string", "description": "The name of the sales platform or channel where the customer placed this order. **Possible values**: `AMAZON`, `NON_AMAZON`" }, "marketplaceId": { "type": "string", "description": "The unique identifier for the specific marketplace within the sales channel where this order was placed." }, "marketplaceName": { "type": "string", "description": "The human-readable name of the marketplace where this order was placed." } }, "required": [ "channelName" ], "description": "Other orders that have a direct relationship to this order, such as replacement or exchange orders." }, "buyer": { "type": "object", "properties": { "buyerName": { "type": "string", "description": "The full name of the customer who placed the order." }, "buyerEmail": { "type": "string", "description": "The anonymized email address of the buyer. **Note:** Only available for merchant-fulfilled (FBM) orders." }, "buyerCompanyName": { "type": "string", "description": "The name of the company or organization for a business order." }, "buyerPurchaseOrderNumber": { "type": "string", "description": "The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } } }, "recipient": { "type": "object", "properties": { "deliveryAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } } }, "deliveryPreference": { "type": "object", "properties": { "dropOffLocation": { "type": "string", "description": "The drop-off location selected by the customer." }, "addressInstruction": { "type": "string", "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryTime": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "enum": [ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" ], "description": "Specific day of the week for which operating hours are being defined." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Collection of time windows during which the location is available for deliveries on the specified day." } } }, "description": "Business hours when the business is open for deliveries." }, "exceptionDates": { "type": "array", "items": { "type": "object", "properties": { "exceptionDate": { "type": "string", "description": "Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity." }, "exceptionDateType": { "type": "string", "enum": [ "CLOSED", "OPEN" ], "description": "Operational status of the business on the specified exception date." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Alternative operating hours that apply specifically to this exception date." } } }, "description": "Specific dates within the next 30 days when normal business hours do not apply." } }, "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryCapabilities": { "type": "array", "items": { "type": "string" }, "description": "A list of miscellaneous delivery capabilities associated with the shipping address." } } } } }, "proceeds": { "type": "object", "properties": { "grandTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The proceeds category. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `TAX`, `DISCOUNT`, `DELIVERY_TIP`, `OTHER`. **Note:** `DELIVERY_TIP` is charged separately and not attributed to a specific item. The remaining categories are aggregated across all order items." }, "status": { "type": "string", "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." } }, "required": [ "type", "subtotal" ] }, "description": "Categorized proceeds for the order. Proceed categories are either aggregated across all order items (such as `ITEM`, `SHIPPING`, and `TAX`) or applied at the order level (such as `DELIVERY_TIP`)." } } }, "payment": { "type": "object", "properties": { "paymentExecutions": { "type": "array", "items": { "type": "object", "properties": { "paymentMethod": { "type": "string", "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "paymentAmount": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "acquirerId": { "type": "string", "description": "The unique identifier of the payment processor or acquiring bank that authorizes the payment. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." }, "cardBrand": { "type": "string", "description": "The card network or brand used in the payment transaction (for example, Visa or Mastercard). **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard`." }, "authorizationCode": { "type": "string", "description": "The unique code that confirms the payment authorization. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." } } }, "description": "A list of payment executions for the order." } } }, "tax": { "type": "object", "properties": { "taxRegistrations": { "type": "array", "items": { "type": "object", "properties": { "entityType": { "type": "string", "description": "The type of entity that the tax registration belongs to. **Possible values**: - `BUYER` (Indicates that this is the buyer's tax registration information) - `MERCHANT` (Indicates that this is the merchant's tax registration information) - `MARKETPLACE` (Indicates that this is the marketplace's tax registration information)" }, "legalName": { "type": "string", "description": "The legal name associated with the tax registration." }, "taxRegistrationType": { "type": "string", "description": "The type of the tax registration number. **Possible values**: `BUSINESS`, `VAT`, `CST`, `CPF`, `CNPJ`" }, "taxRegistrationNumber": { "type": "string", "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } }, "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAttributes": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the tax registration attribute. **Possible values**: `TAX_OFFICE`" }, "value": { "type": "string", "description": "The value of the tax registration attribute." } } }, "description": "Additional attributes related to the tax registration." } } }, "description": "A list of tax registrations associated with the order." }, "taxInvoicing": { "type": "object", "properties": { "buyerInvoicePreference": { "type": "string", "description": "The buyer's invoicing preference, which indicates whether the seller should issue an individual or a business invoice to the buyer. **Note**: This attribute is only available in the Turkey marketplace. **Possible values**: - `INDIVIDUAL` (Issues an individual invoice to the buyer) - `BUSINESS` (Issues a business invoice to the buyer)" }, "invoiceStatus": { "type": "string", "description": "The status of the invoice. Only available for Easy Ship orders and orders in the Brazil marketplace. **Possible values**: - `NOT_REQUIRED` (The order does not require an electronic invoice to be uploaded) - `NOT_FOUND` (The order requires an electronic invoice but it is not uploaded) - `PROCESSING` (The required electronic invoice was uploaded and is processing) - `ERRORED` (The uploaded electronic invoice was not accepted) - `ACCEPTED` (The uploaded electronic invoice was accepted)" } }, "description": "A list of tax registrations associated with the order." } } }, "fulfillment": { "type": "object", "properties": { "fulfillmentStatus": { "type": "string", "enum": [ "PENDING_AVAILABILITY", "PENDING", "UNSHIPPED", "PARTIALLY_SHIPPED", "SHIPPED", "CANCELLED", "UNFULFILLABLE" ] }, "fulfilledBy": { "type": "string", "description": "Specifies whether Amazon or the merchant is responsible for fulfilling this order. **Possible values**: `AMAZON`, `MERCHANT`." }, "fulfillmentServiceLevel": { "type": "string", "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "shipByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } }, "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "deliverByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "labelPrintingWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } } }, "required": [ "fulfillmentStatus" ] }, "orderItems": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "A unique identifier for this specific item within the order." }, "quantityOrdered": { "type": "number", "description": "The number of units of this item that the customer ordered." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "The number of units of this item that the customer ordered." }, "associatedOrderItems": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The order identifier of the associated order item." }, "orderItemId": { "type": "string", "description": "The order item identifier of the associated order item." }, "associationType": { "type": "string", "description": "The type of association between the order items. **Possible values**: - `VALUE_ADD_SERVICE` (The associated item is a service order)" } } }, "description": "A list of order items associated with this item. For example, a value-add service purchased with the product." }, "programs": { "type": "array", "items": { "type": "string" }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "product": { "type": "object", "properties": { "asin": { "type": "string" }, "title": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "sellerSku": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "condition": { "type": "object", "properties": { "conditionType": { "type": "string", "description": "The primary condition category that broadly describes the item's state. **Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`." }, "conditionSubtype": { "type": "string", "description": "A more specific condition classification that provides additional detail about the item's quality within the main condition type. **Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`, `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`." }, "conditionNote": { "type": "string", "description": "Additional details provided by the seller to describe the specific condition of this particular item." } } }, "price": { "type": "object", "properties": { "unitPrice": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "priceDesignation": { "type": "string", "description": "Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Possible value**: `BUSINESS_PRICE`" } } }, "serialNumbers": { "type": "array", "items": { "type": "string" }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." }, "customization": { "type": "object", "properties": { "customizedUrl": { "type": "string", "description": "The URL of the customized data for custom orders from the Amazon Custom program." } }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." } }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "proceeds": { "type": "object", "properties": { "proceedsTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "detailedBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "subtype": { "type": "string", "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" }, "value": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" } } }, "description": "Further granular breakdown of the subtotal." } }, "required": [ "type", "subtotal" ] }, "description": "The breakdown of proceeds." } } }, "expense": { "type": "object", "properties": { "pointsCost": { "type": "object", "properties": { "pointsGranted": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "Total number of Amazon Points granted to the customer's account for this item purchase." }, "pointsMonetaryValue": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Total number of Amazon Points granted to the customer's account for this item purchase." } } } } } } }, "promotion": { "type": "object", "properties": { "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "promotionId": { "type": "string", "description": "Unique identifier for the promotion applied to this item." } } }, "description": "A list of promotions applied to the order item." } } }, "cancellation": { "type": "object", "properties": { "cancellationRequest": { "type": "object", "properties": { "requester": { "type": "string", "description": "Entity that initiated the cancellation request for this item. **Possible values**: `BUYER`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was requested." } } }, "cancellationExecution": { "type": "object", "properties": { "cancelledBy": { "type": "string", "description": "Entity that executed the cancellation for this item. **Possible values**: `BUYER`, `MERCHANT`, `AMAZON`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was executed." } } } } }, "fulfillment": { "type": "object", "properties": { "quantityFulfilled": { "type": "number", "description": "The number of units of this item that have been successfully processed and shipped." }, "quantityUnfulfilled": { "type": "number", "description": "The number of units of this item that remain to be processed and shipped." }, "picking": { "type": "object", "properties": { "substitutionPreference": { "type": "object", "properties": { "substitutionType": { "type": "string", "enum": [ "CUSTOMER_PREFERENCE", "AMAZON_RECOMMENDED", "DO_NOT_SUBSTITUTE" ], "description": "Source and nature of the substitution preferences for this item." }, "substitutionOptions": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number of the substitute product." }, "quantityOrdered": { "type": "number", "description": "Number of units of the substitute item to be selected if substitution occurs." }, "sellerSku": { "type": "string", "description": "The item's seller stock keeping unit (SKU)." }, "title": { "type": "string", "description": "Product name or title of the substitute item as displayed to customers." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "Product name or title of the substitute item as displayed to customers." } } }, "description": "List of alternative products that can be substituted for the original item if it becomes unavailable." } }, "required": [ "substitutionType" ] } }, "description": "The number of units of this item that remain to be processed and shipped." }, "packing": { "type": "object", "properties": { "giftOption": { "type": "object", "properties": { "giftMessage": { "type": "string", "description": "Personal message from the buyer to be included with the gift-wrapped item." }, "giftWrapLevel": { "type": "string", "description": "Type or quality level of gift wrapping service selected by the customer." } } }, "serialNumberRequirement": { "type": "object", "properties": { "requirementType": { "type": "string", "description": "The requirement type for this request. **Possible values**: `REQUIRED`" } } } } }, "shipping": { "type": "object", "properties": { "scheduledDeliveryWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "shippingConstraints": { "type": "object", "properties": { "palletDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "cashOnDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "signatureConfirmation": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientIdentityVerification": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientAgeVerification": { "type": "string", "enum": [ "MANDATORY" ] } } }, "internationalShipping": { "type": "object", "properties": { "iossNumber": { "type": "string", "description": "Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale." } } } } } } }, "tax": { "type": "object", "properties": { "taxCalculationBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "reportingScheme": { "type": "string", "description": "The tax reporting scheme applied to this order item. **Possible values**: - `UOSS` (Union one stop shop. The item being purchased is held in the EU for shipment) - `IOSS` (Import one stop shop. The item being purchased is not held in the EU for shipment)" } } }, "description": "A list of tax calculation breakdowns for the order item." }, "taxCollections": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "description": "The tax collection model applied to the item. **Possible values**: - `MARKETPLACE_FACILITATOR` (Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller)" }, "responsibleParty": { "type": "string", "description": "The party responsible for withholding the taxes and remitting them to the taxing authority." } } }, "description": "A list of tax collections for the order item." } } } }, "required": [ "orderItemId", "quantityOrdered", "product" ] }, "description": "The list of all order items included in this order." }, "packages": { "type": "array", "items": { "type": "object", "properties": { "packageReferenceId": { "type": "string", "description": "A unique identifier for this package within the context of the order." }, "createdTime": { "type": "string", "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "packageStatus": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "IN_TRANSIT", "SHIPPED", "DELIVERED", "CANCELLED", "UNDELIVERABLE" ], "description": "Primary status classification of the package in the shipping workflow." }, "detailedStatus": { "type": "string", "description": "Granular status information providing specific details about the package's current location and handling stage. **Possible values**: - `PENDING_SCHEDULE` (Package awaiting pickup scheduling) - `PENDING_PICK_UP` (Package ready for carrier collection from seller) - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier) - `LABEL_CANCELLED` (Shipping label canceled by seller) - `PICKED_UP` (Package collected by carrier from seller location) - `DROPPED_OFF` (Package delivered to carrier by seller) - `AT_ORIGIN_FC` (Package at originating fulfillment center) - `AT_DESTINATION_FC` (Package at destination fulfillment center) - `DELIVERED` (Package successfully delivered to recipient) - `REJECTED_BY_BUYER` (Package refused by intended recipient) - `UNDELIVERABLE` (Package cannot be delivered due to address or access issues) - `RETURNING_TO_SELLER` (Package in transit back to seller) - `RETURNED_TO_SELLER` (Package successfully returned to seller) - `LOST` (Package location unknown or confirmed lost) - `OUT_FOR_DELIVERY` (Package on delivery vehicle for final delivery) - `DAMAGED` (Package damaged during transit)" } }, "required": [ "status" ], "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "carrier": { "type": "string", "description": "The carrier responsible for transporting this package to the customer." }, "shipTime": { "type": "string", "description": "The exact time when this package was handed over to the carrier and began its journey to the customer. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "shippingService": { "type": "string", "description": "The specific shipping method or service used for delivering this package." }, "trackingNumber": { "type": "string", "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "shipFromAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the business or facility at this address." }, "addressLine1": { "type": "string", "description": "The primary street address of the merchant's location." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code or ZIP code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code for the address, in ISO 3166-1 format." } }, "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "packageItems": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "Unique identifier of the order item included in this package." }, "quantity": { "type": "number", "description": "Number of units of this item included in the package shipment." }, "transparencyCodes": { "type": "array", "items": { "type": "string" }, "description": "The transparency codes associated with this item for product authentication." } }, "required": [ "orderItemId", "quantity" ] }, "description": "A list of all order items included in this specific package." } }, "required": [ "packageReferenceId" ] }, "description": "Shipping packages created for this order, including tracking information. **Note:** Only available for merchant-fulfilled (FBM) orders." }, "fulfillmentOrders": { "type": "array", "items": { "type": "object", "properties": { "fulfillmentOrderId": { "type": "string", "description": "The Fulfillment Order ID assigned by Amazon after fulfillment planning. This identifier is identical to the Shipment ID required by External Fulfillment APIs." } }, "required": [ "fulfillmentOrderId" ] }, "description": "The list of fulfillment orders associated with this customer order. Each entry corresponds to one fulfillment unit created by Amazon for this order. **Note:** Only available for EasyShip orders at present." } }, "required": [ "orderId", "createdTime", "lastUpdatedTime", "salesChannel", "orderItems" ] } }, "required": [ "order" ] }, "SpApiGetOrderSearchParams": { "type": "object", "properties": { "includedData": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "BUYER", "RECIPIENT", "PROCEEDS", "EXPENSE", "PROMOTION", "CANCELLATION", "FULFILLMENT", "PACKAGES", "TAX", "PAYMENT", "FULFILLMENT_ORDERS" ] } } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetPrepInstructionsErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "SKUPrepInstructionsList": { "type": "array", "items": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } }, "AmazonPrepFeesDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } } } } }, "InvalidSKUList": { "type": "array", "items": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The seller SKU of the item." } } } }, "ASINPrepInstructionsList": { "type": "array", "items": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } } } } }, "InvalidASINList": { "type": "array", "items": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." } } } } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetPrepInstructionsResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "SKUPrepInstructionsList": { "type": "array", "items": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } }, "AmazonPrepFeesDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } } } } }, "InvalidSKUList": { "type": "array", "items": { "type": "object", "properties": { "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The seller SKU of the item." } } } }, "ASINPrepInstructionsList": { "type": "array", "items": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "BarcodeInstruction": { "type": "string", "enum": [ "RequiresFNSKULabel", "CanUseOriginalBarcode", "MustProvideSellerSKU" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "PrepGuidance": { "type": "string", "enum": [ "ConsultHelpDocuments", "NoAdditionalPrepRequired", "SeePrepInstructionsList" ] }, "PrepInstructionList": { "type": "array", "items": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] } } } } }, "InvalidASINList": { "type": "array", "items": { "type": "object", "properties": { "ASIN": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "ErrorReason": { "type": "string", "enum": [ "DoesNotExist", "InvalidASIN" ], "description": "The Amazon Standard Identification Number (ASIN) of the item." } } } } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetPrepInstructionsSearchParams": { "type": "object", "properties": { "ShipToCountryCode": { "type": "string" }, "SellerSKUList": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "ASINList": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "ShipToCountryCode", "mp" ] }, "SpApiGetReportDocumentErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "Error response returned when the request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiGetReportDocumentResponse": { "type": "object", "properties": { "reportDocumentId": { "type": "string", "description": "The identifier for the report document. This identifier is unique only in combination with a seller ID." }, "url": { "type": "string", "description": "A presigned URL for the report document. If `compressionAlgorithm` is not returned, you can download the report directly from this URL. This URL expires after 5 minutes." }, "compressionAlgorithm": { "type": "string", "enum": [ "GZIP" ], "description": "If the report document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the report when you download. Otherwise, you can download the report directly. Refer to [Step 2. Download the report](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-retrieve-a-report#step-2-download-the-report) in the use case guide, where sample code is provided." } }, "required": [ "reportDocumentId", "url" ] }, "SpApiGetReportDocumentSearchParams": { "type": "object", "properties": { "enableContentEncodingUrlHeader": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetReportErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "Error response returned when the request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiGetReportResponse": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers for the report." }, "reportId": { "type": "string", "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." }, "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information." }, "dataStartTime": { "type": "string", "description": "The start of a date and time range used for selecting the data to report." }, "dataEndTime": { "type": "string", "description": "The end of a date and time range used for selecting the data to report." }, "reportScheduleId": { "type": "string", "description": "The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID." }, "createdTime": { "type": "string", "description": "The date and time when the report was created." }, "processingStatus": { "type": "string", "enum": [ "CANCELLED", "DONE", "FATAL", "IN_PROGRESS", "IN_QUEUE" ], "description": "The processing status of the report." }, "processingStartTime": { "type": "string", "description": "The date and time when the report processing started, in ISO 8601 date time format." }, "processingEndTime": { "type": "string", "description": "The date and time when the report processing completed, in ISO 8601 date time format." }, "reportDocumentId": { "type": "string", "description": "The identifier for the report document. Pass this into the `getReportDocument` operation to get the information you will need to retrieve the report document's contents." } }, "required": [ "reportId", "reportType", "createdTime", "processingStatus" ] }, "SpApiGetReportScheduleErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "Error response returned when the request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiGetReportScheduleResponse": { "type": "object", "properties": { "reportScheduleId": { "type": "string", "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID." }, "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise." }, "reportOptions": { "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise." }, "period": { "type": "string", "description": "An ISO 8601 period value that indicates how often a report should be created." }, "nextReportCreationTime": { "type": "string", "description": "The date and time when the schedule will create its next report, in ISO 8601 date time format." } }, "required": [ "reportScheduleId", "reportType", "period" ] }, "SpApiGetReportScheduleSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetReportSchedulesErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "Error response returned when the request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiGetReportSchedulesResponse": { "type": "object", "properties": { "reportSchedules": { "type": "array", "items": { "type": "object", "properties": { "reportScheduleId": { "type": "string", "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID." }, "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise." }, "reportOptions": { "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise." }, "period": { "type": "string", "description": "An ISO 8601 period value that indicates how often a report should be created." }, "nextReportCreationTime": { "type": "string", "description": "The date and time when the schedule will create its next report, in ISO 8601 date time format." } }, "required": [ "reportScheduleId", "reportType", "period" ] }, "description": "Detailed information about a report schedule." } }, "required": [ "reportSchedules" ] }, "SpApiGetReportSchedulesSearchParams": { "type": "object", "properties": { "reportTypes": { "type": "array", "items": { "type": "string" } }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "reportTypes", "mp" ] }, "SpApiGetReportSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetReportsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "Error response returned when the request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiGetReportsResponse": { "type": "object", "properties": { "reports": { "type": "array", "items": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace identifiers for the report." }, "reportId": { "type": "string", "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." }, "reportType": { "type": "string", "description": "The report type. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information." }, "dataStartTime": { "type": "string", "description": "The start of a date and time range used for selecting the data to report." }, "dataEndTime": { "type": "string", "description": "The end of a date and time range used for selecting the data to report." }, "reportScheduleId": { "type": "string", "description": "The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID." }, "createdTime": { "type": "string", "description": "The date and time when the report was created." }, "processingStatus": { "type": "string", "enum": [ "CANCELLED", "DONE", "FATAL", "IN_PROGRESS", "IN_QUEUE" ], "description": "The processing status of the report." }, "processingStartTime": { "type": "string", "description": "The date and time when the report processing started, in ISO 8601 date time format." }, "processingEndTime": { "type": "string", "description": "The date and time when the report processing completed, in ISO 8601 date time format." }, "reportDocumentId": { "type": "string", "description": "The identifier for the report document. Pass this into the `getReportDocument` operation to get the information you will need to retrieve the report document's contents." } }, "required": [ "reportId", "reportType", "createdTime", "processingStatus" ] } }, "nextToken": { "type": "string", "description": "Returned when the number of results exceeds `pageSize`. To get the next page of results, call `getReports` with this token as the only parameter." } }, "required": [ "reports" ] }, "SpApiGetReportsSearchParams": { "type": "object", "properties": { "reportTypes": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "processingStatuses": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "IN_PROGRESS", "CANCELLED", "DONE", "FATAL", "IN_QUEUE" ] } } ] }, "marketplaceIds": { "type": "object" }, "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "createdSince": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "createdUntil": { "type": "object" }, "nextToken": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetSelfShipAppointmentSlotsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGetSelfShipAppointmentSlotsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "selfShipAppointmentSlotsAvailability": { "type": "object", "properties": { "expiresAt": { "type": "string", "description": "The time at which the self ship appointment slot expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format." }, "slots": { "type": "array", "items": { "type": "object", "properties": { "slotId": { "type": "string", "description": "An identifier to a self-ship appointment slot." }, "slotTime": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ], "description": "An identifier to a self-ship appointment slot." } }, "required": [ "slotId", "slotTime" ] }, "description": "A list of appointment slots." } } } }, "required": [ "selfShipAppointmentSlotsAvailability" ] }, "SpApiGetSelfShipAppointmentSlotsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetShipmentContentUpdatePreviewErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGetShipmentContentUpdatePreviewResponse": { "type": "object", "properties": { "contentUpdatePreviewId": { "type": "string", "description": "Identifier of a content update preview." }, "expiration": { "type": "string", "description": "The time at which the content update expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "requestedUpdates": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ] }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped." } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed" }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "The number of containers where all other properties like weight or dimensions are identical." } }, "required": [ "contentInformationSource", "dimensions", "quantity", "weight" ] }, "description": "A list of boxes that will be present in the shipment after the update." }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped." } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "A list of all items that will be present in the shipment after the update." } }, "description": "The time at which the content update expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "transportationOption": { "type": "object", "properties": { "carrier": { "type": "object", "properties": { "alphaCode": { "type": "string", "description": "The carrier code. For example, USPS or DHLEX." }, "name": { "type": "string", "description": "The name of the carrier." } } }, "carrierAppointment": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ] }, "preconditions": { "type": "array", "items": { "type": "string" }, "description": "Identifies a list of preconditions for confirming the transportation option." }, "quote": { "type": "object", "properties": { "cost": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "expiration": { "type": "string", "description": "The time at which this transportation option quote expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "voidableUntil": { "type": "string", "description": "Voidable until timestamp." } }, "required": [ "cost" ], "description": "Identifies a list of preconditions for confirming the transportation option." }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "shippingMode": { "type": "string", "description": "Mode of shipment transportation that this option will provide. Possible values: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`." }, "shippingSolution": { "type": "string", "description": "Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." }, "transportationOptionId": { "type": "string", "description": "Identifier of a transportation option. A transportation option represent one option for how to send a shipment." } }, "required": [ "carrier", "preconditions", "shipmentId", "shippingMode", "shippingSolution", "transportationOptionId" ] } }, "required": [ "contentUpdatePreviewId", "expiration", "requestedUpdates", "transportationOption" ] }, "SpApiGetShipmentContentUpdatePreviewSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetShipmentErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiGetShipmentItemsByShipmentIdErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "ItemData": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "A shipment identifier originally returned by the createInboundShipmentPlan operation." }, "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "FulfillmentNetworkSKU": { "type": "string", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityShipped": { "type": "number", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityReceived": { "type": "number" }, "QuantityInCase": { "type": "number" }, "ReleaseDate": { "type": "string" }, "PrepDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER" ] } }, "required": [ "PrepInstruction", "PrepOwner" ] } } }, "required": [ "SellerSKU", "QuantityShipped" ] } }, "NextToken": { "type": "string", "description": "When present and not empty, pass this string token in the next request to return the next response page." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetShipmentItemsByShipmentIdResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "ItemData": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "A shipment identifier originally returned by the createInboundShipmentPlan operation." }, "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "FulfillmentNetworkSKU": { "type": "string", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityShipped": { "type": "number", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityReceived": { "type": "number" }, "QuantityInCase": { "type": "number" }, "ReleaseDate": { "type": "string" }, "PrepDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER" ] } }, "required": [ "PrepInstruction", "PrepOwner" ] } } }, "required": [ "SellerSKU", "QuantityShipped" ] } }, "NextToken": { "type": "string", "description": "When present and not empty, pass this string token in the next request to return the next response page." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetShipmentItemsByShipmentIdSearchParams": { "type": "object", "properties": { "MarketplaceId": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetShipmentItemsErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "ItemData": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "A shipment identifier originally returned by the createInboundShipmentPlan operation." }, "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "FulfillmentNetworkSKU": { "type": "string", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityShipped": { "type": "number", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityReceived": { "type": "number" }, "QuantityInCase": { "type": "number" }, "ReleaseDate": { "type": "string" }, "PrepDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER" ] } }, "required": [ "PrepInstruction", "PrepOwner" ] } } }, "required": [ "SellerSKU", "QuantityShipped" ] } }, "NextToken": { "type": "string", "description": "When present and not empty, pass this string token in the next request to return the next response page." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetShipmentItemsResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "ItemData": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "A shipment identifier originally returned by the createInboundShipmentPlan operation." }, "SellerSKU": { "type": "string", "description": "The seller SKU of the item." }, "FulfillmentNetworkSKU": { "type": "string", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityShipped": { "type": "number", "description": "Amazon's fulfillment network SKU of the item." }, "QuantityReceived": { "type": "number" }, "QuantityInCase": { "type": "number" }, "ReleaseDate": { "type": "string" }, "PrepDetailsList": { "type": "array", "items": { "type": "object", "properties": { "PrepInstruction": { "type": "string", "enum": [ "Polybagging", "BubbleWrapping", "Taping", "BlackShrinkWrapping", "Labeling", "HangGarment", "SetCreation", "Boxing", "RemoveFromHanger", "Debundle", "SuffocationStickering", "CapSealing", "SetStickering", "BlankStickering", "ShipsInProductPackaging", "NoPrep" ] }, "PrepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER" ] } }, "required": [ "PrepInstruction", "PrepOwner" ] } } }, "required": [ "SellerSKU", "QuantityShipped" ] } }, "NextToken": { "type": "string", "description": "When present and not empty, pass this string token in the next request to return the next response page." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetShipmentItemsSearchParams": { "type": "object", "properties": { "LastUpdatedAfter": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "LastUpdatedBefore": { "type": "object" }, "QueryType": { "type": "string", "enum": [ "DATE_RANGE", "NEXT_TOKEN" ] }, "NextToken": { "type": "object" }, "MarketplaceId": { "type": "string" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "QueryType", "MarketplaceId", "mp" ] }, "SpApiGetShipmentResponse": { "type": "object", "properties": { "amazonReferenceId": { "type": "string", "description": "A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment." }, "contactInformation": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The contact's name." }, "phoneNumber": { "type": "string", "description": "The phone number." } }, "required": [ "name", "phoneNumber" ], "description": "A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment." }, "dates": { "type": "object", "properties": { "readyToShipWindow": { "type": "object", "properties": { "editableUntil": { "type": "string", "description": "The timestamp at which this Window can no longer be edited." }, "end": { "type": "string", "description": "The end timestamp of the window." }, "start": { "type": "string", "description": "The start timestamp of the window." } }, "required": [ "end", "start" ] } } }, "destination": { "type": "object", "properties": { "address": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ] }, "destinationType": { "type": "string", "description": "The type of destination for this shipment. Possible values: `AMAZON_OPTIMIZED`, `AMAZON_WAREHOUSE`." }, "warehouseId": { "type": "string", "description": "The warehouse that the shipment should be sent to. This can be empty if the destination type is `AMAZON_OPTIMIZED`." } }, "required": [ "destinationType" ] }, "freightInformation": { "type": "object", "properties": { "declaredValue": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "freightClass": { "type": "string", "description": "Freight class. Possible values: `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", "description": "The name of the shipment." }, "placementOptionId": { "type": "string", "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "selectedDeliveryWindow": { "type": "object", "properties": { "availabilityType": { "type": "string", "description": "The type of delivery window availability. Values: `AVAILABLE`, `BLOCKED`, `CONGESTED`, `DISCOUNTED`" }, "deliveryWindowOptionId": { "type": "string", "description": "Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered." }, "editableUntil": { "type": "string", "description": "The timestamp at which this Window can no longer be edited." }, "endDate": { "type": "string", "description": "The end timestamp of the window." }, "startDate": { "type": "string", "description": "The start timestamp of the window." } }, "required": [ "availabilityType", "deliveryWindowOptionId", "endDate", "startDate" ], "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "selectedTransportationOptionId": { "type": "string", "description": "Identifier of a transportation option. A transportation option represent one option for how to send a shipment." }, "selfShipAppointmentDetails": { "type": "array", "items": { "type": "object", "properties": { "appointmentId": { "type": "number", "description": "Identifier for appointment." }, "appointmentSlotTime": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ], "description": "Identifier for appointment." }, "appointmentStatus": { "type": "string", "description": "Status of the appointment." } } }, "description": "List of self ship appointment details." }, "shipmentConfirmationId": { "type": "string", "description": "The confirmed shipment ID which shows up on labels (for example, `FBA1234ABCD`)." }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "source": { "type": "object", "properties": { "address": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ] }, "sourceType": { "type": "string", "description": "The type of source for this shipment. Possible values: `SELLER_FACILITY`." } }, "required": [ "sourceType" ], "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "status": { "type": "string", "description": "The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`" }, "trackingDetails": { "type": "object", "properties": { "ltlTrackingDetail": { "type": "object", "properties": { "billOfLadingNumber": { "type": "string", "description": "The number of the carrier shipment acknowledgement document." }, "freightBillNumber": { "type": "array", "items": { "type": "string" }, "description": "The number associated with the freight bill." } } }, "spdTrackingDetail": { "type": "object", "properties": { "spdTrackingItems": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "trackingId": { "type": "string", "description": "The tracking ID associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment." }, "trackingNumberValidationStatus": { "type": "string", "description": "Indicates whether Amazon has validated the tracking number. Because shipment validation is asynchronous, tracking IDs might not be validated immediately, and the status might change after a few hours. If more than 24 hours have passed and the status is not yet 'VALIDATED' or `NOT_SUPPORTED`, verify the number and update it if necessary. **Possible values:** `VALIDATED`, `NOT_VALIDATED`, `NOT_SUPPORTED` (Amazon is unable to find tracking information for the provided tracking ID)." } } }, "description": "List of Small Parcel Delivery (SPD) tracking items." } } } }, "description": "The status of a shipment. The state of the shipment will typically start as `UNCONFIRMED`, then transition to `WORKING` after a placement option has been confirmed, and then to `READY_TO_SHIP` once labels are generated. Possible values: `ABANDONED`, `CANCELLED`, `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`, `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`" } }, "required": [ "destination", "placementOptionId", "shipmentId", "source" ] }, "SpApiGetShipmentSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetShipmentsErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "ShipmentData": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "The shipment identifier submitted in the request." }, "ShipmentName": { "type": "string", "description": "The name for the inbound shipment." }, "ShipFromAddress": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the individual or business." }, "AddressLine1": { "type": "string", "description": "The street address information." }, "AddressLine2": { "type": "string", "description": "Additional street address information, if required." }, "DistrictOrCounty": { "type": "string", "description": "The district or county." }, "City": { "type": "string", "description": "The city." }, "StateOrProvinceCode": { "type": "string", "description": "The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan." }, "CountryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "PostalCode": { "type": "string", "description": "The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan." } }, "required": [ "Name", "AddressLine1", "City", "StateOrProvinceCode", "CountryCode", "PostalCode" ], "description": "The name for the inbound shipment." }, "DestinationFulfillmentCenterId": { "type": "string", "description": "An Amazon fulfillment center identifier created by Amazon." }, "ShipmentStatus": { "type": "string", "enum": [ "WORKING", "SHIPPED", "RECEIVING", "CANCELLED", "DELETED", "CLOSED", "ERROR", "IN_TRANSIT", "DELIVERED", "CHECKED_IN" ], "description": "An Amazon fulfillment center identifier created by Amazon." }, "LabelPrepType": { "type": "string", "enum": [ "NO_LABEL", "SELLER_LABEL", "AMAZON_LABEL" ] }, "AreCasesRequired": { "type": "boolean", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "ConfirmedNeedByDate": { "type": "string", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "BoxContentsSource": { "type": "string", "enum": [ "NONE", "FEED", "2D_BARCODE", "INTERACTIVE" ] }, "EstimatedBoxContentsFee": { "type": "object", "properties": { "TotalUnits": { "type": "number" }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] }, "TotalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } }, "required": [ "ShipFromAddress", "AreCasesRequired" ] } }, "NextToken": { "type": "string", "description": "When present and not empty, pass this string token in the next request to return the next response page." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetShipmentsResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "ShipmentData": { "type": "array", "items": { "type": "object", "properties": { "ShipmentId": { "type": "string", "description": "The shipment identifier submitted in the request." }, "ShipmentName": { "type": "string", "description": "The name for the inbound shipment." }, "ShipFromAddress": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the individual or business." }, "AddressLine1": { "type": "string", "description": "The street address information." }, "AddressLine2": { "type": "string", "description": "Additional street address information, if required." }, "DistrictOrCounty": { "type": "string", "description": "The district or county." }, "City": { "type": "string", "description": "The city." }, "StateOrProvinceCode": { "type": "string", "description": "The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan." }, "CountryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "PostalCode": { "type": "string", "description": "The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan." } }, "required": [ "Name", "AddressLine1", "City", "StateOrProvinceCode", "CountryCode", "PostalCode" ], "description": "The name for the inbound shipment." }, "DestinationFulfillmentCenterId": { "type": "string", "description": "An Amazon fulfillment center identifier created by Amazon." }, "ShipmentStatus": { "type": "string", "enum": [ "WORKING", "SHIPPED", "RECEIVING", "CANCELLED", "DELETED", "CLOSED", "ERROR", "IN_TRANSIT", "DELIVERED", "CHECKED_IN" ], "description": "An Amazon fulfillment center identifier created by Amazon." }, "LabelPrepType": { "type": "string", "enum": [ "NO_LABEL", "SELLER_LABEL", "AMAZON_LABEL" ] }, "AreCasesRequired": { "type": "boolean", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "ConfirmedNeedByDate": { "type": "string", "description": "Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed." }, "BoxContentsSource": { "type": "string", "enum": [ "NONE", "FEED", "2D_BARCODE", "INTERACTIVE" ] }, "EstimatedBoxContentsFee": { "type": "object", "properties": { "TotalUnits": { "type": "number" }, "FeePerUnit": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] }, "TotalFee": { "type": "object", "properties": { "CurrencyCode": { "type": "string", "enum": [ "USD", "GBP" ] }, "Value": { "type": "number" } }, "required": [ "CurrencyCode", "Value" ] } } } }, "required": [ "ShipFromAddress", "AreCasesRequired" ] } }, "NextToken": { "type": "string", "description": "When present and not empty, pass this string token in the next request to return the next response page." } } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", "description": "A message that describes the error condition in a human-readable form." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetShipmentsSearchParams": { "type": "object", "properties": { "ShipmentStatusList": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "WORKING", "READY_TO_SHIP", "SHIPPED", "RECEIVING", "CANCELLED", "DELETED", "CLOSED", "ERROR", "IN_TRANSIT", "DELIVERED", "CHECKED_IN" ] } } ] }, "ShipmentIdList": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "LastUpdatedAfter": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "LastUpdatedBefore": { "type": "object" }, "QueryType": { "type": "string", "enum": [ "DATE_RANGE", "NEXT_TOKEN", "SHIPMENT" ] }, "NextToken": { "type": "object" }, "MarketplaceId": { "type": "string" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "QueryType", "MarketplaceId", "mp" ] }, "SpApiGetSubscriptionByIdErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier generated when the subscription is created." }, "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "type": "object", "properties": { "eventFilter": { "type": "object", "properties": {} }, "filterExpression": { "type": "string", "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } }, "description": "The identifier for the destination where notifications will be delivered." } }, "required": [ "subscriptionId", "payloadVersion", "destinationId" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetSubscriptionByIdResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier generated when the subscription is created." }, "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "type": "object", "properties": { "eventFilter": { "type": "object", "properties": {} }, "filterExpression": { "type": "string", "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } }, "description": "The identifier for the destination where notifications will be delivered." } }, "required": [ "subscriptionId", "payloadVersion", "destinationId" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetSubscriptionByIdSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiGetSubscriptionErrorResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier generated when the subscription is created." }, "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "type": "object", "properties": { "eventFilter": { "type": "object", "properties": {} }, "filterExpression": { "type": "string", "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } }, "description": "The identifier for the destination where notifications will be delivered." } }, "required": [ "subscriptionId", "payloadVersion", "destinationId" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetSubscriptionResponse": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier generated when the subscription is created." }, "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "type": "object", "properties": { "eventFilter": { "type": "object", "properties": {} }, "filterExpression": { "type": "string", "description": "An expression for filtering events before delivery to destination based on the notification payload (example: FulfillmentOrderStatusNotification.FulfillmentOrderStatus == `SHIPPED` ). The `filterExpression` is a string that follows the CEL expression syntax (https://github.com/google/cel-spec) excluding arithmetic operators (+, -, *, /, %) and list/map indexing ([]). Refer to Notification Type Values to determine if filter Expression is supported for a Notification Type. Refer to CEL Operators (https://developer-docs.amazon.com/sp-api/docs/filter-notification-subscriptions) to see if a CEL operator is supported. Note: eventFilter and filterExpression are mutually exclusive. You can use filterExpression to replace existing eventFilter configurations." } }, "description": "The identifier for the destination where notifications will be delivered." } }, "required": [ "subscriptionId", "payloadVersion", "destinationId" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] } } } }, "SpApiGetSubscriptionSearchParams": { "type": "object", "properties": { "payloadVersion": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListDeliveryWindowOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListDeliveryWindowOptionsResponse": { "type": "object", "properties": { "deliveryWindowOptions": { "type": "array", "items": { "type": "object", "properties": { "availabilityType": { "type": "string", "description": "The type of delivery window availability. Values: `AVAILABLE`, `BLOCKED`, `CONGESTED`, `DISCOUNTED`" }, "deliveryWindowOptionId": { "type": "string", "description": "Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered." }, "discounts": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Discounts for the offered option." }, "endDate": { "type": "string", "description": "The time at which this delivery window option ends. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." }, "startDate": { "type": "string", "description": "The time at which this delivery window option starts. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." }, "validUntil": { "type": "string", "description": "The time at which this window delivery option is no longer valid. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mmZ`." } }, "required": [ "availabilityType", "deliveryWindowOptionId", "endDate", "startDate", "validUntil" ] }, "description": "Delivery window options generated for the placement option." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "Delivery window options generated for the placement option." } }, "required": [ "deliveryWindowOptions" ] }, "SpApiListDeliveryWindowOptionsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListInboundPlanBoxesErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListInboundPlanBoxesResponse": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": "string", "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": "string", "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": "string", "description": "Template name of the box." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] }, "description": "A list of boxes in an inbound plan." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "A list of boxes in an inbound plan." } }, "required": [ "boxes" ] }, "SpApiListInboundPlanBoxesSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListInboundPlanItemsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListInboundPlanItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "The items in an inbound plan." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "The items in an inbound plan." } }, "required": [ "items" ] }, "SpApiListInboundPlanItemsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListInboundPlanPalletsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListInboundPlanPalletsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "pallets": { "type": "array", "items": { "type": "object", "properties": { "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "stackability": { "type": "string", "enum": [ "STACKABLE", "NON_STACKABLE" ], "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ] } }, "required": [ "packageId" ] }, "description": "The pallets in an inbound plan." } }, "required": [ "pallets" ] }, "SpApiListInboundPlanPalletsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListInboundPlansErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListInboundPlansResponse": { "type": "object", "properties": { "inboundPlans": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "The time at which the inbound plan was created. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "inboundPlanId": { "type": "string", "description": "Identifier of an inbound plan." }, "lastUpdatedAt": { "type": "string", "description": "The time at which the inbound plan was last updated. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ssZ`." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "A list of marketplace IDs." }, "name": { "type": "string", "description": "Human-readable name of the inbound plan." }, "sourceAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information." }, "addressLine2": { "type": "string", "description": "Additional street address information." }, "city": { "type": "string", "description": "The city." }, "companyName": { "type": "string", "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format." }, "districtOrCounty": { "type": "string", "description": "The district or county." }, "email": { "type": "string", "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact." }, "phoneNumber": { "type": "string", "description": "The phone number." }, "postalCode": { "type": "string", "description": "The postal code." }, "stateOrProvinceCode": { "type": "string", "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "postalCode" ], "description": "Human-readable name of the inbound plan." }, "status": { "type": "string", "description": "The current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`, `SHIPPED`, `ERRORED`." } }, "required": [ "createdAt", "inboundPlanId", "lastUpdatedAt", "marketplaceIds", "name", "sourceAddress", "status" ] }, "description": "A list of inbound plans with minimal information." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "A list of inbound plans with minimal information." } } }, "SpApiListInboundPlansSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "status": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "SHIPPED" ] }, { "type": "string", "enum": [ "VOIDED" ] } ] }, "sortBy": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "LAST_UPDATED_TIME" ] }, { "type": "string", "enum": [ "CREATION_TIME" ] } ] }, "sortOrder": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ASC" ] }, { "type": "string", "enum": [ "DESC" ] } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListItemComplianceDetailsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListItemComplianceDetailsResponse": { "type": "object", "properties": { "complianceDetails": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number, which identifies the detail page identifier." }, "fnsku": { "type": "string", "description": "The Fulfillment Network SKU, which identifies a real fulfillable item with catalog data and condition." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "taxDetails": { "type": "object", "properties": { "declaredValue": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "hsnCode": { "type": "string", "description": "Harmonized System of Nomenclature code." }, "taxRates": { "type": "array", "items": { "type": "object", "properties": { "cessRate": { "type": "number", "description": "Rate of cess tax." }, "gstRate": { "type": "number", "description": "Rate of gst tax." }, "taxType": { "type": "string", "description": "Type of tax. Possible values: `CGST`, `SGST`, `IGST`, `TOTAL_TAX`." } } }, "description": "List of tax rates." } }, "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." } } }, "description": "List of compliance details." } } }, "SpApiListItemComplianceDetailsSearchParams": { "type": "object", "properties": { "mskus": { "type": "array", "items": { "type": "string" } }, "marketplaceId": { "type": "string" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mskus", "marketplaceId", "mp" ] }, "SpApiListPackingGroupBoxesErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListPackingGroupBoxesResponse": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": "string", "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": "string", "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": "string", "description": "Template name of the box." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] }, "description": "Provides the information about the list of boxes in the packing group." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "Provides the information about the list of boxes in the packing group." } }, "required": [ "boxes" ] }, "SpApiListPackingGroupBoxesSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListPackingGroupItemsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListPackingGroupItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Provides the information about the list of items in the packing group." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "Provides the information about the list of items in the packing group." } }, "required": [ "items" ] }, "SpApiListPackingOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListPackingOptionsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListPlacementOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListPlacementOptionsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "placementOptions": { "type": "array", "items": { "type": "object", "properties": { "discounts": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "Discount for the offered option." }, "expiration": { "type": "string", "description": "The expiration date of the placement option. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "fees": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the incentive." }, "target": { "type": "string", "description": "Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'." }, "type": { "type": "string", "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." }, "value": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ], "description": "Type of incentive. Possible values: `FEE`, `DISCOUNT`." } }, "required": [ "description", "target", "type", "value" ] }, "description": "The fee for the offered option." }, "placementOptionId": { "type": "string", "description": "The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs." }, "shipmentIds": { "type": "array", "items": { "type": "string" }, "description": "Shipment ids." }, "status": { "type": "string", "description": "The status of a placement option. Possible values: `OFFERED`, `ACCEPTED`, `EXPIRED`." } }, "required": [ "discounts", "fees", "placementOptionId", "shipmentIds", "status" ] }, "description": "Placement options generated for the inbound plan." } }, "required": [ "placementOptions" ] }, "SpApiListPrepDetailsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListPrepDetailsResponse": { "type": "object", "properties": { "mskuPrepDetails": { "type": "array", "items": { "type": "object", "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "description": "A list of MSKUs and related prep details." } }, "required": [ "mskuPrepDetails" ] }, "SpApiListPrepDetailsSearchParams": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "mskus": { "type": "array", "items": { "type": "string" } }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceId", "mskus", "mp" ] }, "SpApiListShipmentBoxesErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListShipmentBoxesResponse": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": "string", "description": "State." }, "warehouseId": { "type": "string", "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": "string", "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": "string", "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": "string", "description": "Template name of the box." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] }, "description": "A list of boxes in a shipment." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "A list of boxes in a shipment." } }, "required": [ "boxes" ] }, "SpApiListShipmentBoxesSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListShipmentContentUpdatePreviewsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListShipmentContentUpdatePreviewsResponse": { "type": "object", "properties": { "contentUpdatePreviews": { "type": "array", "items": { "type": "object", "properties": { "contentUpdatePreviewId": { "type": "string", "description": "Identifier of a content update preview." }, "expiration": { "type": "string", "description": "The time at which the content update expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "requestedUpdates": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ] }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped." } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed" }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ], "description": "The number of containers where all other properties like weight or dimensions are identical." } }, "required": [ "contentInformationSource", "dimensions", "quantity", "weight" ] }, "description": "A list of boxes that will be present in the shipment after the update." }, "items": { "type": "array", "items": { "type": "object", "properties": { "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU." }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped." } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "A list of all items that will be present in the shipment after the update." } }, "description": "The time at which the content update expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "transportationOption": { "type": "object", "properties": { "carrier": { "type": "object", "properties": { "alphaCode": { "type": "string", "description": "The carrier code. For example, USPS or DHLEX." }, "name": { "type": "string", "description": "The name of the carrier." } } }, "carrierAppointment": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ] }, "preconditions": { "type": "array", "items": { "type": "string" }, "description": "Identifies a list of preconditions for confirming the transportation option." }, "quote": { "type": "object", "properties": { "cost": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "expiration": { "type": "string", "description": "The time at which this transportation option quote expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "voidableUntil": { "type": "string", "description": "Voidable until timestamp." } }, "required": [ "cost" ], "description": "Identifies a list of preconditions for confirming the transportation option." }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "shippingMode": { "type": "string", "description": "Mode of shipment transportation that this option will provide. Possible values: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`." }, "shippingSolution": { "type": "string", "description": "Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." }, "transportationOptionId": { "type": "string", "description": "Identifier of a transportation option. A transportation option represent one option for how to send a shipment." } }, "required": [ "carrier", "preconditions", "shipmentId", "shippingMode", "shippingSolution", "transportationOptionId" ] } }, "required": [ "contentUpdatePreviewId", "expiration", "requestedUpdates", "transportationOption" ] }, "description": "A list of content update previews in a shipment." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "A list of content update previews in a shipment." } }, "required": [ "contentUpdatePreviews" ] }, "SpApiListShipmentContentUpdatePreviewsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListShipmentItemsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListShipmentItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item." }, "expiration": { "type": "string", "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center." }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "manufacturingLotCode": { "type": "string", "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID." }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": "string", "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": "string", "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item." }, "quantity": { "type": "number", "description": "The number of the specified MSKU." } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "The items in a shipment." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } }, "description": "The items in a shipment." } }, "required": [ "items" ] }, "SpApiListShipmentItemsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListShipmentPalletsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListShipmentPalletsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "pallets": { "type": "array", "items": { "type": "object", "properties": { "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package." }, "length": { "type": "number", "description": "The length of a package." }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package." }, "width": { "type": "number", "description": "The width of a package." } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet)." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical." }, "stackability": { "type": "string", "enum": [ "STACKABLE", "NON_STACKABLE" ], "description": "The number of containers where all other properties like weight or dimensions are identical." }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ] }, "value": { "type": "number", "description": "Value of a weight." } }, "required": [ "unit", "value" ] } }, "required": [ "packageId" ] }, "description": "The pallets in a shipment." } }, "required": [ "pallets" ] }, "SpApiListShipmentPalletsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiListTransportationOptionsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiListTransportationOptionsResponse": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "When present, pass this string token in the next request to return the next response page." } } }, "transportationOptions": { "type": "array", "items": { "type": "object", "properties": { "carrier": { "type": "object", "properties": { "alphaCode": { "type": "string", "description": "The carrier code. For example, USPS or DHLEX." }, "name": { "type": "string", "description": "The name of the carrier." } } }, "carrierAppointment": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ] }, "preconditions": { "type": "array", "items": { "type": "string" }, "description": "Identifies a list of preconditions for confirming the transportation option." }, "quote": { "type": "object", "properties": { "cost": { "type": "object", "properties": { "amount": { "type": "number", "description": "Decimal value of the currency." }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code." } }, "required": [ "amount", "code" ] }, "expiration": { "type": "string", "description": "The time at which this transportation option quote expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`." }, "voidableUntil": { "type": "string", "description": "Voidable until timestamp." } }, "required": [ "cost" ], "description": "Identifies a list of preconditions for confirming the transportation option." }, "shipmentId": { "type": "string", "description": "Identifier of a shipment. A shipment contains the boxes and units being inbounded." }, "shippingMode": { "type": "string", "description": "Mode of shipment transportation that this option will provide. Possible values: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`." }, "shippingSolution": { "type": "string", "description": "Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`." }, "transportationOptionId": { "type": "string", "description": "Identifier of a transportation option. A transportation option represent one option for how to send a shipment." } }, "required": [ "carrier", "preconditions", "shipmentId", "shippingMode", "shippingSolution", "transportationOptionId" ] }, "description": "Transportation options generated for the placement option." } }, "required": [ "transportationOptions" ] }, "SpApiListTransportationOptionsSearchParams": { "type": "object", "properties": { "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "placementOptionId": { "type": "object" }, "shipmentId": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiPatchListingsItemBody": { "type": "object", "properties": { "productType": { "type": "string", "description": "The Amazon product type of the listings item.", "nullable": false }, "patches": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "replace", "merge", "delete" ], "description": "Type of JSON Patch operation. Supported JSON Patch operations include `add`, `replace`, `merge` and `delete`. Refer to .", "nullable": false }, "path": { "type": "string", "description": "JSON Pointer path of the element to patch. Refer to [JavaScript Object Notation (JSON) Patch](https://tools.ietf.org/html/rfc6902) for more information.", "nullable": false }, "value": { "type": [ "array", "null" ], "items": {}, "description": "JSON value to `add`, `replace`, `merge` or `delete`." } }, "required": [ "op", "path" ] }, "description": "One or more JSON Patch operations to perform on the listings item.", "nullable": false } }, "required": [ "productType", "patches" ] }, "SpApiPatchListingsItemErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses." } }, "required": [ "errors" ] }, "SpApiPatchListingsItemResponse": { "type": "object", "properties": { "sku": { "type": "string", "description": "A selling partner-provided identifier for an Amazon listing." }, "status": { "type": "string", "enum": [ "ACCEPTED", "INVALID", "VALID" ], "description": "The status of the listings item submission." }, "submissionId": { "type": "string", "description": "The unique identifier of the listings item submission." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] }, "description": "Listings item issues related to the listings item submission." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." } } }, "description": "Listings item issues related to the listings item submission." } }, "required": [ "sku", "status", "submissionId" ] }, "SpApiPatchListingsItemSearchParams": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" } }, "includedData": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "identifiers", "issues" ] } } ] }, "mode": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "VALIDATION_PREVIEW" ] } ] }, "issueLocale": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceIds", "mp" ] }, "SpApiPutListingsItemBody": { "type": "object", "properties": { "productType": { "type": "string", "description": "The listings item's Amazon product type.", "nullable": false }, "requirements": { "type": [ "string", "null" ], "enum": [ "LISTING", "LISTING_PRODUCT_ONLY", "LISTING_OFFER_ONLY" ], "description": "The name of the requirements set for the provided data." }, "attributes": { "description": "JSON object containing structured listings item attribute data keyed by attribute name.", "nullable": false } }, "required": [ "productType", "attributes" ] }, "SpApiPutListingsItemErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses." } }, "required": [ "errors" ] }, "SpApiPutListingsItemResponse": { "type": "object", "properties": { "sku": { "type": "string", "description": "A selling partner-provided identifier for an Amazon listing." }, "status": { "type": "string", "enum": [ "ACCEPTED", "INVALID", "VALID" ], "description": "The status of the listings item submission." }, "submissionId": { "type": "string", "description": "The unique identifier of the listings item submission." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] }, "description": "Listings item issues related to the listings item submission." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." } } }, "description": "Listings item issues related to the listings item submission." } }, "required": [ "sku", "status", "submissionId" ] }, "SpApiPutListingsItemSearchParams": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" } }, "includedData": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "identifiers", "issues" ] } } ] }, "mode": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "VALIDATION_PREVIEW" ] } ] }, "issueLocale": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceIds", "mp" ] }, "SpApiScheduleSelfShipAppointmentBody": { "type": "object", "properties": { "reasonComment": { "type": [ "string", "null" ], "enum": [ "APPOINTMENT_REQUESTED_BY_MISTAKE", "VEHICLE_DELAY", "SLOT_NOT_SUITABLE", "OUTSIDE_CARRIER_BUSINESS_HOURS", "UNFAVOURABLE_EXTERNAL_CONDITIONS", "PROCUREMENT_DELAY", "SHIPPING_PLAN_CHANGED", "INCREASED_QUANTITY", "OTHER" ] } } }, "SpApiScheduleSelfShipAppointmentErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiScheduleSelfShipAppointmentResponse": { "type": "object", "properties": { "selfShipAppointmentDetails": { "type": "object", "properties": { "appointmentId": { "type": "number", "description": "Identifier for appointment." }, "appointmentSlotTime": { "type": "object", "properties": { "endTime": { "type": "string", "description": "The end timestamp of the appointment in UTC." }, "startTime": { "type": "string", "description": "The start timestamp of the appointment in UTC." } }, "required": [ "endTime", "startTime" ], "description": "Identifier for appointment." }, "appointmentStatus": { "type": "string", "description": "Status of the appointment." } } } }, "required": [ "selfShipAppointmentDetails" ] }, "SpApiScheduleSelfShipAppointmentSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiSearchCatalogItemsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses returned when a request is unsuccessful." } }, "required": [ "errors" ] }, "SpApiSearchCatalogItemsResponse": { "type": "object", "properties": { "numberOfResults": { "type": "number", "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." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that you can use to retrieve the next page." }, "previousToken": { "type": "string", "description": "A token that you can use to retrieve the previous page." } }, "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." }, "refinements": { "type": "object", "properties": { "brands": { "type": "array", "items": { "type": "object", "properties": { "numberOfResults": { "type": "number", "description": "The estimated number of results that would be returned if you refine your search by the specified `brandName`." }, "brandName": { "type": "string", "description": "The brand name that you can use to refine your search." } }, "required": [ "numberOfResults", "brandName" ] }, "description": "A list of brands you can use to refine your search." }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "numberOfResults": { "type": "number", "description": "The estimated number of results that would be returned if you refine your search by the specified `classificationId`." }, "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "The identifier of the classification that you can use to refine your search." } }, "required": [ "numberOfResults", "displayName", "classificationId" ] }, "description": "A list of classifications you can use to refine your search." } }, "required": [ "brands", "classifications" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" }, "attributes": {}, "classifications": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ] }, "description": "Classifications (browse nodes) that are associated with the item in the Amazon catalog." } }, "required": [ "marketplaceId" ] } }, "dimensions": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "item": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } }, "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "package": { "type": "object", "properties": { "height": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "length": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } }, "width": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the dimension value." }, "value": { "type": "number", "description": "Numeric value of the dimension." } } } } } }, "required": [ "marketplaceId" ] } }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).identifier." }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "identifierType": { "type": "string", "description": "Type of identifier, such as UPC, EAN, or ISBN." }, "identifier": { "type": "string", "description": "Identifier of the item." } }, "required": [ "identifierType", "identifier" ] }, "description": "Identifiers associated with the item in the Amazon catalog for the indicated `marketplaceId`." } }, "required": [ "marketplaceId", "identifiers" ] } }, "images": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "images": { "type": "array", "items": { "type": "object", "properties": { "variant": { "type": "string", "enum": [ "MAIN", "PT01", "PT02", "PT03", "PT04", "PT05", "PT06", "PT07", "PT08", "SWCH" ], "description": "Variant of the image, such as `MAIN` or `PT01`." }, "link": { "type": "string", "description": "URL for the image." }, "height": { "type": "number", "description": "Height of the image in pixels." }, "width": { "type": "number", "description": "Width of the image in pixels." } }, "required": [ "variant", "link", "height", "width" ] }, "description": "Images for an item in the Amazon catalog, grouped by `marketplaceId`." } }, "required": [ "marketplaceId", "images" ] } }, "productTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "productType": { "type": "string", "description": "Name of the product type that is associated with the Amazon catalog item." } } } }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are children of this item." }, "parentAsins": { "type": "array", "items": { "type": "string" }, "description": "ASINs of the related items that are parents of this item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "Names of the Amazon catalog item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family." } }, "description": "ASINs of the related items that are parents of this item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "Type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the item." } }, "required": [ "marketplaceId", "relationships" ] } }, "salesRanks": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "classificationRanks": { "type": "array", "items": { "type": "object", "properties": { "classificationId": { "type": "string", "description": "Identifier of the classification that is associated with the sales rank." }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales category." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "classificationId", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification." }, "displayGroupRanks": { "type": "array", "items": { "type": "object", "properties": { "websiteDisplayGroup": { "type": "string", "description": "Name of the website display group that is associated with the sales rank" }, "title": { "type": "string", "description": "Name of the sales rank." }, "link": { "type": "string", "description": "Corresponding Amazon retail website URL for the sales rank." }, "rank": { "type": "number", "description": "Sales rank." } }, "required": [ "websiteDisplayGroup", "title", "rank" ] }, "description": "Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group." } }, "required": [ "marketplaceId" ] } }, "summaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "adultProduct": { "type": "boolean", "description": "When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature." }, "autographed": { "type": "boolean", "description": "When `true`, the Amazon catalog item is autographed." }, "brand": { "type": "string", "description": "Name of the brand that is associated with the Amazon catalog item." }, "browseClassification": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name for the classification." }, "classificationId": { "type": "string", "description": "Identifier of the classification." }, "parent": { "$ref": "#/components/schemas/catalogItems_2022_04_01_ItemBrowseClassification", "description": "Identifier of the classification." } }, "required": [ "displayName", "classificationId" ], "description": "Name of the brand that is associated with the Amazon catalog item." }, "color": { "type": "string", "description": "The color that is associated with the Amazon catalog item." }, "contributors": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name of the role in the requested locale, such as `Author` or `Actor`." }, "value": { "type": "string", "description": "Role value for the Amazon catalog item, such as `author` or `actor`." } }, "required": [ "value" ] }, "value": { "type": "string", "description": "Name of the contributor, such as `Jane Austen`." } }, "required": [ "role", "value" ] }, "description": "Individual contributors to the creation of the item, such as the authors or actors." }, "itemClassification": { "type": "string", "enum": [ "BASE_PRODUCT", "OTHER", "PRODUCT_BUNDLE", "VARIATION_PARENT" ], "description": "Classification type that is associated with the Amazon catalog item." }, "itemName": { "type": "string", "description": "The name that is associated with the Amazon catalog item." }, "manufacturer": { "type": "string", "description": "The name of the manufacturer that is associated with the Amazon catalog item." }, "memorabilia": { "type": "boolean", "description": "When true, the item is classified as memorabilia." }, "modelNumber": { "type": "string", "description": "The model number that is associated with the Amazon catalog item." }, "packageQuantity": { "type": "number", "description": "The quantity of the Amazon catalog item within one package." }, "partNumber": { "type": "string", "description": "The part number that is associated with the Amazon catalog item." }, "releaseDate": { "type": "string", "description": "The earliest date on which the Amazon catalog item can be shipped to customers." }, "size": { "type": "string", "description": "The name of the size of the Amazon catalog item." }, "style": { "type": "string", "description": "The name of the style that is associated with the Amazon catalog item." }, "tradeInEligible": { "type": "boolean", "description": "When true, the Amazon catalog item is eligible for trade-in." }, "websiteDisplayGroup": { "type": "string", "description": "The identifier of the website display group that is associated with the Amazon catalog item." }, "websiteDisplayGroupName": { "type": "string", "description": "The display name of the website display group that is associated with the Amazon catalog item." } }, "required": [ "marketplaceId" ] } }, "vendorDetails": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)." }, "brandCode": { "type": "string", "description": "The brand code that is associated with an Amazon catalog item." }, "manufacturerCode": { "type": "string", "description": "The manufacturer code that is associated with an Amazon catalog item." }, "manufacturerCodeParent": { "type": "string", "description": "The parent vendor code of the manufacturer code." }, "productCategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The parent vendor code of the manufacturer code." }, "productGroup": { "type": "string", "description": "The product group that is associated with an Amazon catalog item." }, "productSubcategory": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The display name of the product category or subcategory." }, "value": { "type": "string", "description": "The code that identifies the product category or subcategory." } }, "description": "The product group that is associated with an Amazon catalog item." }, "replenishmentCategory": { "type": "string", "enum": [ "ALLOCATED", "BASIC_REPLENISHMENT", "IN_SEASON", "LIMITED_REPLENISHMENT", "MANUFACTURER_OUT_OF_STOCK", "NEW_PRODUCT", "NON_REPLENISHABLE", "NON_STOCKUPABLE", "OBSOLETE", "PLANNED_REPLENISHMENT" ], "description": "The replenishment category that is associated with an Amazon catalog item." } }, "required": [ "marketplaceId" ] } } }, "required": [ "asin" ] }, "description": "A list of items from the Amazon catalog." } }, "required": [ "numberOfResults", "items" ] }, "SpApiSearchDefinitionsProductTypesErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses." } }, "required": [ "errors" ] }, "SpApiSearchDefinitionsProductTypesResponse": { "type": "object", "properties": { "productTypes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Amazon product type." }, "displayName": { "type": "string", "description": "Human-readable and localized description of the Amazon product type." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "The Amazon marketplace identifiers for which the product type definition is available." } }, "required": [ "name", "displayName", "marketplaceIds" ] }, "description": "A list of product types." }, "productTypeVersion": { "type": "string", "description": "Amazon product type version identifier." } }, "required": [ "productTypes", "productTypeVersion" ] }, "SpApiSearchDefinitionsProductTypesSearchParams": { "type": "object", "properties": { "keywords": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "marketplaceIds": { "type": "object" }, "itemName": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "locale": { "type": "object" }, "searchLocale": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceIds", "mp" ] }, "SpApiSearchListingsItemsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of error responses." } }, "required": [ "errors" ] }, "SpApiSearchListingsItemsResponse": { "type": "object", "properties": { "numberOfResults": { "type": "number", "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." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that can be used to fetch the next page." }, "previousToken": { "type": "string", "description": "A token that can be used to fetch the previous page." } }, "description": "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." }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "description": "A selling partner-provided identifier for an Amazon listing." }, "summaries": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "A marketplace identifier. Identifies the listings item's Amazon store." }, "asin": { "type": "string", "description": "The ASIN of the listings item." }, "productType": { "type": "string", "description": "The listings item's Amazon product type." }, "conditionType": { "type": "string", "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" ], "description": "Identifies the condition of the listings item." }, "status": { "type": "array", "items": { "type": "object" }, "description": "Statuses that apply to the listings item." }, "fnSku": { "type": "string", "description": "Fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item." }, "itemName": { "type": "string", "description": "Name, or title, associated with an Amazon catalog item." }, "createdDate": { "type": "string", "description": "Date the listings item was created, in ISO 8601 format." }, "lastUpdatedDate": { "type": "string", "description": "Date the listings item was last updated, in ISO 8601 format." }, "mainImage": { "type": "object", "properties": { "link": { "type": "string", "description": "The image's link or URL." }, "height": { "type": "number", "description": "The image's height, in pixels." }, "width": { "type": "number", "description": "The image's width, in pixels." } }, "required": [ "link", "height", "width" ], "description": "Date the listings item was last updated, in ISO 8601 format." } }, "required": [ "marketplaceId", "productType", "status", "createdDate", "lastUpdatedDate" ] }, "description": "A selling partner-provided identifier for an Amazon listing." }, "attributes": {}, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "enum": [ "ERROR", "WARNING", "INFO" ], "description": "The severity of the issue." }, "attributeNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the attributes that are associated with the issue, if applicable." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of issue categories." }, "enforcements": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item's buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results." } }, "required": [ "action" ] }, "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." }, "exemption": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "EXEMPT", "EXEMPT_UNTIL_EXPIRY_DATE", "NOT_EXEMPT" ], "description": "Indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied." }, "expiryDate": { "type": "string", "description": "Represents the timestamp, in ISO 8601 format, that specifies the date when the temporary exemptions expires, and Amazon begins enforcing the listed actions." } }, "required": [ "status" ], "description": "List of enforcement actions taken by Amazon that affect the publishing or status of a listing." } }, "required": [ "actions", "exemption" ], "description": "List of issue categories." }, "marketplaceIds": { "type": "array", "items": { "type": "string" }, "description": "List of Amazon store identifiers." } }, "required": [ "code", "message", "severity", "categories" ] } }, "offers": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "offerType": { "type": "string", "enum": [ "B2C", "B2B" ], "description": "The listings item's offer type." }, "price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ], "description": "The listings item's offer type." }, "points": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "The number of Amazon Points offered with the purchase of an item, and their monetary value." } }, "required": [ "pointsNumber" ] }, "audience": { "type": "object", "properties": { "value": { "type": "string", "description": "Name of the audience an offer is applicable to. Common values: * 'ALL' - Standard offer audience for buyers on Amazon retail websites. * 'B2B' - Offer audience for Amazon Business website buyers." }, "displayName": { "type": "string", "description": "Localized display name for the audience." } } } }, "required": [ "marketplaceId", "offerType", "price" ] } }, "fulfillmentAvailability": { "type": "array", "items": { "type": "object", "properties": { "fulfillmentChannelCode": { "type": "string", "description": "Designates which fulfillment network is used." }, "quantity": { "type": "number", "description": "The item quantity that you're making available for sale." } }, "required": [ "fulfillmentChannelCode" ] }, "description": "The listings item's fulfillment availability." }, "procurement": { "type": "array", "items": { "type": "object", "properties": { "costPrice": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." }, "amount": { "type": "string", "description": "Three-digit currency code. In ISO 4217 format." } }, "required": [ "currencyCode", "amount" ] } }, "required": [ "costPrice" ] }, "description": "The listings item's vendor procurement information." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "childSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are children of this listing item." }, "parentSkus": { "type": "array", "items": { "type": "string" }, "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "variationTheme": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "string" }, "description": "The names of the listing item attributes that are associated with the variation theme." }, "theme": { "type": "string", "description": "The variation theme that indicates the combination of listing item attributes that define the variation family." } }, "required": [ "attributes", "theme" ], "description": "Identifiers (SKUs) of the related items that are parents of this listing item." }, "type": { "type": "string", "enum": [ "VARIATION", "PACKAGE_HIERARCHY" ], "description": "The type of relationship." } }, "required": [ "type" ] }, "description": "Relationships for the listing item." } }, "required": [ "marketplaceId", "relationships" ] }, "description": "The listings item's vendor procurement information." }, "productTypes": { "type": "array", "items": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "Amazon store identifier." }, "productType": { "type": "string", "description": "The name of the product type that is submitted by the Selling Partner." } }, "required": [ "marketplaceId", "productType" ] } } }, "required": [ "sku" ] }, "description": "A list of listings items." } }, "required": [ "numberOfResults", "items" ] }, "SpApiSearchListingsItemsSearchParams": { "type": "object", "properties": { "marketplaceIds": { "type": "array", "items": { "type": "string" } }, "issueLocale": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "includedData": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "attributes", "productTypes", "relationships", "summaries", "issues", "offers", "fulfillmentAvailability", "procurement" ] } } ] }, "identifiers": { "oneOf": [ { "type": "object" }, { "type": "object" } ] }, "identifiersType": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ASIN" ] }, { "type": "string", "enum": [ "EAN" ] }, { "type": "string", "enum": [ "GTIN" ] }, { "type": "string", "enum": [ "ISBN" ] }, { "type": "string", "enum": [ "JAN" ] }, { "type": "string", "enum": [ "MINSAN" ] }, { "type": "string", "enum": [ "SKU" ] }, { "type": "string", "enum": [ "UPC" ] }, { "type": "string", "enum": [ "FNSKU" ] } ] }, "variationParentSku": { "type": "object" }, "packageHierarchySku": { "type": "object" }, "createdAfter": { "type": "object" }, "createdBefore": { "type": "object" }, "lastUpdatedAfter": { "type": "object" }, "lastUpdatedBefore": { "type": "object" }, "withIssueSeverity": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "ERROR", "WARNING" ] } } ] }, "withStatus": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "BUYABLE", "DISCOVERABLE" ] } } ] }, "withoutStatus": { "type": "object" }, "sortBy": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "sku" ] }, { "type": "string", "enum": [ "createdDate" ] }, { "type": "string", "enum": [ "lastUpdatedDate" ] } ] }, "sortOrder": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ASC" ] }, { "type": "string", "enum": [ "DESC" ] } ] }, "pageSize": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "pageToken": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceIds", "mp" ] }, "SpApiSearchOrdersErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "A list of errors." } }, "required": [ "errors" ] }, "SpApiSearchOrdersResponse": { "type": "object", "properties": { "orders": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "An Amazon-defined order identifier." }, "orderAliases": { "type": "array", "items": { "type": "object", "properties": { "aliasId": { "type": "string", "description": "The alternative identifier value that can be used to reference this order." }, "aliasType": { "type": "string", "description": "The kind of alternative identifier this represents. **Possible values**: `SELLER_ORDER_ID`" } }, "required": [ "aliasId", "aliasType" ] }, "description": "Alternative identifiers that can be used to reference this order, such as seller-defined order numbers." }, "createdTime": { "type": "string", "description": "The time when the customer placed the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "lastUpdatedTime": { "type": "string", "description": "The most recent time when any aspect of this order was modified by Amazon or the seller. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "programs": { "type": "array", "items": { "type": "string" }, "description": "Special programs associated with this order that may affect fulfillment or customer experience. **Possible values**: `AMAZON_BAZAAR`, `AMAZON_BUSINESS`, `AMAZON_EASY_SHIP`, `AMAZON_HAUL`, `DELIVERY_BY_AMAZON`, `FBM_SHIP_PLUS`, `INVOICE_BY_AMAZON`, `IN_STORE_PICK_UP`, `PREMIUM`, `PREORDER`, `PRIME`" }, "associatedOrders": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The unique identifier of the related order that is associated with the current order." }, "associationType": { "type": "string", "description": "The relationship between the current order and the associated order. **Possible values**: `REPLACEMENT_ORIGINAL_ID`, `EXCHANGE_ORIGINAL_ID`" } } }, "description": "Other orders that have a direct relationship to this order, such as replacement or exchange orders." }, "salesChannel": { "type": "object", "properties": { "channelName": { "type": "string", "description": "The name of the sales platform or channel where the customer placed this order. **Possible values**: `AMAZON`, `NON_AMAZON`" }, "marketplaceId": { "type": "string", "description": "The unique identifier for the specific marketplace within the sales channel where this order was placed." }, "marketplaceName": { "type": "string", "description": "The human-readable name of the marketplace where this order was placed." } }, "required": [ "channelName" ], "description": "Other orders that have a direct relationship to this order, such as replacement or exchange orders." }, "buyer": { "type": "object", "properties": { "buyerName": { "type": "string", "description": "The full name of the customer who placed the order." }, "buyerEmail": { "type": "string", "description": "The anonymized email address of the buyer. **Note:** Only available for merchant-fulfilled (FBM) orders." }, "buyerCompanyName": { "type": "string", "description": "The name of the company or organization for a business order." }, "buyerPurchaseOrderNumber": { "type": "string", "description": "The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } } }, "recipient": { "type": "object", "properties": { "deliveryAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } } }, "deliveryPreference": { "type": "object", "properties": { "dropOffLocation": { "type": "string", "description": "The drop-off location selected by the customer." }, "addressInstruction": { "type": "string", "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryTime": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "enum": [ "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT" ], "description": "Specific day of the week for which operating hours are being defined." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Collection of time windows during which the location is available for deliveries on the specified day." } } }, "description": "Business hours when the business is open for deliveries." }, "exceptionDates": { "type": "array", "items": { "type": "object", "properties": { "exceptionDate": { "type": "string", "description": "Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity." }, "exceptionDateType": { "type": "string", "enum": [ "CLOSED", "OPEN" ], "description": "Operational status of the business on the specified exception date." }, "timeWindows": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } }, "endTime": { "type": "object", "properties": { "hour": { "type": "number", "description": "The hour when the business opens or closes, in 24-hour format (0-23)." }, "minute": { "type": "number", "description": "The minute when the business opens or closes." } } } } }, "description": "Alternative operating hours that apply specifically to this exception date." } } }, "description": "Specific dates within the next 30 days when normal business hours do not apply." } }, "description": "Building instructions, nearby landmark, or navigation instructions." }, "deliveryCapabilities": { "type": "array", "items": { "type": "string" }, "description": "A list of miscellaneous delivery capabilities associated with the shipping address." } } } } }, "proceeds": { "type": "object", "properties": { "grandTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The proceeds category. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `TAX`, `DISCOUNT`, `DELIVERY_TIP`, `OTHER`. **Note:** `DELIVERY_TIP` is charged separately and not attributed to a specific item. The remaining categories are aggregated across all order items." }, "status": { "type": "string", "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The processing status of the charge. Only present for categories processed separately after checkout, such as `DELIVERY_TIP`. **Possible values**: `PENDING`, `FINALIZED`." } }, "required": [ "type", "subtotal" ] }, "description": "Categorized proceeds for the order. Proceed categories are either aggregated across all order items (such as `ITEM`, `SHIPPING`, and `TAX`) or applied at the order level (such as `DELIVERY_TIP`)." } } }, "payment": { "type": "object", "properties": { "paymentExecutions": { "type": "array", "items": { "type": "object", "properties": { "paymentMethod": { "type": "string", "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "paymentAmount": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "The payment method used for this payment execution (for example, CashOnDelivery, ConvenienceStore, CreditCard, Invoice, Pix, and so on)." }, "acquirerId": { "type": "string", "description": "The unique identifier of the payment processor or acquiring bank that authorizes the payment. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." }, "cardBrand": { "type": "string", "description": "The card network or brand used in the payment transaction (for example, Visa or Mastercard). **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard`." }, "authorizationCode": { "type": "string", "description": "The unique code that confirms the payment authorization. **Note**: This attribute is only available for orders in the Brazil (BR) marketplace when the `paymentMethod` is `CreditCard` or `Pix`." } } }, "description": "A list of payment executions for the order." } } }, "tax": { "type": "object", "properties": { "taxRegistrations": { "type": "array", "items": { "type": "object", "properties": { "entityType": { "type": "string", "description": "The type of entity that the tax registration belongs to. **Possible values**: - `BUYER` (Indicates that this is the buyer's tax registration information) - `MERCHANT` (Indicates that this is the merchant's tax registration information) - `MARKETPLACE` (Indicates that this is the marketplace's tax registration information)" }, "legalName": { "type": "string", "description": "The legal name associated with the tax registration." }, "taxRegistrationType": { "type": "string", "description": "The type of the tax registration number. **Possible values**: `BUSINESS`, `VAT`, `CST`, `CPF`, `CNPJ`" }, "taxRegistrationNumber": { "type": "string", "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The full name of the person who will receive the delivery at this address." }, "companyName": { "type": "string", "description": "The name of the business or organization at this address." }, "addressLine1": { "type": "string", "description": "The primary street address." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code, ZIP code, or equivalent mailing code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code identifying the country of the address, in ISO 3166-1 format." }, "phone": { "type": "string", "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "extendedFields": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street." }, "streetNumber": { "type": "string", "description": "The house, building, or property number associated with the location's street address." }, "complement": { "type": "string", "description": "The floor number / unit number." }, "neighborhood": { "type": "string", "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, "description": "The contact phone number for delivery coordination and customer communication. **Note**: The buyer phone number will be suppressed in some cases, including but not limited to: - All FBA (Fulfillment by Amazon) orders. - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date." }, "addressType": { "type": "string", "description": "The type of location. **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`" } }, "description": "The tax registration number that identifies the entity for tax purposes." }, "taxRegistrationAttributes": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the tax registration attribute. **Possible values**: `TAX_OFFICE`" }, "value": { "type": "string", "description": "The value of the tax registration attribute." } } }, "description": "Additional attributes related to the tax registration." } } }, "description": "A list of tax registrations associated with the order." }, "taxInvoicing": { "type": "object", "properties": { "buyerInvoicePreference": { "type": "string", "description": "The buyer's invoicing preference, which indicates whether the seller should issue an individual or a business invoice to the buyer. **Note**: This attribute is only available in the Turkey marketplace. **Possible values**: - `INDIVIDUAL` (Issues an individual invoice to the buyer) - `BUSINESS` (Issues a business invoice to the buyer)" }, "invoiceStatus": { "type": "string", "description": "The status of the invoice. Only available for Easy Ship orders and orders in the Brazil marketplace. **Possible values**: - `NOT_REQUIRED` (The order does not require an electronic invoice to be uploaded) - `NOT_FOUND` (The order requires an electronic invoice but it is not uploaded) - `PROCESSING` (The required electronic invoice was uploaded and is processing) - `ERRORED` (The uploaded electronic invoice was not accepted) - `ACCEPTED` (The uploaded electronic invoice was accepted)" } }, "description": "A list of tax registrations associated with the order." } } }, "fulfillment": { "type": "object", "properties": { "fulfillmentStatus": { "type": "string", "enum": [ "PENDING_AVAILABILITY", "PENDING", "UNSHIPPED", "PARTIALLY_SHIPPED", "SHIPPED", "CANCELLED", "UNFULFILLABLE" ] }, "fulfilledBy": { "type": "string", "description": "Specifies whether Amazon or the merchant is responsible for fulfilling this order. **Possible values**: `AMAZON`, `MERCHANT`." }, "fulfillmentServiceLevel": { "type": "string", "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "shipByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } }, "description": "The category of the shipping speed option selected by the customer at checkout. **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`." }, "deliverByWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "labelPrintingWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } } }, "required": [ "fulfillmentStatus" ] }, "orderItems": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "A unique identifier for this specific item within the order." }, "quantityOrdered": { "type": "number", "description": "The number of units of this item that the customer ordered." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "The number of units of this item that the customer ordered." }, "associatedOrderItems": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The order identifier of the associated order item." }, "orderItemId": { "type": "string", "description": "The order item identifier of the associated order item." }, "associationType": { "type": "string", "description": "The type of association between the order items. **Possible values**: - `VALUE_ADD_SERVICE` (The associated item is a service order)" } } }, "description": "A list of order items associated with this item. For example, a value-add service purchased with the product." }, "programs": { "type": "array", "items": { "type": "string" }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "product": { "type": "object", "properties": { "asin": { "type": "string" }, "title": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "sellerSku": { "type": "string", "description": "The product name or title as displayed to customers in the marketplace." }, "condition": { "type": "object", "properties": { "conditionType": { "type": "string", "description": "The primary condition category that broadly describes the item's state. **Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`." }, "conditionSubtype": { "type": "string", "description": "A more specific condition classification that provides additional detail about the item's quality within the main condition type. **Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`, `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`." }, "conditionNote": { "type": "string", "description": "Additional details provided by the seller to describe the specific condition of this particular item." } } }, "price": { "type": "object", "properties": { "unitPrice": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "priceDesignation": { "type": "string", "description": "Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Possible value**: `BUSINESS_PRICE`" } } }, "serialNumbers": { "type": "array", "items": { "type": "string" }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." }, "customization": { "type": "object", "properties": { "customizedUrl": { "type": "string", "description": "The URL of the customized data for custom orders from the Amazon Custom program." } }, "description": "Unique serial numbers for products that require individual tracking, typically provided for FBA orders." } }, "description": "Special programs that apply specifically to this item within the order. **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`" }, "proceeds": { "type": "object", "properties": { "proceedsTotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ] }, "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Category classification of the proceeds breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`" }, "detailedBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "subtype": { "type": "string", "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" }, "value": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Specific classification of the further granular breakdown. **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`" } } }, "description": "Further granular breakdown of the subtotal." } }, "required": [ "type", "subtotal" ] }, "description": "The breakdown of proceeds." } } }, "expense": { "type": "object", "properties": { "pointsCost": { "type": "object", "properties": { "pointsGranted": { "type": "object", "properties": { "pointsNumber": { "type": "number", "description": "Total number of Amazon Points granted to the customer's account for this item purchase." }, "pointsMonetaryValue": { "type": "object", "properties": { "amount": { "type": "string" }, "currencyCode": { "type": "string", "description": "The three-letter currency code that identifies the currency type, following ISO 4217 international standards." } }, "required": [ "amount", "currencyCode" ], "description": "Total number of Amazon Points granted to the customer's account for this item purchase." } } } } } } }, "promotion": { "type": "object", "properties": { "breakdowns": { "type": "array", "items": { "type": "object", "properties": { "promotionId": { "type": "string", "description": "Unique identifier for the promotion applied to this item." } } }, "description": "A list of promotions applied to the order item." } } }, "cancellation": { "type": "object", "properties": { "cancellationRequest": { "type": "object", "properties": { "requester": { "type": "string", "description": "Entity that initiated the cancellation request for this item. **Possible values**: `BUYER`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was requested." } } }, "cancellationExecution": { "type": "object", "properties": { "cancelledBy": { "type": "string", "description": "Entity that executed the cancellation for this item. **Possible values**: `BUYER`, `MERCHANT`, `AMAZON`" }, "cancelReason": { "type": "string", "description": "Explanation provided for why the cancellation was executed." } } } } }, "fulfillment": { "type": "object", "properties": { "quantityFulfilled": { "type": "number", "description": "The number of units of this item that have been successfully processed and shipped." }, "quantityUnfulfilled": { "type": "number", "description": "The number of units of this item that remain to be processed and shipped." }, "picking": { "type": "object", "properties": { "substitutionPreference": { "type": "object", "properties": { "substitutionType": { "type": "string", "enum": [ "CUSTOMER_PREFERENCE", "AMAZON_RECOMMENDED", "DO_NOT_SUBSTITUTE" ], "description": "Source and nature of the substitution preferences for this item." }, "substitutionOptions": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "Amazon Standard Identification Number of the substitute product." }, "quantityOrdered": { "type": "number", "description": "Number of units of the substitute item to be selected if substitution occurs." }, "sellerSku": { "type": "string", "description": "The item's seller stock keeping unit (SKU)." }, "title": { "type": "string", "description": "Product name or title of the substitute item as displayed to customers." }, "measurement": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "OUNCES", "POUNDS", "KILOGRAMS", "GRAMS", "MILLIGRAMS", "INCHES", "FEET", "METERS", "CENTIMETERS", "MILLIMETERS", "SQUARE_METERS", "SQUARE_CENTIMETERS", "SQUARE_FEET", "SQUARE_INCHES", "GALLONS", "PINTS", "QUARTS", "FLUID_OUNCES", "LITERS", "CUBIC_METERS", "CUBIC_FEET", "CUBIC_INCHES", "CUBIC_CENTIMETERS", "COUNT" ], "description": "The specific unit of measurement used to quantify this item." }, "value": { "type": "number", "description": "The numerical quantity or amount being measured in the specified unit." } }, "required": [ "unit", "value" ], "description": "Product name or title of the substitute item as displayed to customers." } } }, "description": "List of alternative products that can be substituted for the original item if it becomes unavailable." } }, "required": [ "substitutionType" ] } }, "description": "The number of units of this item that remain to be processed and shipped." }, "packing": { "type": "object", "properties": { "giftOption": { "type": "object", "properties": { "giftMessage": { "type": "string", "description": "Personal message from the buyer to be included with the gift-wrapped item." }, "giftWrapLevel": { "type": "string", "description": "Type or quality level of gift wrapping service selected by the customer." } } }, "serialNumberRequirement": { "type": "object", "properties": { "requirementType": { "type": "string", "description": "The requirement type for this request. **Possible values**: `REQUIRED`" } } } } }, "shipping": { "type": "object", "properties": { "scheduledDeliveryWindow": { "type": "object", "properties": { "earliestDateTime": { "type": "string", "description": "The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "latestDateTime": { "type": "string", "description": "The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } } }, "shippingConstraints": { "type": "object", "properties": { "palletDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "cashOnDelivery": { "type": "string", "enum": [ "MANDATORY" ] }, "signatureConfirmation": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientIdentityVerification": { "type": "string", "enum": [ "MANDATORY" ] }, "recipientAgeVerification": { "type": "string", "enum": [ "MANDATORY" ] } } }, "internationalShipping": { "type": "object", "properties": { "iossNumber": { "type": "string", "description": "Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale." } } } } } } }, "tax": { "type": "object", "properties": { "taxCalculationBreakdowns": { "type": "array", "items": { "type": "object", "properties": { "reportingScheme": { "type": "string", "description": "The tax reporting scheme applied to this order item. **Possible values**: - `UOSS` (Union one stop shop. The item being purchased is held in the EU for shipment) - `IOSS` (Import one stop shop. The item being purchased is not held in the EU for shipment)" } } }, "description": "A list of tax calculation breakdowns for the order item." }, "taxCollections": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "description": "The tax collection model applied to the item. **Possible values**: - `MARKETPLACE_FACILITATOR` (Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller)" }, "responsibleParty": { "type": "string", "description": "The party responsible for withholding the taxes and remitting them to the taxing authority." } } }, "description": "A list of tax collections for the order item." } } } }, "required": [ "orderItemId", "quantityOrdered", "product" ] }, "description": "The list of all order items included in this order." }, "packages": { "type": "array", "items": { "type": "object", "properties": { "packageReferenceId": { "type": "string", "description": "A unique identifier for this package within the context of the order." }, "createdTime": { "type": "string", "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "packageStatus": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "IN_TRANSIT", "SHIPPED", "DELIVERED", "CANCELLED", "UNDELIVERABLE" ], "description": "Primary status classification of the package in the shipping workflow." }, "detailedStatus": { "type": "string", "description": "Granular status information providing specific details about the package's current location and handling stage. **Possible values**: - `PENDING_SCHEDULE` (Package awaiting pickup scheduling) - `PENDING_PICK_UP` (Package ready for carrier collection from seller) - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier) - `LABEL_CANCELLED` (Shipping label canceled by seller) - `PICKED_UP` (Package collected by carrier from seller location) - `DROPPED_OFF` (Package delivered to carrier by seller) - `AT_ORIGIN_FC` (Package at originating fulfillment center) - `AT_DESTINATION_FC` (Package at destination fulfillment center) - `DELIVERED` (Package successfully delivered to recipient) - `REJECTED_BY_BUYER` (Package refused by intended recipient) - `UNDELIVERABLE` (Package cannot be delivered due to address or access issues) - `RETURNING_TO_SELLER` (Package in transit back to seller) - `RETURNED_TO_SELLER` (Package successfully returned to seller) - `LOST` (Package location unknown or confirmed lost) - `OUT_FOR_DELIVERY` (Package on delivery vehicle for final delivery) - `DAMAGED` (Package damaged during transit)" } }, "required": [ "status" ], "description": "The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "carrier": { "type": "string", "description": "The carrier responsible for transporting this package to the customer." }, "shipTime": { "type": "string", "description": "The exact time when this package was handed over to the carrier and began its journey to the customer. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "shippingService": { "type": "string", "description": "The specific shipping method or service used for delivering this package." }, "trackingNumber": { "type": "string", "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "shipFromAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the business or facility at this address." }, "addressLine1": { "type": "string", "description": "The primary street address of the merchant's location." }, "addressLine2": { "type": "string", "description": "Additional address information." }, "addressLine3": { "type": "string", "description": "Additional address information." }, "city": { "type": "string", "description": "The city of the address." }, "districtOrCounty": { "type": "string", "description": "The district or county of the address." }, "stateOrRegion": { "type": "string", "description": "The state, province, or region of the address." }, "municipality": { "type": "string", "description": "The municipality of the address." }, "postalCode": { "type": "string", "description": "The postal code or ZIP code of the address." }, "countryCode": { "type": "string", "description": "The two-letter country code for the address, in ISO 3166-1 format." } }, "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress." }, "packageItems": { "type": "array", "items": { "type": "object", "properties": { "orderItemId": { "type": "string", "description": "Unique identifier of the order item included in this package." }, "quantity": { "type": "number", "description": "Number of units of this item included in the package shipment." }, "transparencyCodes": { "type": "array", "items": { "type": "string" }, "description": "The transparency codes associated with this item for product authentication." } }, "required": [ "orderItemId", "quantity" ] }, "description": "A list of all order items included in this specific package." } }, "required": [ "packageReferenceId" ] }, "description": "Shipping packages created for this order, including tracking information. **Note:** Only available for merchant-fulfilled (FBM) orders." }, "fulfillmentOrders": { "type": "array", "items": { "type": "object", "properties": { "fulfillmentOrderId": { "type": "string", "description": "The Fulfillment Order ID assigned by Amazon after fulfillment planning. This identifier is identical to the Shipment ID required by External Fulfillment APIs." } }, "required": [ "fulfillmentOrderId" ] }, "description": "The list of fulfillment orders associated with this customer order. Each entry corresponds to one fulfillment unit created by Amazon for this order. **Note:** Only available for EasyShip orders at present." } }, "required": [ "orderId", "createdTime", "lastUpdatedTime", "salesChannel", "orderItems" ] }, "description": "An array containing all orders that match the search criteria." }, "pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that can be used to fetch the next page of results." } }, "description": "An array containing all orders that match the search criteria." }, "lastUpdatedBefore": { "type": "string", "description": "Only orders updated before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "createdBefore": { "type": "string", "description": "Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } }, "required": [ "orders" ] }, "SpApiSearchOrdersSearchParams": { "type": "object", "properties": { "createdAfter": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "createdBefore": { "type": "object" }, "lastUpdatedAfter": { "type": "object" }, "lastUpdatedBefore": { "type": "object" }, "fulfillmentStatuses": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "SHIPPED", "CANCELLED", "PENDING_AVAILABILITY", "PENDING", "UNSHIPPED", "PARTIALLY_SHIPPED", "UNFULFILLABLE" ] } } ] }, "marketplaceIds": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "fulfilledBy": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "MERCHANT", "AMAZON" ] } } ] }, "maxResultsPerPage": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "paginationToken": { "type": "object" }, "includedData": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "BUYER", "RECIPIENT", "PROCEEDS", "EXPENSE", "PROMOTION", "CANCELLATION", "FULFILLMENT", "PACKAGES", "TAX", "PAYMENT", "FULFILLMENT_ORDERS" ] } } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiSendTestNotificationBody": { "type": "object", "properties": { "destinationId": { "type": [ "string", "null" ], "description": "The identifier for the destination where notifications will be delivered." }, "testNotification": { "type": [ "object", "null" ], "properties": { "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification.", "nullable": false }, "testScenario": { "type": [ "string", "null" ], "description": "The scenario of the specified notification to be used in the notification payload. If testScenario is empty, a 400 response will be returned back to the developer. The scenarios supported for each notification type can be found in the Selling Partner API Developer Guide." } }, "required": [ "payloadVersion" ], "description": "The identifier for the destination where notifications will be delivered." } } }, "SpApiSendTestNotificationErrorResponse": { "type": "object", "properties": { "payload": { "description": "The payload for the `sendTestNotification` operation." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "The payload for the `sendTestNotification` operation." } } }, "SpApiSendTestNotificationResponse": { "type": "object", "properties": { "payload": { "description": "The payload for the `sendTestNotification` operation." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "required": [ "code", "message" ] }, "description": "The payload for the `sendTestNotification` operation." } } }, "SpApiSendTestNotificationSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiSetPackingInformationBody": { "type": "object", "properties": { "packageGroupings": { "type": "array", "items": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "contentInformationSource": { "type": "string", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "nullable": false }, "dimensions": { "type": "object", "properties": { "height": { "type": "number", "description": "The height of a package.", "nullable": false }, "length": { "type": "number", "description": "The length of a package.", "nullable": false }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package.", "nullable": false }, "width": { "type": "number", "description": "The width of a package.", "nullable": false } }, "required": [ "height", "length", "unitOfMeasurement", "width" ], "nullable": false }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box." }, "labelOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "prepOwner": { "type": "string", "enum": [ "AMAZON", "SELLER", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier of a specific SKU.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units of the specified MSKU that will be shipped.", "nullable": false } }, "required": [ "labelOwner", "msku", "prepOwner", "quantity" ] }, "description": "The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`." }, "quantity": { "type": "number", "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false }, "weight": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ], "nullable": false }, "value": { "type": "number", "description": "Value of a weight.", "nullable": false } }, "required": [ "unit", "value" ], "description": "The number of containers where all other properties like weight or dimensions are identical.", "nullable": false } }, "required": [ "contentInformationSource", "dimensions", "quantity", "weight" ] }, "description": "Box level information being provided.", "nullable": false }, "packingGroupId": { "type": [ "string", "null" ], "description": "The ID of the `packingGroup` that packages are grouped according to. The `PackingGroupId` can only be provided before placement confirmation, and it must belong to the confirmed `PackingOption`. One of `ShipmentId` or `PackingGroupId` must be provided with every request." }, "shipmentId": { "type": [ "string", "null" ], "description": "The ID of the shipment that packages are grouped according to. The `ShipmentId` can only be provided after placement confirmation, and the shipment must belong to the confirmed placement option. One of `ShipmentId` or `PackingGroupId` must be provided with every request." } }, "required": [ "boxes" ] }, "description": "List of packing information for the inbound plan.", "nullable": false } }, "required": [ "packageGroupings" ] }, "SpApiSetPackingInformationErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiSetPackingInformationResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiSetPackingInformationSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiSetPrepDetailsBody": { "type": "object", "properties": { "marketplaceId": { "type": "string", "description": "The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "nullable": false }, "mskuPrepDetails": { "type": "array", "items": { "type": "object", "properties": { "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category.", "nullable": false } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "description": "A list of MSKUs and related prep details.", "nullable": false } }, "required": [ "marketplaceId", "mskuPrepDetails" ] }, "SpApiSetPrepDetailsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiSetPrepDetailsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiSetPrepDetailsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiUpdateInboundPlanNameBody": { "type": "object", "properties": { "name": { "type": "string", "description": "A human-readable name to update the inbound plan name to.", "nullable": false } }, "required": [ "name" ] }, "SpApiUpdateInboundPlanNameErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiUpdateInboundPlanNameSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiUpdateItemComplianceDetailsBody": { "type": "object", "properties": { "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false }, "taxDetails": { "type": "object", "properties": { "declaredValue": { "type": [ "object", "null" ], "properties": { "amount": { "type": "number", "description": "Decimal value of the currency.", "nullable": false }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code.", "nullable": false } }, "required": [ "amount", "code" ] }, "hsnCode": { "type": [ "string", "null" ], "description": "Harmonized System of Nomenclature code." }, "taxRates": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "cessRate": { "type": [ "number", "null" ], "description": "Rate of cess tax." }, "gstRate": { "type": [ "number", "null" ], "description": "Rate of gst tax." }, "taxType": { "type": [ "string", "null" ], "description": "Type of tax. Possible values: `CGST`, `SGST`, `IGST`, `TOTAL_TAX`." } } }, "description": "List of tax rates." } }, "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false } }, "required": [ "msku", "taxDetails" ] }, "SpApiUpdateItemComplianceDetailsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiUpdateItemComplianceDetailsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiUpdateItemComplianceDetailsSearchParams": { "type": "object", "properties": { "marketplaceId": { "type": "string" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "marketplaceId", "mp" ] }, "SpApiUpdateShipmentNameBody": { "type": "object", "properties": { "name": { "type": "string", "description": "A human-readable name to update the shipment name to.", "nullable": false } }, "required": [ "name" ] }, "SpApiUpdateShipmentNameErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiUpdateShipmentNameSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiUpdateShipmentSourceAddressBody": { "type": "object", "properties": { "address": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Street address information.", "nullable": false }, "addressLine2": { "type": [ "string", "null" ], "description": "Additional street address information." }, "city": { "type": "string", "description": "The city.", "nullable": false }, "companyName": { "type": [ "string", "null" ], "description": "The name of the business." }, "countryCode": { "type": "string", "description": "The country code in two-character ISO 3166-1 alpha-2 format.", "nullable": false }, "districtOrCounty": { "type": [ "string", "null" ], "description": "The district or county." }, "email": { "type": [ "string", "null" ], "description": "The email address." }, "name": { "type": "string", "description": "The name of the individual who is the primary contact.", "nullable": false }, "phoneNumber": { "type": "string", "description": "The phone number.", "nullable": false }, "postalCode": { "type": "string", "description": "The postal code.", "nullable": false }, "stateOrProvinceCode": { "type": [ "string", "null" ], "description": "The state or province code." } }, "required": [ "addressLine1", "city", "countryCode", "name", "phoneNumber", "postalCode" ], "nullable": false } }, "required": [ "address" ] }, "SpApiUpdateShipmentSourceAddressErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiUpdateShipmentSourceAddressResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiUpdateShipmentSourceAddressSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "SpApiUpdateShipmentTrackingDetailsBody": { "type": "object", "properties": { "trackingDetails": { "type": "object", "properties": { "ltlTrackingDetail": { "type": [ "object", "null" ], "properties": { "billOfLadingNumber": { "type": [ "string", "null" ], "description": "The number of the carrier shipment acknowledgement document." }, "freightBillNumber": { "type": "array", "items": { "type": "string" }, "description": "Number associated with the freight bill.", "nullable": false } }, "required": [ "freightBillNumber" ] }, "spdTrackingDetail": { "type": [ "object", "null" ], "properties": { "spdTrackingItems": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box.", "nullable": false }, "trackingId": { "type": "string", "description": "The tracking Id associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. The seller must provide this information.", "nullable": false } }, "required": [ "boxId", "trackingId" ] }, "description": "List of Small Parcel Delivery (SPD) tracking items input.", "nullable": false } }, "required": [ "spdTrackingItems" ] } }, "nullable": false } }, "required": [ "trackingDetails" ] }, "SpApiUpdateShipmentTrackingDetailsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "SpApiUpdateShipmentTrackingDetailsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "SpApiUpdateShipmentTrackingDetailsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ] }, "SubmitAzBoxesPathParams": { "type": "object", "properties": { "plan_id": { "type": "string" } }, "required": [ "plan_id" ] }, "SubmitAzBoxesResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "number" }, "data": {}, "message": { "type": "string" } }, "required": [ "message" ] } } } }, "SubmitFeedResponse": { "type": "object", "properties": { "feedId": { "type": "string", "description": "Unique ID used for tracking the feed file." }, "feedType": { "type": "string", "enum": [ "MP_ITEM_MATCH", "MP_ITEM", "inventory", "PRICE_AND_PROMOTION", "OMNI_WFS", "price" ], "description": "Type of feed submitted" }, "feedStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "PROCESSED", "ERROR", "Submitted" ], "description": "Current feed processing state." }, "itemsReceived": { "type": "number", "description": "Number of items received in the feed." }, "itemsSucceeded": { "type": "number", "description": "Number of items that processed successfully." }, "itemsFailed": { "type": "number", "description": "Number of items that failed due to a data or system error." }, "itemsProcessing": { "type": "number", "description": "Number of items still processing." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "limit": { "type": "number" }, "offset": { "type": "number" }, "itemDetails": { "type": "object", "properties": { "itemIngestionStatus": { "type": "array", "items": { "type": "object", "properties": { "martId": { "type": "number", "description": "Mart identifier associated with the marketplace." }, "wpid": { "type": "string", "description": "Walmart product identifier assigned after item creation." }, "index": { "type": "number", "description": "Item position within the original feed payload." }, "ingestionStatus": { "type": "string", "enum": [ "INPROGRESS", "SUCCESS", "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ], "description": "Item ingestion status." }, "sku": { "type": "string", "description": "Seller-defined unique Stock Keeping Unit (SKU) for the item." }, "ingestionErrors": { "type": "object", "properties": { "ingestionError": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ] }, "code": { "type": "string", "description": "Item-level error code." }, "field": { "type": "string", "description": "Item-level error code." }, "description": { "type": "string", "description": "Item-level error description." } }, "required": [ "type", "code" ] } } }, "description": "List of errors for the item." } } }, "description": "Ingestion status entries for individual items in the feed." } } } }, "required": [ "limit", "offset", "itemDetails" ] }, "SubmitFeedsBody": { "type": "object", "properties": { "feeds": { "type": "array", "prefixItems": [ { "oneOf": [ { "type": "object", "properties": { "MPItemFeedHeader": { "oneOf": [ { "type": "object", "properties": { "requestId": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "requestBatchId": { "type": "object" }, "feedDate": { "type": "object" }, "processMode": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "REPLACE" ] } ] }, "subset": { "type": "object" }, "Mart": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "WALMART_US" ] }, { "type": "string", "enum": [ "WALMART_CA" ] }, { "type": "string", "enum": [ "ASDA_GM" ] }, { "type": "string", "enum": [ "WALMART_MEXICO" ] } ] }, "sellingChannel": { "type": "string", "enum": [ "mpsetupbymatch" ] }, "version": { "type": "string", "enum": [ "4.2" ] }, "locale": { "type": "string", "enum": [ "en" ] } }, "required": [ "sellingChannel", "version", "locale" ] }, { "type": "object", "properties": { "businessUnit": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ] }, "locale": { "type": "string", "enum": [ "en" ] }, "version": { "type": "string", "enum": [ "5.0.20250121-19_24_23-api" ] } }, "required": [ "businessUnit", "locale", "version" ] }, { "type": "object", "properties": { "businessUnit": { "type": "object" }, "locale": { "type": "string", "enum": [ "en" ] }, "version": { "type": "string", "enum": [ "2.0.20240126-12_25_52-api" ] } }, "required": [ "businessUnit", "locale", "version" ] } ] }, "MPItem": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "Item": { "type": "object", "properties": { "sku": { "type": "string" }, "productIdentifiers": { "type": "object", "properties": { "productIdType": { "type": "string", "enum": [ "EAN", "GTIN", "ISBN", "UPC" ] }, "productId": { "type": "string" } }, "required": [ "productIdType", "productId" ] }, "price": { "type": "number" }, "ShippingWeight": { "type": "number" }, "condition": { "type": "string", "enum": [ "New", "New with defects", "New without box", "New without tags", "Open Box", "Pre-Owned: Fair", "Pre-Owned: Good", "Pre-Owned: Like New", "Remanufactured", "Restored Premium", "Restored" ] }, "mainImageUrl": { "type": "object" }, "productSecondaryImageURL": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "productCategory": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "Animal Accessories" ] }, { "type": "string", "enum": [ "Animal Food" ] }, { "type": "string", "enum": [ "Animal Health & Grooming" ] }, { "type": "string", "enum": [ "Animal Other" ] }, { "type": "string", "enum": [ "Art & Craft" ] }, { "type": "string", "enum": [ "Baby Diapering, Care, & Other" ] }, { "type": "string", "enum": [ "Baby Food" ] }, { "type": "string", "enum": [ "Baby Furniture" ] }, { "type": "string", "enum": [ "Baby Toys" ] }, { "type": "string", "enum": [ "Baby Transport" ] }, { "type": "string", "enum": [ "Beauty, Personal Care, & Hygiene" ] }, { "type": "string", "enum": [ "Bedding" ] }, { "type": "string", "enum": [ "Books & Magazines" ] }, { "type": "string", "enum": [ "Building Supply" ] }, { "type": "string", "enum": [ "Cameras & Lenses" ] }, { "type": "string", "enum": [ "Carriers & Accessories" ] }, { "type": "string", "enum": [ "Cases & Bags" ] }, { "type": "string", "enum": [ "Ceremonial Clothing & Accessories" ] }, { "type": "string", "enum": [ "Clothing" ] }, { "type": "string", "enum": [ "Computer Components" ] }, { "type": "string", "enum": [ "Computers" ] }, { "type": "string", "enum": [ "Costumes" ] }, { "type": "string", "enum": [ "Cycling" ] }, { "type": "string", "enum": [ "Decorations & Favors" ] }, { "type": "string", "enum": [ "Electrical" ] }, { "type": "string", "enum": [ "Electronics Accessories" ] }, { "type": "string", "enum": [ "Electronics Cables" ] }, { "type": "string", "enum": [ "Electronics Other" ] }, { "type": "string", "enum": [ "Food & Beverage" ] }, { "type": "string", "enum": [ "Footwear" ] }, { "type": "string", "enum": [ "Fuels & Lubricants" ] }, { "type": "string", "enum": [ "Funeral" ] }, { "type": "string", "enum": [ "Furniture" ] }, { "type": "string", "enum": [ "Garden & Patio" ] }, { "type": "string", "enum": [ "Gift Supply & Awards" ] }, { "type": "string", "enum": [ "Grills & Outdoor Cooking" ] }, { "type": "string", "enum": [ "Hardware" ] }, { "type": "string", "enum": [ "Health & Beauty Electronics" ] }, { "type": "string", "enum": [ "Home Decor, Kitchen, & Other" ] }, { "type": "string", "enum": [ "Household Cleaning Products & Supplies" ] }, { "type": "string", "enum": [ "Instrument Accessories" ] }, { "type": "string", "enum": [ "Jewelry" ] }, { "type": "string", "enum": [ "Land Vehicles" ] }, { "type": "string", "enum": [ "Large Appliances" ] }, { "type": "string", "enum": [ "Medical Aids & Equipment" ] }, { "type": "string", "enum": [ "Medicine & Supplements" ] }, { "type": "string", "enum": [ "Movies" ] }, { "type": "string", "enum": [ "Music Cases & Bags" ] }, { "type": "string", "enum": [ "Music" ] }, { "type": "string", "enum": [ "Musical Instruments" ] }, { "type": "string", "enum": [ "Office" ] }, { "type": "string", "enum": [ "Optical" ] }, { "type": "string", "enum": [ "Optics" ] }, { "type": "string", "enum": [ "Other" ] }, { "type": "string", "enum": [ "Photo Accessories" ] }, { "type": "string", "enum": [ "Plumbing & HVAC" ] }, { "type": "string", "enum": [ "Printers, Scanners, & Imaging" ] }, { "type": "string", "enum": [ "Safety & Emergency" ] }, { "type": "string", "enum": [ "Software" ] }, { "type": "string", "enum": [ "Sound & Recording" ] }, { "type": "string", "enum": [ "Sports & Recreation Other" ] }, { "type": "string", "enum": [ "Storage" ] }, { "type": "string", "enum": [ "TV Shows" ] }, { "type": "string", "enum": [ "TVs & Video Displays" ] }, { "type": "string", "enum": [ "Tires" ] }, { "type": "string", "enum": [ "Tools & Hardware Other" ] }, { "type": "string", "enum": [ "Tools" ] }, { "type": "string", "enum": [ "Toys" ] }, { "type": "string", "enum": [ "Vehicle Other" ] }, { "type": "string", "enum": [ "Vehicle Parts & Accessories" ] }, { "type": "string", "enum": [ "Video Games" ] }, { "type": "string", "enum": [ "Video Projectors" ] }, { "type": "string", "enum": [ "Watches" ] }, { "type": "string", "enum": [ "Watercraft" ] }, { "type": "string", "enum": [ "Wheels & Wheel Components" ] } ] }, "stateRestrictions": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "stateRestrictionsText": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "None" ] }, { "type": "string", "enum": [ "Illegal for Sale" ] }, { "type": "string", "enum": [ "Commercial" ] } ] }, "states": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "AK - Alaska" ] }, { "type": "string", "enum": [ "AL - Alabama" ] }, { "type": "string", "enum": [ "AR - Arkansas" ] }, { "type": "string", "enum": [ "AS - American Samoa" ] }, { "type": "string", "enum": [ "AZ - Arizona" ] }, { "type": "string", "enum": [ "CA - California" ] }, { "type": "string", "enum": [ "CO - Colorado" ] }, { "type": "string", "enum": [ "CT - Connecticut" ] }, { "type": "string", "enum": [ "DC - District of Columbia" ] }, { "type": "string", "enum": [ "DE - Delaware" ] }, { "type": "string", "enum": [ "FL - Florida" ] }, { "type": "string", "enum": [ "FM - Federated States of Micronesia" ] }, { "type": "string", "enum": [ "GA - Georgia" ] }, { "type": "string", "enum": [ "GU - Guam" ] }, { "type": "string", "enum": [ "HI - Hawaii" ] }, { "type": "string", "enum": [ "IA - Iowa" ] }, { "type": "string", "enum": [ "ID - Idaho" ] }, { "type": "string", "enum": [ "IL - Illinois" ] }, { "type": "string", "enum": [ "IN - Indiana" ] }, { "type": "string", "enum": [ "KS - Kansas" ] }, { "type": "string", "enum": [ "KY - Kentucky" ] }, { "type": "string", "enum": [ "LA - Louisiana" ] }, { "type": "string", "enum": [ "MA - Massachusetts" ] }, { "type": "string", "enum": [ "MD - Maryland" ] }, { "type": "string", "enum": [ "ME - Maine" ] }, { "type": "string", "enum": [ "MH - Marshall Islands" ] }, { "type": "string", "enum": [ "MI - Michigan" ] }, { "type": "string", "enum": [ "MN - Minnesota" ] }, { "type": "string", "enum": [ "MO - Missouri" ] }, { "type": "string", "enum": [ "MP - Commonwealth of the Northern Mariana Islands" ] }, { "type": "string", "enum": [ "MS - Mississippi" ] }, { "type": "string", "enum": [ "MT - Montana" ] }, { "type": "string", "enum": [ "NC - North Carolina" ] }, { "type": "string", "enum": [ "ND - North Dakota" ] }, { "type": "string", "enum": [ "NE - Nebraska" ] }, { "type": "string", "enum": [ "NH - New Hampshire" ] }, { "type": "string", "enum": [ "NJ - New Jersey" ] }, { "type": "string", "enum": [ "NM - New Mexico" ] }, { "type": "string", "enum": [ "NV - Nevada" ] }, { "type": "string", "enum": [ "NY - New York" ] }, { "type": "string", "enum": [ "OH - Ohio" ] }, { "type": "string", "enum": [ "OK - Oklahoma" ] }, { "type": "string", "enum": [ "OR - Oregon" ] }, { "type": "string", "enum": [ "PA - Pennsylvania" ] }, { "type": "string", "enum": [ "PR - Puerto Rico" ] }, { "type": "string", "enum": [ "PW - Palau" ] }, { "type": "string", "enum": [ "RI - Rhode Island" ] }, { "type": "string", "enum": [ "SC - South Carolina" ] }, { "type": "string", "enum": [ "SD - South Dakota" ] }, { "type": "string", "enum": [ "TN - Tennessee" ] }, { "type": "string", "enum": [ "TX - Texas" ] }, { "type": "string", "enum": [ "UM - U.S. Minor Outlying Islands" ] }, { "type": "string", "enum": [ "UT - Utah" ] }, { "type": "string", "enum": [ "VA - Virginia" ] }, { "type": "string", "enum": [ "VI - U.S. Virgin Islands" ] }, { "type": "string", "enum": [ "VT - Vermont" ] }, { "type": "string", "enum": [ "WA - Washington" ] }, { "type": "string", "enum": [ "WI - Wisconsin" ] }, { "type": "string", "enum": [ "WV - West Virginia" ] }, { "type": "string", "enum": [ "WY - Wyoming" ] } ] }, "zipCodes": { "type": "object" } } } } ] }, "additionalProductAttributes": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "productAttributeName": { "type": "string" }, "productAttributeValue": { "type": "string" } }, "required": [ "productAttributeName", "productAttributeValue" ] } } ] }, "additionalOfferAttributes": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "additionalOfferAttributeName": { "type": "string" }, "additionalOfferAttributeValue": { "type": "string" } }, "required": [ "additionalOfferAttributeName", "additionalOfferAttributeValue" ] } } ] } }, "required": [ "sku", "productIdentifiers", "price", "ShippingWeight", "condition" ] } }, "required": [ "Item" ] }, { "type": "object", "properties": { "Orderable": { "type": "object", "properties": { "sku": { "type": "string" }, "productIdentifiers": { "type": "object" }, "price": { "type": "number" }, "ShippingWeight": { "type": "number" }, "stateRestrictions": { "type": "object" }, "electronicsIndicator": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "Yes" ] }, { "type": "string", "enum": [ "No" ] } ] }, "chemicalAerosolPesticide": { "type": "object" }, "batteryTechnologyType": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "Mercury" ] }, { "type": "string", "enum": [ "Carbon Zinc" ] }, { "type": "string", "enum": [ "Lead Acid (Non-Spillable)" ] }, { "type": "string", "enum": [ "Alkaline" ] }, { "type": "string", "enum": [ "Does Not Contain a Battery" ] }, { "type": "string", "enum": [ "Lithium Primary (Lithium Metal)" ] }, { "type": "string", "enum": [ "Nickel Cadmium" ] }, { "type": "string", "enum": [ "Lithium Ion" ] }, { "type": "string", "enum": [ "Nickel Metal Hydride" ] }, { "type": "string", "enum": [ "Lead Acid" ] }, { "type": "string", "enum": [ "Silver" ] }, { "type": "string", "enum": [ "Magnesium" ] } ] }, "fulfillmentLagTime": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "shipsInOriginalPackaging": { "type": "object" }, "MustShipAlone": { "type": "object" }, "IsPreorder": { "type": "object" }, "releaseDate": { "type": "object" }, "startDate": { "type": "object" }, "endDate": { "type": "object" }, "quantity": { "type": "object" }, "fulfillmentCenterID": { "type": "object" }, "inventoryAvailabilityDate": { "type": "object" }, "ProductIdUpdate": { "type": "object" }, "SkuUpdate": { "type": "object" }, "msrp": { "type": "object" } }, "required": [ "sku", "productIdentifiers", "price", "ShippingWeight" ] }, "Visible": { "type": "object", "additionalProperties": { "type": "object", "properties": { "productName": { "type": "string" }, "brand": { "type": "string" }, "shortDescription": { "type": "string" }, "keyFeatures": { "type": "object" }, "mainImageUrl": { "type": "string" }, "isProp65WarningRequired": { "type": "string", "enum": [ "Yes", "No" ] }, "smallPartsWarnings": { "type": "string", "enum": [ "0 - No warning applicable", "1 - Choking hazard is a small ball", "2 - Choking hazard contains small ball", "3 - Choking hazard contains small parts", "4 - Choking hazard balloon", "5 - Choking hazard is a marble", "6 - Choking hazard contains a marble" ] }, "has_written_warranty": { "type": "string", "enum": [ "No", "Yes - Warranty Text", "Yes - Warranty URL" ] }, "netContent": { "type": "object", "properties": { "productNetContentMeasure": { "type": "number" }, "productNetContentUnit": { "type": "string", "enum": [ "Count", "Cubic Foot", "Case", "Centiliter", "Centimeter", "Each", "Fluid Ounces", "Foot", "Gallon", "Gram", "Inch", "Kilogram", "Liter", "Meter", "Milliliter", "Ounce", "Pallet/Unit Load", "Pint", "Pound", "Quart Dry", "Quart", "Square Foot", "Yard" ] } }, "required": [ "productNetContentMeasure", "productNetContentUnit" ] }, "productSecondaryImageURL": { "type": "object" }, "assembledProductLength": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "measure": { "type": "number" }, "unit": { "type": "string", "enum": [ "mm", "ft", "cm", "in" ] } }, "required": [ "measure", "unit" ] } ] }, "assembledProductWidth": { "type": "object" }, "assembledProductHeight": { "type": "object" }, "assembledProductWeight": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "measure": { "type": "number" }, "unit": { "type": "string", "enum": [ "lb", "oz" ] } }, "required": [ "measure", "unit" ] } ] }, "prop65WarningText": { "type": "object" }, "color": { "type": "object" }, "colorCategory": { "type": "array", "items": { "type": "string", "enum": [ "Silver", "Beige", "Black", "Blue", "Bronze", "Brown", "Clear", "Gold", "Gray", "Green", "Multicolor", "Off-White", "Orange", "Pink", "Purple", "Red", "White", "Yellow" ] } }, "countPerPack": { "type": "object" }, "condition": { "type": "object" }, "manufacturer": { "type": "object" }, "manufacturerPartNumber": { "type": "object" }, "material": { "type": "object" }, "modelNumber": { "type": "object" }, "multipackQuantity": { "type": "object" }, "netContentStatement": { "type": "object" }, "pieceCount": { "type": "object" }, "occasion": { "type": "object" }, "productLine": { "type": "object" }, "skateboard_riser_type": { "type": "object" }, "sportsLeague": { "type": "object" }, "sportsTeam": { "type": "object" }, "thirdPartyAccreditationSymbolOnProductPackageCode": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "Fair 'n Green", "Mom's Choice Award", "Parent Tested Parent Approved (PTPA) Winner's Seal of Approval", "Water Quality Association (WQA's)- Tested and Certified", "100 Percent Canadian Milk", "100% Veganskt", "ACMI", "ADCCPA", "AFIA Pet Food Facility", "AGRI Confiance", "AMA Organic Seal", "ATG", "Absence of Eggs and Milk is a Certified Allergen Control (CAC)", "Absence of Eggs, Milk and Peanuts is a Certified Allergen Control (CAC)", "Absence of Peanuts & Almonds is a Certified Allergen Control (CAC)", "Agence Bio", "Agri Natura", "Agriculture Biologique", "Air cleaner performance standard e.g., humidifiers", "Aise 2005", "Aise 2010", "Aise", "Aliments BIO Prepares au Quebec", "Aliments Prepares au Quebec", "Aliments du Quebec BIO", "Aliments du Quebec", "Alpinavera", "Aluminium Gesamtverband der Aluminiumindustrie", "Ama Organic Seal Black", "Ama Seal of Approval", "American Dental Association", "American Heart Association Certified", "Animal Welfare Approved Grassfed", "Appellation Origine Controlee", "Approved by the Asthma and Allergy Association", "Aqua GAP", "Aquaculture Stewardship Council", "Arla Farmer Owned", "Asmi", "Asthma and Allergy Foundation of America", "Atlanta Kashrus Commission Certification", "BC SPCA", "BDIH Logo", "BRC Global Standards", "BSCI", "Bais Din of Crown Heights Vaad HaKashrus Certification", "Bebat", "Belgaqua", "Benor", "Berchtesgadener Land", "Best Aquaculture Practices 2 Stars", "Best Aquaculture Practices 3 Stars", "Best Aquaculture Practices 4 Stars", "Best Aquaculture Practices", "Beter Leven 1 Ster", "Beter Leven 2 Ster", "Beter Leven 3 Ster", "Better Business Bureau Accredited", "Better Cotton Initiative", "Biko Tirol", "Bio Fisch", "Bio Gourmet Knospe", "Bio Knospe Umstellung", "Bio Knospe", "Bio Partenaire", "Bio Ring Allgaeu", "Bio Solidaire", "Bio Suisse Knospe Umstellung", "Bio Suisse Knospe", "Bio-Bayern with Certificate of Provenance", "Bio-Bayern without Certificate of Provenance", "Bio-LABEL Baden-Württemberg", "Bio-LABEL Hessen", "Biodegradable Ingredients", "Biodegradable Products Institute", "Biodegradable", "Biodynamic Certification", "Biogarantie", "Biokreis", "Bioland Ennstal", "Bioland", "Biopark", "Bios Kontrolle", "Bird Friendly Coffee Smithsonian Certification", "Bk Check Vaad Hakashrus Of Buffalo", "Blue Angel", "Blue Ribbon Kosher", "Bluesign Technologies AG Approved e.g., footwear insoles", "BonSucro", "Bord Bia Approved Meat", "Bord Bia Approved", "BreatheWay", "Brewers Association Certified Independent Craft", "British Retail Consortium Certification", "Bullfrog Power", "CAC Absence of Almond", "CAC Absence of Egg", "CAC Absence of Milk", "CAC Absence of Peanut", "CAN/ BNQ Certified", "CCA Gluten Free", "CCF Rabbit Certification", "CCOF", "CEBEC", "CO2 Neutral Certified", "CO2 Reduceret Emballage", "CPE Scharrel Eieren", "CPE Vrije Uitloop Eieren", "CSA International", "CSA/NCA - Gluten Free", "Canada Organic Canadian Organic Logo", "CanadaGAP program certification mark of conformity", "Canadian Agricultural Products", "Canadian Association of Fire Chiefs Approved", "Canadian Certified Compostable", "Canadian Eco Logo", "Canadian Federal Government – CFIA Grade Stamps Canada A e.g. poultry & eggs", "Canadian Federal Government – CFIA Grade Stamps Canada C e.g. poultry & eggs", "Canadian Federal Government – CFIA Grade Stamps Canada Utility e.g. poultry & eggs", "Canadian Federal Government – Dairy Product Grade", "Canadian Federal Government – Processed Egg Products", "Canadian Food Inspection Agency (CFIA) as Federally Registered & Inspected Facility - Fish", "Canadian Food Inspection Agency (CFIA) as Federally Registered & Inspected Facility e.g., meat", "Canned in Canada to describe green beans", "Carbon Footprint Standard", "Carbon Neutral NCOS Certified", "Carbon Neutral packaging", "Carbon Neutral", "Caribbean Kosher", "Caring Consumer PETA", "Celiac Sprue Association", "Central Rabbinical Congress Kosher", "Certified Angus Beef", "Certified B Corporation", "Certified California Sustainable Vineyard and Winery (CCSW)", "Certified Carbon Free", "Certified Humane Organisation", "Certified Humane", "Certified Naturally Grown (CNG)", "Certified Naturally Grown", "Certified OE 100", "Certified Organic Baystate Organic Certifiers", "Certified Organic By Organic Certifiers", "Certified Paleo Friendly", "Certified Paleo", "Certified Sustainable Wine of Chile", "Certified WBENC", "Certified Wildlife Friendly", "Cheese – World Champion Cheese Contest", "Ches K", "Chicago Rabbinical Council", "Cincinnati Kosher", "Claro Fair Trade", "Climate Neutral", "Cocoa Life", "Consumer Choice Award", "Corrugated Recycles", "Cosmebio", "Cotton made in Africa", "Council of Orthodox Rabbis of Greater Detroit Certification", "Cradle To Cradle", "Crossed Grain Symbol", "Culinarium", "DLG Award", "DZG Gluten Free", "Dallas Kosher Certification", "Dansk IP Kvalitet", "Dansk Maelk", "Deer Protection Program", "Delinat", "Demeter Label", "Dermatology Review Panel (\"DRP\") independent dermatologists review", "Design for the Environment (DfE)", "Diamond K - Massachusetts Certification", "Direct Trade", "Distilled in Canada to describe bottled water", "Dolphin Safe", "Donau Soya Standard", "ECARF Seal", "ECOCert Cosmos Natural", "ECOCert Cosmos Organic", "ECOLAND", "EarthKosher Kosher Certification", "Earthsure", "Eco Kreis", "Eco Label Ladybug", "Eco Logo", "EcoCert Certificate", "Ecogarantie", "Ecovin", "Eczema Society of Canada- Accepted", "Eesti Okomark", "Eesti Parim Toiduaine", "Eko", "Enec", "Energy Star", "Epeat Bronze", "Epeat Gold", "Epeat Silver", "Equal Exchange Fairly Traded", "Equalitas Sustainable Wine", "Erde Saat", "Erkend Streek Product", "Ethical Tea Partnership", "Fair Flowers Fair Plants", "Fair Food Program Label", "Fair Trade USA Ingredients", "Fair Trade USA", "Fair for Life", "Fair trade mark", "FairTSA", "FairTrade Cotton", "FairTrade Sugar", "Fairtrade Sourced Ingredient Cashew Nuts", "Fairtrade Sourced Ingredient Cocoa", "Fairtrade Sourced Ingredient Coconut", "Fairtrade Sourced Ingredient Dried Apricots", "Fairtrade Sourced Ingredient Green Tea", "Fairtrade Sourced Ingredient Honey", "Fairtrade Sourced Ingredient Lime Juice", "Fairtrade Sourced Ingredient Mango Juice", "Fairtrade Sourced Ingredient Olive Oil", "Fairtrade Sourced Ingredient Pepper", "Fairtrade Sourced Ingredient Quinoa", "Fairtrade Sourced Ingredient Rice", "Fairtrade Sourced Ingredient Roses", "Fairtrade Sourced Ingredient Tea", "Fairtrade Sourced Ingredient Vanilla", "Falken", "Farmers & Growers (Organic Certification UK2)", "Federal Communications Commission (U.S.)", "Federally Registered Inspected Canada", "Fidelio", "Finnish Heart Symbol", "Finnish Pork Meat Certification System", "Fish Wise Certification", "Flamme Verte", "Flandria", "Food Alliance Certified", "Food Federation", "Food Justice Certified", "Food Safety System Certification 22000", "Foodland Ontario", "For Life (Social Responsibility)", "Forest Products - Product Lines From a Certified Forest", "Forest Stewardship Council 100 Percent", "Forest Stewardship Council Label", "Forest Stewardship Council Mix", "Forest Stewardship Council Recycled", "Foundation Art", "Freiland", "Freshcare", "Friend of the Sea", "GAA", "GCP – Global Coffee Platform", "GFCO", "GFCP", "GIG - Gluten Free Foodservice", "GMO Guard from Natural Food Certifiers", "GMO Marked", "GMP Certified", "GMP ISO 22716", "GRASKEURMERK", "GRASP – Risk Assessment on Social Practise", "Gaskeur", "Gastec", "Gebana", "Gepruefte Sicherheit", "Gezondere Keuze", "Global Care", "Global Gap", "Global Organic Latex Standard", "Global Organic Textile Standard", "Gluten-free Certified: Allergen Control Group/ National Foundation for Celiac Awareness (NFCA)", "Glycaemic Index Foundation", "Glycaemic Research Institute", "Good Housekeeping", "GoodWeave", "Green America Certified Business", "Green Dot", "Green Restaurant Association Endorsed", "Green Seal Certified", "Green Seal", "Green Shield Certified", "Green Star Certified", "Green-e Energy Certified", "Green-e Energy", "GreenChoice", "Groen Label Kas", "Guaranteed Irish", "Halal Certification Services", "Halal Certification Services, CH", "Halal Correct", "Halal Islamic Food and Nutrition Council of Canada (IFANCC)", "Halal Islamic Society of North America (ISNA)", "Halal Plus", "Haute Valeur Environnementale", "Hazard Analysis Critical Control Point", "Health Check", "Heumilch", "Hochstamm Suisse", "Humane Heartland", "Hypertension Canada Medical Device", "ICADA", "ICEA", "IFANCA Halal", "IFOAM", "IFS HPC", "IGP", "IHTK Seal", "IKB EIEREN", "IKB KIP", "IKB VARKEN", "INSTITUT FRESENIUS", "INT Protection", "IP Suisse", "ISEAL Alliance", "ISO Quality", "IVN Natural Leather", "IVN Natural Textiles Best", "IVO Seal – International Verified Omega-3 e.g., Fish oil", "Imported in bulk and packaged in Canada", "Indeklima Maerket", "Integrity and Sustainability Certified", "International Aloe Science Council Certificate", "International Taste & Quality (iTQi) Superior Taste Award", "Intertek Certificate", "Intertek Electrical Testing Laboratories (ETL) Mark", "Jay Kosher Pareve", "KAT", "KEMA KEUR", "KIWA", "KOF K Kosher", "KOMO", "KSA - Kosher", "KSA D - Kosher Dairy", "KVBG Approved", "KVH Kosher", "Kashruth Council of Canada Kosher Certification", "Kehilla Kosher California K", "Kehilla Kosher Heart K", "Klasa", "Kosher - Chicago Rabbinical Council (CRC) Dairy", "Kosher COR Dairy Equipment", "Kosher COR Dairy", "Kosher COR Fish", "Kosher Certification Service", "Kosher Check", "Kosher Chicago Rabbinical Council (CRC) Pareve", "Kosher Grand Rabbinate of Quebec Parve", "Kosher Inspection Service India", "Kosher KW Young Israel Of West Hempstead", "Kosher Kosher Greece", "Kosher Kosher Madrid Spain", "Kosher OK Dairy", "Kosher Oregon Kosher", "Kosher Organics", "Kosher Orthodox Jewish Congregation Parve", "Kosher Ottawa Vaad HaKashrut Canada", "Kosher Parve Natural Food Certifier", "Kosher Peru Certification", "Kosher Star-K -Parve and Passover", "Kosher Star-K-Parve", "Kosher Supervisors of Wisconsin Certification", "Kosher Western Kosher (WK)", "KosherMex", "Krav Mark", "LACON", "LGA", "LVA", "Label Rouge", "Label of the Allergy and Asthma Federation", "Laendle Qualitaet", "Leaping Bunny", "Lodi Rules \"Certified Green\"", "London Beth Din Kosher", "MCIA Organic", "MEHR WEG", "MPS A", "Made Green in Italy", "Made in Canada (a)", "Made in Canada from Domestic and Imported Ingredients", "Made in Canada", "Made with 100% Canadian Oats", "Made with Canadian (ingredient)", "Made with Canadian Beef", "Made with Canadian Mustard Seeds", "Made with Ontario Pork", "Marine Stewardship Council label", "Max Havelaar", "Midwest Kosher", "Minnesota Kosher Council", "Montreal Vaad Hair Mk Pareve", "Mortadella Bologna", "Mundusvini Gold", "Mundusvini Silver", "My Climate", "NAOOA Certified Quality", "NDOA", "NF Marque", "NMX", "NOM", "NPA", "NSF Certified For Sport", "NSF Gluten Free", "NSF Non GMO True North", "NSF Sustainability Certified", "NSF", "National Eczema Association Seal of Acceptance", "Natrue Label", "Natura- Beef", "Natura-Veal", "Nature Care Product", "Nature Et Progres", "Natureplus", "Naturland Fair Trade", "Naturland Wildfish", "Naturland", "Neuland", "No Product Package Certifications Apply", "Non GMO Project", "Non-GMO By Earthkosher", "Nyckelhalet", "OCIA", "OEKO Control", "OEKO Kreislauf", "OEKO Quality Guarantee Bavaria", "OEKO-Tex Made in Green", "OK Compost Home", "OK Compost Industrial", "OK Compost label by Vincotte", "OK Kosher Certification", "OKOTEST", "ORBI", "OU Kosher Dairy", "OU Kosher Fish", "OU Kosher Meat", "OU Kosher Passover", "Ocean Wise Recommended Sourced Responsibly", "Oeko Tex Label", "Official Eco label Sun", "On the way to planetproof", "Ontario - Localize", "Ontario approved legend - Inspected meat products, provincially licensed plants", "Oregon LIVE (Low Input Viticulture and Enology)", "Oregon Tilth", "Organic 100 Content Standard", "Organic Certifying Body - Centre for Systems Integration,", "Organic Certifying Body - International Certification Services, Inc. (ICS), North Dakota, USA", "Organic Certifying Body - JAS (Japanese Agricultural Standards)", "Organic Certifying Body - OTCO (OREGON TILTH CERTIFIED ORGANIC), Oregon, U.S.A.", "Organic Certifying Body – Agricultural Services Certified Organic (ASCO)", "Organic Certifying Body – Debio", "Organic Certifying Body – EcoCert, Quebec, Canada", "Organic Certifying Body – Global Organic Alliance (GOA), Ohio, U.S.A.", "Organic Certifying Body – Letis S.A.", "Organic Certifying Body – Organisme de Certification Québec Vrai (OCQV)", "Organic Certifying Body – Pro-Cert Organic Systems, Saskatchewan, Canada", "Organic Certifying Body – Province of British Columbia Certified Organic, British Columbia Association for Regenerative Agriculture (BCARA), Canada", "Organic Certifying Body – Quality Certification Services (QCS), Florida, U.S.A.", "Organic Certifying Body – Trans Canada Organic Certification Services (TCO), Saskatchewan, Canada", "Organic Certifying Body –Pacific Agricultural Certification Society (PACS), British Columbia, Canada", "Organic Cotton", "Orthodox Rabbinical Board", "Orthodox Union Kosher", "Ozone Friendly General Claim", "PCO", "PEFC Certified", "PEFC Recycled", "PEFC", "Paleo Approved", "Paleo By Earthkosher", "Pet to Pet", "Plastic Free Trust Mark", "Prepared in Canada", "Pro Specie Rara", "Pro-Terra Non-GMO Certification", "Processed in Canada", "Proderm", "Product of Canada", "Product of the Vinho Verde Region", "Product of the Year, Consumer Survey", "Produit en Bretagne", "Protected Designation of Origin", "Protected Geographical Indication", "Protected Harvest Certified", "Proudly Canadian", "Proven Quality Bavaria", "Puhtaasti Kotimainen", "QAI", "QS", "Qualenvi", "Qualitaet Tirol", "Quality Rhoen", "RAL Quality Candles", "REGIONALFENSTER", "RHP", "RSB – Roundtable on Sustainable Biomaterials", "RT-QuIC Tested", "RT-QuIC", "Rabbinical Council Of British Columbia BCK", "Rabbinical Council Of California", "Rabbinical Council Of New England", "Rainforest Alliance", "Real California Cheese", "Real California Milk", "Real Food Seal", "Recognized Canadian Dermatology Association Skin Health", "Recognized Canadian Dermatology Association Sun Protection", "Recupel", "Recyclable General Claim", "Refined in Canada", "Roasted and blended in Canada to describe coffee", "Round Table on Responsible Soy", "SCS Sustainably Grown", "SGS Organic", "SKG 1 star", "SKG 2 star", "SKG 3 star", "SKG Certificate", "SLG Child Safety", "SLG Type Tested", "SLK Bio", "SOIL Organic Cosmos", "SOSTain", "STAR K Kosher", "SUS", "Safe Feed Safe Food", "Safe Quality Food", "Salmon Safe Certification", "Schweizer Allergie Gütesiegel", "Schweizer Alpprodukt", "Schweizer Bergprodukt", "SeaChoice", "Seedling", "Shopper Army", "Society of the Plastics Industry (SPI)", "Soil Association Organic Symbol", "Star D Kosher", "Steel Recycling", "Stellar Certification Services", "Stiftung Warentest", "Stop Climate Change", "Streekproduct.be", "Suisse Garantie", "Sunshine State Kosher", "Sustainable Forestry Initiative", "Sustainable In Practice (SIP)", "Sustainable Palm Oil RSPO Certified", "Sustainable Palm Oil RSPO Credits", "Sustainable Palm Oil RSPO Mixed", "TCO Development", "TNO Approved", "TOOTHFRIENDLY", "Tarnopol Kashrus Kosher", "Terra Vitis", "The EcoLogo Certification", "The Fair Rubber Association", "The Natural and Organic Awards", "Three Line Kosher", "Traditional Specialty Guaranteed", "Transport Canada National Safety Mark (NSM)", "Triangle K Certification", "Triman", "True Foods Canada Trustmark", "True Source Certified", "U.S. Department of Agriculture (USDA) – Grade A e.g., eggs", "UNSER Land", "USDA Grade - AA", "USDA Inspection", "USDA Organic", "USDA", "UTZ Certified Cocoa", "UTZ Certified", "Underwriters laboratory", "Underwriters' Laboratory Certified, Canada \"C\" and U.S. US", "Uniquely Finnish", "United Egg Producers Certified", "V Label Vegan", "V Label Vegetarian", "V.I.V.A.", "VDE", "VDS Certificate", "VEILIG WONEN POLITIE KEURMERK", "Vaad Hakashrus of Denver Scroll K Certification", "Vaad Hoeir Kosher", "Vaelg Fuldkorn Forst", "Vegan - VegeCert", "Vegan Awareness Foundation", "Vegan By Earthkosher", "Vegan Natural Food Certifiers", "Vegan Society Vegan Logo", "Vegaplan", "Vegetarian Society - Vegetarian", "Vignerons en Développement Durable (VDD)", "WEIDEMELK", "WINERIES for Climate Protection (WfCP)", "WSDA", "WWF Panda Label", "Weight Watchers Endorsed", "Whole Grain 100 Percent Stamp", "Whole Grain Basic Stamp", "Whole Grain Council Stamp", "Whole grains 50 percent Stamp", "Zero Waste Business Council Certified" ] } } ] }, "count": { "type": "object" }, "warrantyText": { "type": "object" }, "warrantyURL": { "type": "object" }, "variantGroupId": { "type": "object" }, "variantAttributeNames": { "type": "object" }, "isPrimaryVariant": { "type": "object" }, "swatchImages": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "swatchVariantAttribute": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "color" ] }, { "type": "string", "enum": [ "assembledProductWidth" ] }, { "type": "string", "enum": [ "multipackQuantity" ] } ] }, "swatchImageUrl": { "type": "object" } } } } ] } }, "required": [ "productName", "brand", "shortDescription", "keyFeatures", "mainImageUrl", "isProp65WarningRequired", "smallPartsWarnings", "has_written_warranty", "netContent", "colorCategory", "condition" ] } }, "TradeItem": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "sku": { "type": "string" }, "countryOfOriginAssembly": { "type": "object" } }, "required": [ "sku", "countryOfOriginAssembly" ] } ] } }, "required": [ "Orderable", "Visible" ] }, { "type": "object", "properties": { "Promo&Discount": { "type": "object", "properties": { "sku": { "type": "string" }, "price": { "type": "number" }, "msrp": { "type": "number" } }, "required": [ "sku", "price", "msrp" ] } }, "required": [ "Promo&Discount" ] } ] } }, "feedId": { "type": "string" }, "feedType": { "type": "string", "enum": [ "price", "inventory", "MP_ITEM_MATCH", "MP_ITEM", "PRICE_AND_PROMOTION", "OMNI_WFS" ] }, "feedStatus": { "type": "string", "enum": [ "ERROR", "RECEIVED", "INPROGRESS", "PROCESSED", "Submitted" ] }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "buylist_ids": { "type": "object" } }, "required": [ "buylist_ids" ] } ] } }, "required": [ "MPItemFeedHeader", "MPItem", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "SupplierItemFeedHeader": { "type": "object", "properties": { "businessUnit": { "type": "string", "enum": [ "WALMART_US" ] }, "version": { "type": "string" }, "locale": { "type": "string", "enum": [ "en" ] } }, "required": [ "businessUnit", "version", "locale" ] }, "SupplierItem": { "type": "array", "items": { "type": "object", "properties": { "Visible": { "type": "object" }, "Orderable": { "type": "object" }, "TradeItem": { "type": "object" } }, "required": [ "Visible", "Orderable", "TradeItem" ] } }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "SupplierItemFeedHeader", "SupplierItem", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "InventoryHeader": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "1.4", "1.5" ] } }, "required": [ "version" ] }, "Inventory": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ] }, "amount": { "type": "number" } }, "required": [ "unit", "amount" ] } ] }, "inventoryAvailableDate": { "type": "object" }, "shipNodes": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "shipNode": { "type": "string" }, "quantity": { "type": "object" } }, "required": [ "shipNode", "quantity" ] } } ] } }, "required": [ "sku" ] } }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "InventoryHeader", "Inventory", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "inventoryHeader": { "type": "object" }, "inventory": { "type": "object" }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "inventoryHeader", "inventory", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, { "type": "object", "properties": { "PriceHeader": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "1.7" ] } }, "required": [ "version" ] }, "Price": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "pricing": { "type": "array", "items": { "type": "object", "properties": { "currentPrice": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AUD", "EUR", "BRL", "CAD", "CNY", "EGP", "GBP", "INR", "JPY", "MXN", "PLN", "SAR", "SGD", "TRY", "USD", "ZAR", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BSD", "BTN", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SBD", "SCR", "SDG", "SEK", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZMK", "ZWL" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] } }, "required": [ "currentPrice" ] } } }, "required": [ "sku", "pricing" ] } }, "feedId": { "type": "string" }, "feedType": { "type": "object" }, "feedStatus": { "type": "object" }, "itemsReceived": { "type": "number" }, "itemsSucceeded": { "type": "number" }, "itemsFailed": { "type": "number" }, "itemsProcessing": { "type": "number" }, "source_data": { "type": "object" } }, "required": [ "PriceHeader", "Price", "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] } ] }, { "type": "object" } ], "items": false, "minItems": 2, "maxItems": 2 } } }, "SubmitFeedsSearchParams": { "type": "object", "properties": { "zeroSfQuantity": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "Supplier": { "type": "object", "properties": { "supplier_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "supplier_name": { "type": "string" }, "user_id": { "type": "string" }, "created_by": { "type": [ "string", "null" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "supplier_id", "created", "supplier_name", "user_id", "created_by", "updated", "updated_by", "archived", "archived_by" ] }, "TestNotificationBody": { "type": "object", "properties": { "mp": { "type": "string", "nullable": false } } }, "TestNotificationResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "message": { "type": "string" } } }, "TestNotificationSearchParams": { "type": "object", "properties": { "mp": { "type": "string" } }, "required": [ "mp" ] }, "TestWebHookBody": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true, "description": "an object that will be sent as part of the body POSTed to the web hook endpoint", "nullable": false } }, "required": [ "data" ] }, "TestWebHookResponse": { "type": "object", "properties": { "request": { "type": "string", "description": "A string representing the HTTP request" }, "response": { "type": "string", "description": "A string representing the HTTP response" } }, "required": [ "request", "response" ] }, "ThreePlBillingQueryType": { "type": "string", "enum": [ "new", "legacy" ] }, "ThreePlBillingRegion": { "type": "string", "enum": [ "east", "west", "uk" ] }, "ThreePlBillingRow": { "type": "object", "properties": { "row_id": { "type": "string" }, "region": { "type": "string", "enum": [ "east", "west", "uk" ] }, "three_pl_user_id": { "type": "string" }, "three_pl_email": { "type": [ "string", "null" ] }, "three_pl_name": { "type": [ "string", "null" ] }, "ship_from_id": { "type": "number" }, "ship_from_place_id": { "type": [ "string", "null" ] }, "ship_from_name": { "type": "string" }, "client_id": { "type": "string" }, "client_name": { "type": "string" }, "client_email": { "type": "string" }, "channel": { "type": "string", "enum": [ "az", "wm" ] }, "marketplace_id": { "type": "string" }, "shipment_count": { "type": "number" }, "shipment_units": { "type": "number" }, "earliest_shipment_created": { "type": "string" }, "latest_shipment_created": { "type": "string" }, "prep_client_subscription": { "type": [ "string", "null" ] } }, "required": [ "row_id", "region", "three_pl_user_id", "three_pl_email", "three_pl_name", "ship_from_id", "ship_from_place_id", "ship_from_name", "client_id", "client_name", "client_email", "channel", "marketplace_id", "shipment_count", "shipment_units", "earliest_shipment_created", "latest_shipment_created", "prep_client_subscription" ] }, "TokenApiBody": { "type": "object", "properties": { "client_id": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "client_secret": { "type": "object" }, "code": { "type": "object" }, "grant_type": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "authorization_code" ] }, { "type": "string", "enum": [ "refresh_token" ] }, { "type": "string", "enum": [ "client_credentials" ] } ] }, "partner_id": { "type": "object" }, "redirect_uri": { "type": "object" }, "refresh_token": { "type": "object" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "TokenApiResponse": { "type": "object", "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "number" }, "refresh_token": { "type": "string" }, "token_type": { "type": "string" }, "seller_id": { "type": "string" } }, "required": [ "access_token", "expires_in", "token_type", "seller_id" ] }, "TokenApiSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "description": "The marketplace id" } }, "required": [ "mp" ] }, "TokenPayload": { "type": "object", "properties": { "id": { "type": "string" }, "child": { "type": "string" }, "proxier": { "type": "string" }, "admin": { "type": "string" }, "iat": { "type": "number" }, "exp": { "type": "number" }, "rl": { "type": "string" } }, "required": [ "id" ] }, "TransferItemLocation": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "from_location_id": { "type": "string", "nullable": false }, "to_location_id": { "type": "string", "nullable": false }, "fulfillable": { "type": [ "number", "null" ] }, "damaged": { "type": [ "number", "null" ] } }, "required": [ "sku", "from_location_id", "to_location_id" ] }, "TransferItemLocationsParams": { "type": "object", "properties": { "transfer": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "from_location_id": { "type": "string", "nullable": false }, "to_location_id": { "type": "string", "nullable": false }, "fulfillable": { "type": [ "number", "null" ] }, "damaged": { "type": [ "number", "null" ] } }, "required": [ "sku", "from_location_id", "to_location_id" ] }, "nullable": false } }, "required": [ "transfer" ] }, "TransferItemLocationsResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "number" }, "data": {}, "message": { "type": "string" } }, "required": [ "message" ] } }, "transferred": { "type": "array", "items": {} } } }, "transportation_option_status": { "type": "string", "enum": [ "ACCEPTED", "OFFERED" ] }, "TransportationOption": { "type": "object", "properties": { "transportation_option_id": { "type": "string" }, "user_id": { "type": "string" }, "inbound_plan_id": { "type": "string" }, "shipment_id": { "type": "string" }, "placement_option_id": { "type": "string" }, "carrier": {}, "carrier_appointment": { "anyOf": [ {}, { "type": "null" } ] }, "preconditions": { "type": "array", "items": { "type": "string" } }, "quote": { "anyOf": [ {}, { "type": "null" } ] }, "shipping_mode": { "type": "string", "enum": [ "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS", "FREIGHT_FTL_NONPALLET", "FREIGHT_FTL_PALLET", "FREIGHT_LTL", "GROUND_SMALL_PARCEL", "OCEAN_FCL", "OCEAN_LCL" ] }, "shipping_solution": { "type": "string", "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ] }, "status": { "type": "string", "enum": [ "ACCEPTED", "OFFERED" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "confirm_transportation_option_operation": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "transportation_option_id", "user_id", "inbound_plan_id", "shipment_id", "placement_option_id", "carrier", "carrier_appointment", "preconditions", "quote", "shipping_mode", "shipping_solution", "status", "created", "created_by", "updated", "updated_by", "confirm_transportation_option_operation" ] }, "UpateAzShipmentBody": { "type": "object", "properties": { "user_id": { "type": "string", "nullable": false }, "plan_id": { "type": "string", "nullable": false }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "ship_from_id": { "type": "string", "nullable": false }, "status": { "type": "string", "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ], "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "synced": { "type": "string", "format": "date-time", "nullable": false }, "inbound_plan_id": { "type": "string", "nullable": false }, "placement_option_id": { "type": "string", "nullable": false }, "shipping_solution": { "type": "string", "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ], "nullable": false }, "selected_transportation_option_id": { "type": "string", "nullable": false }, "confirmed_transportation_option_id": { "type": "string", "nullable": false }, "name": { "type": "string", "nullable": false }, "amazon_reference_id": { "type": "string", "nullable": false }, "contact_information": { "nullable": false }, "dates": { "nullable": false }, "destination": { "nullable": false }, "freight_information": { "nullable": false }, "selected_delivery_window": { "nullable": false }, "self_ship_appointment_details": { "nullable": false }, "shipment_confirmation_id": { "type": "string", "nullable": false }, "tracking_details": { "nullable": false }, "update_shipment_tracking_details_operation": { "nullable": false }, "update_shipment_tracking_details_operation_at": { "type": "string", "format": "date-time", "nullable": false }, "boxes": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": [ "string", "null" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": [ "string", "null" ], "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": [ "object", "null" ], "properties": { "countryCode": { "type": [ "string", "null" ], "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": [ "string", "null" ], "description": "State." }, "warehouseId": { "type": [ "string", "null" ], "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": [ "object", "null" ], "properties": { "height": { "type": "number", "description": "The height of a package.", "nullable": false }, "length": { "type": "number", "description": "The length of a package.", "nullable": false }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package.", "nullable": false }, "width": { "type": "number", "description": "The width of a package.", "nullable": false } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": [ "string", "null" ], "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": [ "string", "null" ], "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item.", "nullable": false }, "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.", "nullable": false }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID.", "nullable": false }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": [ "object", "null" ], "properties": { "amount": { "type": "number", "description": "Decimal value of the currency.", "nullable": false }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code.", "nullable": false } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": [ "string", "null" ], "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": [ "string", "null" ], "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item.", "nullable": false }, "quantity": { "type": "number", "description": "The number of the specified MSKU.", "nullable": false } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet).", "nullable": false }, "quantity": { "type": [ "number", "null" ], "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": [ "string", "null" ], "description": "Template name of the box." }, "weight": { "type": [ "object", "null" ], "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ], "nullable": false }, "value": { "type": "number", "description": "Value of a weight.", "nullable": false } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] }, "nullable": false }, "boxes_update": { "nullable": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item.", "nullable": false }, "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.", "nullable": false }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID.", "nullable": false }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": [ "object", "null" ], "properties": { "amount": { "type": "number", "description": "Decimal value of the currency.", "nullable": false }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code.", "nullable": false } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": [ "string", "null" ], "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": [ "string", "null" ], "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item.", "nullable": false }, "quantity": { "type": "number", "description": "The number of the specified MSKU.", "nullable": false } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "nullable": false }, "ship_date": { "type": "string", "format": "date-time", "nullable": false }, "shipping_mode": { "type": "string", "enum": [ "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS", "FREIGHT_FTL_NONPALLET", "FREIGHT_FTL_PALLET", "FREIGHT_LTL", "GROUND_SMALL_PARCEL", "OCEAN_FCL", "OCEAN_LCL" ], "nullable": false }, "dirty": { "type": "boolean", "nullable": false }, "selected_delivery_window_option_id": { "type": "string", "nullable": false, "description": "Which delivery window the user has selected from the drop down, but not necessarily accepted yet" }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_id": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false } } } } } }, "UpdateAttachment": { "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the attached file", "nullable": false }, "content_type": { "type": "string", "nullable": false, "description": "The name of the attached file" }, "file_uri": { "type": "string", "nullable": false, "description": "The MIME type of the attached file" }, "file_data": { "type": "string", "nullable": false, "description": "If the file is hosted externally, this will be a link to that file" }, "file_size": { "type": "number", "nullable": false, "description": "Small files may be stored here" }, "attachment_id": { "type": "string", "nullable": false } }, "required": [ "attachment_id" ] }, "UpdateAttachmentsParams": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "type": "object", "properties": { "file_name": { "type": "string", "description": "The name of the attached file", "nullable": false }, "content_type": { "type": "string", "nullable": false, "description": "The name of the attached file" }, "file_uri": { "type": "string", "nullable": false, "description": "The MIME type of the attached file" }, "file_data": { "type": "string", "nullable": false, "description": "If the file is hosted externally, this will be a link to that file" }, "file_size": { "type": "number", "nullable": false, "description": "Small files may be stored here" }, "attachment_id": { "type": "string", "nullable": false } }, "required": [ "attachment_id" ] }, "nullable": false } }, "required": [ "attachments" ] }, "UpdateAttachmentsResponse": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "type": "object", "properties": { "attachment_id": { "type": "string" }, "user_id": { "type": "string" }, "file_name": { "type": "string", "description": "The name of the attached file" }, "content_type": { "type": [ "string", "null" ], "description": "The name of the attached file" }, "file_uri": { "type": [ "string", "null" ], "description": "The MIME type of the attached file" }, "file_data": { "type": [ "string", "null" ], "description": "If the file is hosted externally, this will be a link to that file" }, "file_size": { "type": [ "number", "null" ], "description": "Small files may be stored here" }, "created": { "type": "string", "format": "date-time", "description": "The size of the attached file in bytes" }, "created_by": { "type": [ "string", "null" ] } }, "required": [ "attachment_id", "user_id", "file_name", "content_type", "file_uri", "file_data", "file_size", "created", "created_by" ] } } }, "required": [ "attachments" ] }, "UpdateAzBoxesBody": { "type": "object", "properties": { "box": { "type": "object", "properties": { "box_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "shipment_id": { "type": "string", "nullable": false }, "plan_id": { "type": "string", "nullable": false }, "pallet_id": { "type": "number", "nullable": false }, "index": { "type": "number", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "tracking_id": { "type": "string", "nullable": false }, "inbound_plan_id": { "type": "string", "nullable": false }, "packing_option_id": { "type": "string", "nullable": false }, "packing_group_id": { "type": "string", "nullable": false }, "package_id": { "type": "string", "nullable": false }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "nullable": false }, "print_box_label_quantity": { "type": "number", "nullable": false }, "length": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ], "nullable": false }, "weight": { "type": "number", "nullable": false }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ], "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false } }, "nullable": false } } }, "UpdateAzBoxesResponse": { "type": "object", "properties": { "boxes": { "type": "array", "items": { "type": "object", "properties": { "box_id": { "type": "string" }, "user_id": { "type": "string" }, "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "pallet_id": { "type": [ "number", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "tracking_id": { "type": [ "string", "null" ] }, "inbound_plan_id": { "type": [ "string", "null" ] }, "packing_option_id": { "type": [ "string", "null" ] }, "packing_group_id": { "type": [ "string", "null" ] }, "package_id": { "type": [ "string", "null" ] }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ] }, "print_box_label_quantity": { "type": "number" }, "length": { "type": [ "number", "null" ] }, "width": { "type": [ "number", "null" ] }, "height": { "type": [ "number", "null" ] }, "unit_of_measurement": { "type": [ "string", "null" ], "enum": [ "CM", "IN" ] }, "weight": { "type": [ "number", "null" ] }, "unit_of_weight": { "type": [ "string", "null" ], "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "box_id", "user_id", "shipment_id", "plan_id", "pallet_id", "index", "quantity", "tracking_id", "inbound_plan_id", "packing_option_id", "packing_group_id", "package_id", "content_information_source", "print_box_label_quantity", "length", "width", "height", "unit_of_measurement", "weight", "unit_of_weight", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by" ] } } }, "required": [ "boxes" ] }, "UpdateAzBoxResponse": { "type": "object", "properties": { "box_id": { "type": "string" }, "user_id": { "type": "string" }, "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "pallet_id": { "type": [ "number", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "tracking_id": { "type": [ "string", "null" ] }, "inbound_plan_id": { "type": [ "string", "null" ] }, "packing_option_id": { "type": [ "string", "null" ] }, "packing_group_id": { "type": [ "string", "null" ] }, "package_id": { "type": [ "string", "null" ] }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ] }, "print_box_label_quantity": { "type": "number" }, "length": { "type": [ "number", "null" ] }, "width": { "type": [ "number", "null" ] }, "height": { "type": [ "number", "null" ] }, "unit_of_measurement": { "type": [ "string", "null" ], "enum": [ "CM", "IN" ] }, "weight": { "type": [ "number", "null" ] }, "unit_of_weight": { "type": [ "string", "null" ], "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "box_id", "user_id", "shipment_id", "plan_id", "pallet_id", "index", "quantity", "tracking_id", "inbound_plan_id", "packing_option_id", "packing_group_id", "package_id", "content_information_source", "print_box_label_quantity", "length", "width", "height", "unit_of_measurement", "weight", "unit_of_weight", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by" ] }, "UpdateAzPallet": { "type": "object", "properties": { "shipment_id": { "type": "string", "nullable": false }, "plan_id": { "type": "string", "nullable": false }, "index": { "type": "number", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ], "nullable": false }, "inbound_plan_id": { "type": "string", "nullable": false }, "placement_option_id": { "type": "string", "nullable": false }, "length": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ], "nullable": false }, "weight": { "type": "number", "nullable": false }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ], "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false }, "updated_by": { "type": "string", "nullable": false } } }, "UpdateAzPalletItem": { "type": "object", "properties": { "shipment_id": { "type": "string", "nullable": false }, "plan_id": { "type": "string", "nullable": false }, "index": { "type": "number", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ], "nullable": false }, "inbound_plan_id": { "type": "string", "nullable": false }, "placement_option_id": { "type": "string", "nullable": false }, "length": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ], "nullable": false }, "weight": { "type": "number", "nullable": false }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ], "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "pallet_id": { "type": "number", "nullable": false } }, "required": [ "pallet_id" ] }, "UpdateAzPalletResponse": { "type": "object", "properties": { "pallet_id": { "type": "number" }, "user_id": { "type": "string" }, "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ] }, "inbound_plan_id": { "type": "string" }, "placement_option_id": { "type": [ "string", "null" ] }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": "number" }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "pallet_id", "user_id", "shipment_id", "plan_id", "index", "quantity", "stackability", "inbound_plan_id", "placement_option_id", "length", "width", "height", "unit_of_measurement", "weight", "unit_of_weight", "created", "created_by", "creation_source", "updated", "updated_by", "deleted", "deleted_by" ] }, "UpdateAzPalletsBody": { "type": "object", "properties": { "pallets": { "type": "array", "items": { "type": "object", "properties": { "shipment_id": { "type": "string", "nullable": false }, "plan_id": { "type": "string", "nullable": false }, "index": { "type": "number", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ], "nullable": false }, "inbound_plan_id": { "type": "string", "nullable": false }, "placement_option_id": { "type": "string", "nullable": false }, "length": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ], "nullable": false }, "weight": { "type": "number", "nullable": false }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ], "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "pallet_id": { "type": "number", "nullable": false } }, "required": [ "pallet_id" ] }, "nullable": false } }, "required": [ "pallets" ] }, "UpdateAzPalletsResponse": { "type": "object", "properties": { "pallets": { "type": "array", "items": { "type": "object", "properties": { "pallet_id": { "type": "number" }, "user_id": { "type": "string" }, "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ] }, "inbound_plan_id": { "type": "string" }, "placement_option_id": { "type": [ "string", "null" ] }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": "number" }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "pallet_id", "user_id", "shipment_id", "plan_id", "index", "quantity", "stackability", "inbound_plan_id", "placement_option_id", "length", "width", "height", "unit_of_measurement", "weight", "unit_of_weight", "created", "created_by", "creation_source", "updated", "updated_by", "deleted", "deleted_by" ] } }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "pallets", "errors" ] }, "UpdateAzShipment": { "type": "object", "properties": { "shipment_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "plan_id": { "type": "string", "nullable": false }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "ship_from_id": { "type": "string", "nullable": false }, "status": { "type": "string", "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ], "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "synced": { "type": "string", "format": "date-time", "nullable": false }, "inbound_plan_id": { "type": "string", "nullable": false }, "placement_option_id": { "type": "string", "nullable": false }, "shipping_solution": { "type": "string", "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ], "nullable": false }, "selected_transportation_option_id": { "type": "string", "nullable": false }, "confirmed_transportation_option_id": { "type": "string", "nullable": false }, "name": { "type": "string", "nullable": false }, "amazon_reference_id": { "type": "string", "nullable": false }, "contact_information": { "nullable": false }, "dates": { "nullable": false }, "destination": { "nullable": false }, "freight_information": { "nullable": false }, "selected_delivery_window": { "nullable": false }, "self_ship_appointment_details": { "nullable": false }, "shipment_confirmation_id": { "type": "string", "nullable": false }, "tracking_details": { "nullable": false }, "update_shipment_tracking_details_operation": { "nullable": false }, "update_shipment_tracking_details_operation_at": { "type": "string", "format": "date-time", "nullable": false }, "boxes": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": [ "string", "null" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "contentInformationSource": { "type": [ "string", "null" ], "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ], "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box." }, "destinationRegion": { "type": [ "object", "null" ], "properties": { "countryCode": { "type": [ "string", "null" ], "description": "ISO 3166 standard alpha-2 country code." }, "state": { "type": [ "string", "null" ], "description": "State." }, "warehouseId": { "type": [ "string", "null" ], "description": "An identifier for a warehouse, such as a FC, IXD, upstream storage." } } }, "dimensions": { "type": [ "object", "null" ], "properties": { "height": { "type": "number", "description": "The height of a package.", "nullable": false }, "length": { "type": "number", "description": "The length of a package.", "nullable": false }, "unitOfMeasurement": { "type": "string", "enum": [ "IN", "CM" ], "description": "The length of a package.", "nullable": false }, "width": { "type": "number", "description": "The width of a package.", "nullable": false } }, "required": [ "height", "length", "unitOfMeasurement", "width" ] }, "externalContainerIdentifier": { "type": [ "string", "null" ], "description": "The external identifier for this container / box." }, "externalContainerIdentifierType": { "type": [ "string", "null" ], "description": "Type of the external identifier used. Can be: `AMAZON`, `SSCC`." }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item.", "nullable": false }, "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.", "nullable": false }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID.", "nullable": false }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": [ "object", "null" ], "properties": { "amount": { "type": "number", "description": "Decimal value of the currency.", "nullable": false }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code.", "nullable": false } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": [ "string", "null" ], "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": [ "string", "null" ], "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item.", "nullable": false }, "quantity": { "type": "number", "description": "The number of the specified MSKU.", "nullable": false } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "description": "Items contained within the box." }, "packageId": { "type": "string", "description": "Primary key to uniquely identify a Package (Box or Pallet).", "nullable": false }, "quantity": { "type": [ "number", "null" ], "description": "The number of containers where all other properties like weight or dimensions are identical." }, "templateName": { "type": [ "string", "null" ], "description": "Template name of the box." }, "weight": { "type": [ "object", "null" ], "properties": { "unit": { "type": "string", "enum": [ "LB", "KG" ], "nullable": false }, "value": { "type": "number", "description": "Value of a weight.", "nullable": false } }, "required": [ "unit", "value" ], "description": "Template name of the box." } }, "required": [ "packageId" ] }, "nullable": false }, "boxes_update": { "nullable": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of the item.", "nullable": false }, "expiration": { "type": [ "string", "null" ], "description": "The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box." }, "fnsku": { "type": "string", "description": "A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.", "nullable": false }, "labelOwner": { "type": "string", "description": "Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace.", "nullable": false }, "manufacturingLotCode": { "type": [ "string", "null" ], "description": "The manufacturing lot code." }, "msku": { "type": "string", "description": "The merchant-defined SKU ID.", "nullable": false }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": [ "object", "null" ], "properties": { "amount": { "type": "number", "description": "Decimal value of the currency.", "nullable": false }, "code": { "type": "string", "description": "ISO 4217 standard of a currency code.", "nullable": false } }, "required": [ "amount", "code" ] }, "prepOwner": { "type": [ "string", "null" ], "description": "In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. `AMAZON` is not an accepted value in the US marketplace." }, "prepType": { "type": [ "string", "null" ], "description": "Type of preparation that should be done. Possible values: `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`." } } }, "description": "Special preparations that are required for an item.", "nullable": false }, "quantity": { "type": "number", "description": "The number of the specified MSKU.", "nullable": false } }, "required": [ "asin", "fnsku", "labelOwner", "msku", "prepInstructions", "quantity" ] }, "nullable": false }, "ship_date": { "type": "string", "format": "date-time", "nullable": false }, "shipping_mode": { "type": "string", "enum": [ "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS", "FREIGHT_FTL_NONPALLET", "FREIGHT_FTL_PALLET", "FREIGHT_LTL", "GROUND_SMALL_PARCEL", "OCEAN_FCL", "OCEAN_LCL" ], "nullable": false }, "dirty": { "type": "boolean", "nullable": false }, "selected_delivery_window_option_id": { "type": "string", "nullable": false, "description": "Which delivery window the user has selected from the drop down, but not necessarily accepted yet" }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_id": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false } } } } }, "required": [ "shipment_id" ] }, "UpdateAzShipmentResponse": {}, "UpdateBundleBody": { "type": "object", "properties": { "bundle": { "type": "object", "properties": { "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "input_sku": { "type": "string", "nullable": false }, "output_sku": { "type": "string", "nullable": false }, "input_quantity": { "type": "number", "nullable": false }, "output_quantity": { "type": "number", "nullable": false }, "bundle_item_id": { "type": [ "string", "null" ], "description": "pass to update an existing bundle item, omit to insert a new item" }, "delete": { "type": [ "boolean", "null" ], "description": "pass `true` to delete this item from the bundle" } } } } }, "nullable": false } }, "required": [ "bundle" ] }, "UpdateBundleItem": { "type": "object", "properties": { "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "bundle_item_id": { "type": "string", "description": "pass to update an existing bundle item, omit to insert a new item" }, "delete": { "type": "boolean", "description": "pass `true` to delete this item from the bundle" } } }, "UpdateBundleParams": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "bundle_item_id": { "type": "string", "description": "pass to update an existing bundle item, omit to insert a new item" }, "delete": { "type": "boolean", "description": "pass `true` to delete this item from the bundle" } } } } }, "required": [ "bundle_id" ] }, "UpdateBundlePathParams": { "type": "object", "properties": { "bundle_id": { "type": "string" } } }, "UpdateBundleResponse": { "type": "object", "properties": { "bundle": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "bundle_item_id": { "type": "string" }, "bundle_id": { "type": "string" }, "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } } } } } } } } }, "required": [ "bundle" ] }, "UpdatedPurchaseOrderItem": { "type": "object", "properties": { "purchase_order_item_id": { "type": "string" }, "user_id": { "type": "string" }, "purchase_order_id": { "type": "string" }, "gtin": { "type": "string" }, "condition_id": { "type": "number", "description": "The GTIN of the item" }, "sku": { "type": "string" }, "notes": { "type": [ "string", "null" ] }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item." }, "missing": { "type": "number", "description": "Any damaged quantity" }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities" }, "intent": { "type": [ "object", "null" ], "properties": { "marketplace": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": "array", "items": { "type": "object" } } }, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "shopper": { "type": [ "string", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "purchased": { "type": "string", "format": "date-time" }, "price": { "type": [ "number", "null" ] }, "cost": { "type": [ "number", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "product_tax_code": { "type": [ "string", "null" ], "enum": [ "A_AUTOMOTIVE_MOTOROIL", "A_BABY_BRSTPUMP", "A_BABY_CARSEAT", "A_BABY_CLOTH", "A_BABY_DIAPER", "A_BOOKS_GEN", "A_BOOKS_RELIG", "A_BOOKS_RENTAL", "A_BUNDLE_PERDCL", "A_CLSFD_52W-4Q", "A_CLSFD_52WKLY", "A_CLSFD_ANNUAL", "A_CLSFD_SEMIANNL", "A_CLTH_ATHL", "A_CLTH_BATH", "A_CLTH_BOOKBAG", "A_CLTH_BUCKLS", "A_CLTH_COMPON", "A_CLTH_CSTUMS", "A_CLTH_FORMAL", "A_CLTH_FUR", "A_CLTH_GEN", "A_CLTH_HAIRACCESSORIES", "A_CLTH_HANDKE", "A_CLTH_HBAGS", "A_CLTH_IFUR", "A_CLTH_PROTECTIVE", "A_CLTH_UMBRELLA", "A_COLLECTIBLE_COIN", "A_COMP_COMPUTER", "A_COMP_EDUSOFT", "A_COMP_GAMPER", "A_COMP_PDA", "A_COMP_PERIPH", "A_COMP_PRINT", "A_COMP_PRTSUP", "A_COMP_SCANNER", "A_COMP_SOFTOP", "A_COMP_SOFTRC", "A_COMP_STORAGEMEDIA", "A_EGOODS_DIGITALAUDIOBOOKS", "A_EGOODS_DIGITALBOOKS", "A_EGOODS_DIGITALBOOK_RENTAL", "A_EGOODS_DIGITALGAMES", "A_EGOODS_DIGITALMUSIC", "A_EGOODS_DIGITALNEWS", "A_EGOODS_DIGITALNEWSSUBS", "A_EGOODS_DIGITALPERDCL", "A_EGOODS_DIGITALPERDCLSUBS", "A_EGOODS_MISC1", "A_EGOODS_ONLINEGAMINGSUBS", "A_EGOODS_SOFT", "A_EMERGENCY_SUPPLIES", "A_FOOD_BKTCDY50-90", "A_FOOD_BKTGN50-75", "A_FOOD_BKTGN76-90", "A_FOOD_CARBSFTDK", "A_FOOD_CARBWTR", "A_FOOD_CNDY", "A_FOOD_CNDYFL", "A_FOOD_GEN", "A_FOOD_JUICE0-50", "A_FOOD_JUICE51-99", "A_FOOD_NCARBWTR", "A_FOOD_PETFOOD", "A_FOOD_WINE", "A_GEN_NOTAX", "A_GEN_RENTAL", "A_GEN_TAX", "A_HLTH_BABYSUPPLS", "A_HLTH_BANDKIT", "A_HLTH_CONTACTSOLN", "A_HLTH_CONTRCEPV", "A_HLTH_COSMETIC", "A_HLTH_DIABSUPPLS", "A_HLTH_DIETSUPMT", "A_HLTH_DISPOSABLE_PACK", "A_HLTH_FAMPLANTEST", "A_HLTH_FEMHYG", "A_HLTH_HEARINGAID_BATT", "A_HLTH_INCONT", "A_HLTH_MEDHAIRLOSS", "A_HLTH_MOBILITY", "A_HLTH_MONITOR", "A_HLTH_OTCMED", "A_HLTH_PROSTHETIC", "A_HLTH_SPFCORALHYG", "A_HLTH_SPFCOTCMED", "A_HLTH_SUNSCRN", "A_HLTH_THRMTR", "A_HLTH_TISSUETOW", "A_HLTH_TOOTHPASTEFL", "A_HOUSEHOLD_LINEN", "A_HOUSEHOLD_PAPERPRODS", "A_NEWS_104PLUS", "A_NEWS_12MTHLY", "A_NEWS_26BIWKLY", "A_NEWS_4QTLY", "A_NEWS_52WKLY", "A_PERDCL_104PLUS", "A_PERDCL_52W-4Q", "A_PERDCL_52WKLY", "A_PERDCL_ANNUAL", "A_PERDCL_SEMIANNL", "A_SCHL_GRAPHCALC", "A_SCHL_INSTRUMENT", "A_SCHL_SUPPLS", "A_SERV_INSTALL", "A_SPORT_ASUPPORT", "A_SPORT_ATHLSHOES", "A_SPORT_BIKEHLMT", "A_SPORT_MISCSPORTS1", "A_SPORT_SKISUIT", "A_SPORT_WINTERSPORTBOOTS", "A_WARR_PARTSNSRVC", "A_WARR_PARTSNSVCE" ], "description": "Amazon's product tax code identifier" }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "Amazon's product tax code identifier" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "condition_name": { "type": "string" } }, "required": [ "condition_name" ] }, "UpdateInboundPlanNameBody": { "type": "object", "properties": { "name": { "type": "string", "description": "A human-readable name to update the inbound plan name to.", "nullable": false } }, "required": [ "name" ] }, "UpdateInboundPlanNameErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "UpdateInboundPlanNameSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "UpdateIntegration": { "type": "object", "properties": { "name": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": false }, "url": { "type": "string", "nullable": false }, "logo": { "type": "string", "nullable": false } } }, "UpdateIntegrationParams": { "type": "object", "properties": { "integration": { "type": "object", "properties": { "name": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": false }, "url": { "type": "string", "nullable": false }, "logo": { "type": "string", "nullable": false } }, "nullable": false } }, "required": [ "integration" ] }, "UpdateIntegrationResponse": { "type": "object", "properties": { "integration": { "type": "object", "properties": { "integration_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "logo": { "type": [ "string", "null" ] } }, "required": [ "integration_id", "name", "description", "url", "user_id", "created", "updated", "archived", "logo" ] } } }, "UpdateInventoryBody": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false, "description": "The most recent price recevied from an inventory report or API sync" } } }, "UpdateInventoryParams": { "type": "object", "properties": { "external_id": { "type": "string", "nullable": false }, "condition_id": { "type": "number", "nullable": false }, "min_price": { "type": "string", "nullable": false }, "price": { "type": "string", "nullable": false }, "max_price": { "type": "string", "nullable": false, "description": "The sales price" }, "synced_price": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false, "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": "string", "nullable": false, "description": "The SF in-stock quantity" }, "last_cost": { "type": "string", "nullable": false }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost", "nullable": false }, "synced": { "type": "string", "format": "date-time", "nullable": false, "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": "string", "format": "date-time", "nullable": false, "description": "The last time data was synced from a report or API call" }, "fees": { "nullable": false, "description": "The last time this item was added to a plan" }, "data": { "oneOf": [ { "type": "object", "properties": { "row": { "type": [ "object", "null" ], "properties": { "GTIN": { "type": [ "string", "null" ] }, "UPC": { "type": [ "string", "null" ] } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": [ "string", "null" ], "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": [ "object", "null" ], "properties": { "mart": { "type": [ "string", "null" ], "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.", "nullable": false }, "condition": { "type": [ "string", "null" ], "description": "The condition of the product." }, "wpid": { "type": [ "string", "null" ], "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": [ "string", "null" ], "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": [ "string", "null" ], "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": [ "string", "null" ], "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": [ "string", "null" ], "description": "Walmart assigned an item shelf name" }, "productType": { "type": [ "string", "null" ], "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": [ "object", "null" ], "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars", "nullable": false }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99", "nullable": false } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": [ "string", "null" ], "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": [ "object", "null" ], "properties": { "nameValueAttribute": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": "string", "nullable": false }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ], "nullable": false }, "isVariant": { "type": [ "boolean", "null" ] }, "variantResourceType": { "type": [ "string", "null" ] }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "nullable": false }, "group": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "rank": { "type": [ "number", "null" ] }, "isVariant": { "type": [ "boolean", "null" ] } }, "required": [ "value" ] }, "nullable": false } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": [ "object", "null" ], "properties": { "reason": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": [ "string", "null" ], "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": [ "boolean", "null" ], "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": [ "boolean", "null" ], "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": [ "object", "null" ], "properties": { "status": { "type": [ "string", "null" ], "description": "Current Status of the item" }, "lastUpdatedDate": { "type": [ "string", "null" ], "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": [ "string", "null" ], "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": [ "object", "null" ], "properties": { "mart": { "type": [ "string", "null" ], "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": [ "string", "null" ], "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": [ "string", "null" ], "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": [ "string", "null" ], "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": [ "string", "null" ], "description": "The Item ID assigned by Walmart" }, "productName": { "type": [ "string", "null" ], "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": [ "string", "null" ], "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": [ "string", "null" ], "format": "date-time" }, "getSearchResult": { "type": [ "object", "null" ], "properties": { "itemId": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "isMarketPlaceItem": { "type": [ "boolean", "null" ] }, "images": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "url": { "type": "string", "nullable": false } }, "required": [ "url" ] } }, "customerRating": { "type": [ "string", "null" ] }, "price": { "type": [ "object", "null" ], "properties": { "amount": { "type": "string", "nullable": false }, "currency": { "type": "string", "nullable": false } }, "required": [ "amount", "currency" ] }, "description": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "productType": { "type": [ "string", "null" ] }, "properties": { "type": [ "object", "null" ], "properties": { "variant_items_num": { "type": [ "string", "null" ] }, "num_reviews": { "type": [ "string", "null" ] }, "categories": { "type": [ "array", "null" ], "items": { "type": "string" } }, "variants": { "type": [ "object", "null" ], "properties": { "variantMeta": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": "string", "nullable": false } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": [ "string", "null" ] }, "itemId": { "type": [ "string", "null" ] }, "isAvailable": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "variantValues": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } } } } } }, "nullable": false } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": [ "boolean", "null" ] } } }, "parent": { "type": [ "object", "null" ], "properties": { "itemId": { "type": "object", "nullable": false }, "images": { "type": "object", "nullable": false }, "title": { "type": "object", "nullable": false } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": [ "string", "null" ], "format": "date-time" }, "getInventory": { "type": [ "object", "null" ], "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU.", "nullable": false }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item.", "nullable": false }, "amount": { "type": "number", "description": "The number of units pending shipment.", "nullable": false } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet.", "nullable": false }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD", "nullable": false }, "errors": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure.", "nullable": false }, "field": { "type": [ "string", "null" ], "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": [ "string", "null" ], "description": "Human-readable explanation of the error." }, "info": { "type": [ "string", "null" ], "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": [ "string", "null" ], "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": [ "string", "null" ], "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "code": { "type": [ "string", "null" ], "description": "Sub-error code indicating a specific cause." }, "field": { "type": [ "string", "null" ], "description": "Field related to the sub-error, if any." }, "type": { "type": [ "string", "null" ], "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": [ "string", "null" ], "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": [ "object", "null" ], "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": [ "string", "null" ], "description": "Originating component or subsystem name." }, "type": { "type": [ "string", "null" ], "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": [ "string", "null" ], "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": [ "string", "null" ], "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": [ "string", "null" ], "format": "date-time" }, "getWfsInventoryDetails": { "type": [ "object", "null" ], "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item.", "nullable": false }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC.", "nullable": false }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller.", "nullable": false }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL.", "nullable": false }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller.", "nullable": false }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item.", "nullable": false }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage.", "nullable": false } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ], "nullable": false }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible.", "nullable": false }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated.", "nullable": false }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated.", "nullable": false }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created.", "nullable": false }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received.", "nullable": false }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours.", "nullable": false }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days.", "nullable": false } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received.", "nullable": false }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers.", "nullable": false }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number", "nullable": false }, "91To180days": { "type": "number", "nullable": false }, "181To270days": { "type": "number", "nullable": false }, "271To365days": { "type": "number", "nullable": false }, "365PlusDays": { "type": "number", "nullable": false } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days.", "nullable": false }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center.", "nullable": false } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ], "nullable": false }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand.", "nullable": false }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand.", "nullable": false }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand.", "nullable": false }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period.", "nullable": false }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand.", "nullable": false }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply.", "nullable": false }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more.", "nullable": false }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand.", "nullable": false } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ], "nullable": false } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": [ "string", "null" ], "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": [ "object", "null" ], "properties": { "asin1": { "type": "string", "nullable": false }, "seller-sku": { "type": "string", "nullable": false }, "product-id": { "type": "string", "nullable": false }, "product-id-type": { "type": "string", "nullable": false } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": [ "object", "null" ], "properties": { "asin": { "type": [ "string", "null" ], "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": [ "string", "null" ], "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": [ "string", "null" ], "description": "The seller SKU of the item." }, "condition": { "type": [ "string", "null" ], "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": [ "object", "null" ], "properties": { "fulfillableQuantity": { "type": [ "number", "null" ], "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": [ "number", "null" ], "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": [ "number", "null" ], "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": [ "number", "null" ], "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." }, "reservedQuantity": { "type": [ "object", "null" ], "properties": { "totalReservedQuantity": { "type": [ "number", "null" ], "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." }, "pendingCustomerOrderQuantity": { "type": [ "number", "null" ], "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": [ "number", "null" ], "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": [ "number", "null" ], "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": [ "object", "null" ], "properties": { "totalResearchingQuantity": { "type": [ "number", "null" ], "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research.", "nullable": false }, "quantity": { "type": "number", "description": "The number of units.", "nullable": false } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": [ "object", "null" ], "properties": { "totalUnfulfillableQuantity": { "type": [ "number", "null" ], "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": [ "number", "null" ], "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": [ "number", "null" ], "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": [ "number", "null" ], "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": [ "number", "null" ], "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": [ "number", "null" ], "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": [ "number", "null" ], "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": [ "string", "null" ], "description": "The date and time that any quantity was last updated." }, "productName": { "type": [ "string", "null" ], "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": [ "number", "null" ], "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "nullable": false, "description": "Fees to sell this item" }, "fulfillment_channel": { "type": "string", "enum": [ "fba", "sf", "wfs" ], "nullable": false, "description": "Channel specific data from various APIs" }, "supply_detail": { "nullable": false }, "net_payout": { "type": "number", "nullable": false }, "condition_notes": { "nullable": false }, "storage_type": { "type": "string", "nullable": false }, "prep_details": { "type": "object", "properties": { "allOwnersConstraint": { "type": [ "string", "null" ], "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": [ "string", "null" ], "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU.", "nullable": false }, "prepOwnerConstraint": { "type": [ "string", "null" ], "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category.", "nullable": false } }, "required": [ "msku", "prepCategory", "prepTypes" ], "nullable": false }, "listing": { "nullable": false }, "update_listing_at": { "type": "string", "format": "date-time", "nullable": false, "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "nullable": false }, "listings_notification_at": { "type": "string", "format": "date-time", "nullable": false }, "country_of_origin": { "type": "string", "nullable": false }, "fnsku": { "type": "string", "nullable": false }, "open_date": { "type": "string", "nullable": false }, "detail": { "nullable": false }, "sku": { "type": "string", "nullable": false }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false } } } } }, "required": [ "sku", "marketplace_id" ] }, "UpdateInventoryResponse": { "type": "object", "properties": { "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" }, "condition_id": { "type": "number" }, "min_price": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "max_price": { "type": [ "string", "null" ], "description": "The sales price" }, "synced_price": { "type": [ "string", "null" ] }, "quantity": { "type": [ "number", "null" ], "description": "The most recent price recevied from an inventory report or API sync" }, "avg_cost_90_days": { "type": [ "string", "null" ], "description": "The SF in-stock quantity" }, "last_cost": { "type": [ "string", "null" ] }, "created": { "type": "string", "format": "date-time", "description": "The most recent purchase cost" }, "synced": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "last_listed": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time data was synced from a report or API call" }, "fees": { "anyOf": [ { "description": "The last time this item was added to a plan" }, { "type": "null" } ] }, "data": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "row": { "type": "object", "properties": { "GTIN": { "type": "string" }, "UPC": { "type": "string" } }, "description": "row from the ITEM report csv" }, "rowUpdated": { "type": "string", "format": "date-time", "description": "row from the ITEM report csv" }, "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getAnItemUpdated": { "type": "string", "format": "date-time" }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } }, "getSearchResultUpdated": { "type": "string", "format": "date-time" }, "getInventory": { "type": "object", "properties": { "sku": { "type": "string", "description": "A unique alphanumeric ID you assign to each item. The response returns the decoded SKU." }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ], "description": "A unit of measure. Walmart Marketplace supports only EACH, which indicates one individual sellable item." }, "amount": { "type": "number", "description": "The number of units pending shipment." } }, "required": [ "unit", "amount" ], "description": "The quantity that customers have ordered but you haven't shipped yet." }, "inventoryAvailableDate": { "type": "string", "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] }, "description": "Information about when the inventory is expected at the given ship node. Format: YYYY-MM-DD" } } }, "getinventoryUpdated": { "type": "string", "format": "date-time" }, "getWfsInventoryDetails": { "type": "object", "properties": { "itemInformation": { "type": "object", "properties": { "itemName": { "type": "string", "description": "The name of the item." }, "gtin": { "type": "string", "description": "The Global Trade Identification Number (GTIN) associated with the item. If you provide a 12-digit UPC rather than a GTIN, the GTIN will start with two 0s followed by the UPC." }, "sku": { "type": "string", "description": "The unique identifier assigned to the item by the seller." }, "itemID": { "type": "string", "description": "The Walmart-assigned ID used to track items. This ID is located at the end of the item page URL." }, "offerID": { "type": "string", "description": "The unique identifier assigned to a specific product offer. It is used to distinguish between different listings of the same product, which may vary by price, condition, or seller." }, "brand": { "type": "string", "description": "Identifies the company or manufacturer that markets the item." }, "itemCondition": { "type": "string", "description": "The item's condition described by its appearance, quality, packaging, functionality, and previous usage." } }, "required": [ "itemName", "gtin", "sku", "itemID", "offerID", "brand", "itemCondition" ] }, "inventoryData": { "type": "object", "properties": { "publishingStatus": { "type": "string", "description": "WFS items' publishing status can be: Published, Unpublished, Processing, Stage, Error, or WFS Ineligible." }, "itemLifecycle": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "stockStatus": { "type": "string", "description": "Active: The item is currently in your catalog, regardless of its publishing status. Retired: The item has been removed from your catalog or has surpassed its listing end date. It can be reactivated. Archived: The item has been permanently deleted from your catalog and cannot be reactivated." }, "availableUnits": { "type": "number", "description": "Out-of-stock items have 0 units available to sell. At-risk items have fewer than 28 days of supply, including both available and inbound units. In-stock items have more than 28 days of total supply. Long term out of stock items that have been consistently out of stock for more than 30 days. New to WFS items that have been set up in WFS but haven't been inbounded because a shipment order has not been created." }, "inboundUnits": { "type": "number", "description": "The number of units that have been sent to WFS but have not yet been received." }, "unavailableUnits": { "type": "object", "properties": { "inventoryReviewUnits": { "type": "number", "description": "Units are undergoing a standard review process to check for compliance, expiration dates, cycle counts, and other validations. This process typically takes 24–48 hours." }, "inventoryMovementUnits": { "type": "number", "description": "Units are being transferred to another WFS fulfillment center to improve item availability for more customers. This process typically takes 7–10 business days." } }, "required": [ "inventoryReviewUnits", "inventoryMovementUnits" ], "description": "The number of units that have been sent to WFS but have not yet been received." }, "onhandUnits": { "type": "number", "description": "The sum of available units, reserved units, and temporarily unavailable units due to inventory review and movement to other fulfillment centers." }, "inventoryAge": { "type": "object", "properties": { "0To90days": { "type": "number" }, "91To180days": { "type": "number" }, "181To270days": { "type": "number" }, "271To365days": { "type": "number" }, "365PlusDays": { "type": "number" } }, "required": [ "0To90days", "91To180days", "181To270days", "271To365days", "365PlusDays" ], "description": "The breakdown of units across age buckets provides an overview of how long units have been stored in a WFS fulfillment center. For example, 365PlusDays indicates the number of units stored in a WFS fulfillment center for over 365 days." }, "firstInStockDate": { "type": "string", "format": "date-time", "description": "The date when an item arrives for the first time at a WFS fulfillment center." } }, "required": [ "publishingStatus", "itemLifecycle", "stockStatus", "availableUnits", "inboundUnits", "unavailableUnits", "onhandUnits", "inventoryAge", "firstInStockDate" ] }, "inventoryInsights": { "type": "object", "properties": { "salesForecastWeek1to4": { "type": "number", "description": "The number of units estimated to sell in the next 1-4 weeks, based on the item's forecasted sales demand." }, "salesForecastWeek5to8": { "type": "number", "description": "The number of units estimated to sell in the next 5-8 weeks based on the item's forecasted sales demand." }, "salesForecastWeek9to12": { "type": "number", "description": "The number of units estimated to sell in the next 9-12 weeks based on the item's forecasted sales demand." }, "sellThroughRate": { "type": "number", "description": "The number of units shipped to customers in the last 90 days divided by the average number of units stored in a WFS fulfillment center during the same period." }, "daysOfSupply": { "type": "string", "description": "The anticipated number of days your current available and inbound inventory will last, based on your daily forecasted sales demand." }, "outOfStockDate": { "type": "string", "format": "date-time", "description": "The estimated date when the item will run out of stock, based on its days of supply." }, "suggestedUnits": { "type": "number", "description": "The number of units recommended by Walmart to send to WFS based on the item's forecasted sales demand. These suggestions are generated by algorithms considering several factors including past sales, seasonality, listing, quality, pricing, and more." }, "surplusUnits": { "type": "number", "description": "The number of units that exceed 180 days of supply, calculated based on the item's forecasted sales demand." } }, "required": [ "salesForecastWeek1to4", "salesForecastWeek5to8", "salesForecastWeek9to12", "sellThroughRate", "daysOfSupply", "outOfStockDate", "suggestedUnits", "surplusUnits" ] } }, "required": [ "itemInformation", "inventoryData", "inventoryInsights" ] }, "getWfsInventoryDetailsUpdated": { "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "row": { "type": "object", "properties": { "asin1": { "type": "string" }, "seller-sku": { "type": "string" }, "product-id": { "type": "string" }, "product-id-type": { "type": "string" } }, "required": [ "asin1", "seller-sku", "product-id", "product-id-type" ], "description": "row from the GET_MERCHANT_LISTINGS_DATA report" }, "getInventorySummaries": { "type": "object", "properties": { "asin": { "type": "string", "description": "The Amazon Standard Identification Number (ASIN) of an item." }, "fnSku": { "type": "string", "description": "Amazon's fulfillment network SKU identifier." }, "sellerSku": { "type": "string", "description": "The seller SKU of the item." }, "condition": { "type": "string", "description": "The condition of the item as described by the seller (for example, New Item)." }, "inventoryDetails": { "type": "object", "properties": { "fulfillableQuantity": { "type": "number", "description": "The item quantity that can be picked, packed, and shipped." }, "inboundWorkingQuantity": { "type": "number", "description": "The number of units in an inbound shipment for which you have notified Amazon." }, "inboundShippedQuantity": { "type": "number", "description": "The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number." }, "inboundReceivingQuantity": { "type": "number", "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." }, "reservedQuantity": { "type": "object", "properties": { "totalReservedQuantity": { "type": "number", "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." }, "pendingCustomerOrderQuantity": { "type": "number", "description": "The number of units reserved for customer orders." }, "pendingTransshipmentQuantity": { "type": "number", "description": "The number of units being transferred from one fulfillment center to another." }, "fcProcessingQuantity": { "type": "number", "description": "The number of units that have been sidelined at the fulfillment center for additional processing." } }, "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." }, "researchingQuantity": { "type": "object", "properties": { "totalResearchingQuantity": { "type": "number", "description": "The total number of units currently being researched in Amazon's fulfillment network." }, "researchingQuantityBreakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "researchingQuantityInShortTerm", "researchingQuantityInMidTerm", "researchingQuantityInLongTerm" ], "description": "The duration of the research." }, "quantity": { "type": "number", "description": "The number of units." } }, "required": [ "name", "quantity" ] }, "description": "A list of quantity details for items currently being researched." } } }, "unfulfillableQuantity": { "type": "object", "properties": { "totalUnfulfillableQuantity": { "type": "number", "description": "The total number of units in Amazon's fulfillment network in unsellable condition." }, "customerDamagedQuantity": { "type": "number", "description": "The number of units in customer damaged disposition." }, "warehouseDamagedQuantity": { "type": "number", "description": "The number of units in warehouse damaged disposition." }, "distributorDamagedQuantity": { "type": "number", "description": "The number of units in distributor damaged disposition." }, "carrierDamagedQuantity": { "type": "number", "description": "The number of units in carrier damaged disposition." }, "defectiveQuantity": { "type": "number", "description": "The number of units in defective disposition." }, "expiredQuantity": { "type": "number", "description": "The number of units in expired disposition." } } } }, "description": "The condition of the item as described by the seller (for example, New Item)." }, "lastUpdatedTime": { "type": "string", "description": "The date and time that any quantity was last updated." }, "productName": { "type": "string", "description": "The localized language product title of the item within the specific marketplace." }, "totalQuantity": { "type": "number", "description": "The total number of units in an inbound shipment or in Amazon fulfillment centers." }, "stores": { "type": "array", "items": { "type": "string" }, "description": "A list of seller-enrolled stores that apply to this seller SKU." } }, "description": "row from the GET_MERCHANT_LISTINGS_DATA report" } } } ], "description": "Fees to sell this item" }, { "type": "null" } ] }, "fulfillment_channel": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Fulfilled by Amazon, Walmart etc." }, "updated_by": { "type": [ "string", "null" ] }, "supply_detail": { "anyOf": [ {}, { "type": "null" } ] }, "net_payout": { "type": [ "number", "null" ] }, "condition_notes": { "anyOf": [ {}, { "type": "null" } ] }, "storage_type": { "type": [ "string", "null" ] }, "prep_details": { "type": [ "object", "null" ], "properties": { "allOwnersConstraint": { "type": "string", "enum": [ "MUST_MATCH" ] }, "labelOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "msku": { "type": "string", "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepCategory": { "type": "string", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "description": "The merchant SKU, a merchant-supplied identifier for a specific SKU." }, "prepOwnerConstraint": { "type": "string", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ] }, "prepTypes": { "type": "array", "items": { "type": "string", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ] }, "description": "A list of preparation types associated with a preparation category." } }, "required": [ "msku", "prepCategory", "prepTypes" ] }, "listing": { "anyOf": [ {}, { "type": "null" } ] }, "update_listing_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Listing data returned by get/put/patchListingsItem" }, "listings_notifications": { "anyOf": [ {}, { "type": "null" } ] }, "listings_notification_at": { "type": [ "string", "null" ], "format": "date-time" }, "country_of_origin": { "type": [ "string", "null" ] }, "fnsku": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "user_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } }, "required": [ "tag_id", "user_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } } }, "UpdateInventorySearchParams": { "type": "object", "properties": { "sku": { "type": "string" } } }, "UpdateItemAtLocation": { "type": "object", "properties": { "location_id": { "type": "string", "nullable": false }, "sku": { "type": "string", "nullable": false }, "fulfillable": { "type": "number", "description": "The quantity of the item at this location that can be sold.", "nullable": false }, "damaged": { "type": "number", "description": "The quantity of the item at this location that can be sold.", "nullable": false }, "notes": { "type": "string", "nullable": false }, "attachment_id": { "type": "string", "nullable": false }, "set_fulfillable": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that can be sold." }, "set_damaged": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that can be sold." }, "purchase_order_item_id": { "type": [ "string", "null" ] } } }, "UpdateItemAtLocationBodyItem": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "fulfillable": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that can be sold." }, "set_fulfillable": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that can be sold." }, "set_damaged": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that can be sold." }, "purchase_order_item_id": { "type": [ "string", "null" ] } }, "required": [ "sku" ] }, "UpdateItemsAtLocationBody": { "type": "object", "properties": { "update_items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "fulfillable": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that can be sold." }, "set_fulfillable": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that can be sold." }, "set_damaged": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that can be sold." }, "purchase_order_item_id": { "type": [ "string", "null" ] } }, "required": [ "sku" ] }, "nullable": false } }, "required": [ "update_items" ] }, "UpdateItemsAtLocationResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "number" }, "data": {}, "message": { "type": "string" } }, "required": [ "message" ] } }, "updated": { "type": "array", "items": { "type": "object", "properties": { "item_location_id": { "type": "string" }, "user_id": { "type": "string" }, "location_id": { "type": "string" }, "sku": { "type": "string" }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "attachment_id": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "fulfillable": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "damaged": { "type": "number", "description": "The quantity of the item at this location that can be sold." }, "total": { "type": [ "number", "null" ], "description": "The quantity of the item at this location that cannot be sold in its current state." }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "The sum of `fulfillable` and `damaged` quantity at this location." }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "item_location_id", "user_id", "location_id", "sku", "lot_code", "expires", "cost", "supplier_id", "attachment_id", "notes", "fulfillable", "damaged", "total", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by" ] } } }, "required": [ "updated" ] }, "UpdateLocationPathParams": { "type": "object", "properties": { "location_id": { "type": "string", "description": "comma separated list of `location_id`s" } }, "required": [ "location_id" ] }, "UpdateLocationsParams": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "location_id": { "type": "string", "nullable": false }, "location_name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "location_type": { "type": [ "string", "null" ], "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ] }, "ship_from_id": { "type": [ "string", "null" ] } }, "required": [ "location_id" ] }, "nullable": false } }, "required": [ "locations" ] }, "UpdateLocationsResponse": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "properties": { "location_id": { "type": "string" }, "user_id": { "type": "string" }, "location_name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "location_type": { "type": "string", "enum": [ "Bin", "Cart", "Dock", "Rack", "Storage", "Table" ] }, "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "location_id", "user_id", "location_name", "description", "location_type", "ship_from_id", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by" ] } } }, "required": [ "locations" ] }, "UpdateMapping": { "type": "object", "properties": { "mapping_type": { "type": "string", "enum": [ "inventory", "product" ], "nullable": false }, "bundle_id": { "type": "string", "nullable": false, "description": "Set if the input_value refers to a SKU from a bundle" }, "input_value": { "type": "string", "description": "Set if the input_value refers to a SKU from a bundle", "nullable": false }, "output_value": { "type": "string", "description": "When mapping_type = inventory, this is the internal sku, otherwise it is an arbitrary string", "nullable": false }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)", "nullable": false }, "mapping_id": { "type": "string", "nullable": false } }, "required": [ "mapping_id" ] }, "UpdateMappingsParams": { "type": "object", "properties": { "mappings": { "type": "array", "items": { "type": "object", "properties": { "mapping_type": { "type": "string", "enum": [ "inventory", "product" ], "nullable": false }, "bundle_id": { "type": "string", "nullable": false, "description": "Set if the input_value refers to a SKU from a bundle" }, "input_value": { "type": "string", "description": "Set if the input_value refers to a SKU from a bundle", "nullable": false }, "output_value": { "type": "string", "description": "When mapping_type = inventory, this is the internal sku, otherwise it is an arbitrary string", "nullable": false }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)", "nullable": false }, "mapping_id": { "type": "string", "nullable": false } }, "required": [ "mapping_id" ] }, "nullable": false } }, "required": [ "mappings" ] }, "UpdateMappingsResponse": { "type": "array", "items": { "type": "object", "properties": { "mapping_id": { "type": "string" }, "user_id": { "type": "string" }, "mapping_type": { "type": "string", "enum": [ "inventory", "product" ] }, "bundle_id": { "type": [ "string", "null" ], "description": "Set if the input_value refers to a SKU from a bundle" }, "input_value": { "type": "string", "description": "Set if the input_value refers to a SKU from a bundle" }, "output_value": { "type": "string", "description": "When mapping_type = inventory, this is the internal sku, otherwise it is an arbitrary string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)" } }, "required": [ "mapping_id", "user_id", "mapping_type", "bundle_id", "input_value", "output_value", "marketplace_id" ] } }, "UpdatePackTemplateBody": { "type": "object", "properties": { "owner": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center", "nullable": false }, "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center", "nullable": false }, "length": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ], "nullable": false }, "weight": { "type": "number", "nullable": false }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ], "nullable": false } } }, "UpdatePackTemplateItem": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false } } }, "UpdatePackTemplateItemsBody": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false } } }, "nullable": false } } }, "UpdatePackTemplateItemsParams": { "type": "object", "properties": { "pack_template_id": { "type": "string", "nullable": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false } } }, "nullable": false } }, "required": [ "pack_template_id", "items" ] }, "UpdatePackTemplateItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "quantity": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "pack_template_id", "user_id", "sku", "quantity", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by" ] } } }, "required": [ "items" ] }, "UpdatePackTemplateParams": { "type": "object", "properties": { "owner": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center", "nullable": false }, "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center", "nullable": false }, "length": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ], "nullable": false }, "weight": { "type": "number", "nullable": false }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ], "nullable": false }, "pack_template_id": { "type": "string", "nullable": false } }, "required": [ "pack_template_id" ] }, "UpdatePackTemplateResponse": { "type": "object", "properties": { "pack_templates": { "type": "array", "items": { "type": "object", "properties": { "pack_template_id": { "type": "string" }, "user_id": { "type": "string" }, "owner": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "pack_template_name": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": [ "number", "null" ] }, "unit_of_weight": { "type": [ "string", "null" ], "enum": [ "KG", "LB" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] } }, "required": [ "pack_template_id", "user_id", "owner", "pack_template_name", "length", "width", "height", "unit_of_measurement", "weight", "unit_of_weight", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by" ] } }, "errors": { "type": "array", "items": {} } } }, "UpdatePlan": { "type": "object", "properties": { "ship_from_id": { "type": "string", "nullable": false }, "errors": { "nullable": false, "description": "The method by which the plan was created" }, "plan_name": { "type": "string", "description": "For Walmart plans, this is the inbound_order_id", "nullable": false }, "flow": { "type": "string", "enum": [ "pack_first", "pack_later" ], "nullable": false, "description": "For Walmart plans, this is the inbound_order_id" }, "location_id": { "type": "string", "nullable": false }, "pick_list": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "location_name": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "location_id": { "type": [ "string", "null" ], "description": "present only if requested `with_location_id`" } }, "required": [ "sku", "location_name", "quantity" ] }, "nullable": false }, "content_information_source": { "type": "string", "enum": [ "BARCODE_2D", "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS" ], "nullable": false, "description": "When PO items are imported into a plan, this is a list of what locations in the warehouse contain the imported items." }, "status": { "type": "string", "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ], "nullable": false }, "prep_matrix_type": { "type": "string", "nullable": false }, "prep_matrix_price": { "type": "number", "nullable": false }, "prep_matrix_currency_code": { "type": "string", "nullable": false }, "expected_delivery_date": { "type": "string", "format": "date-time", "nullable": false }, "data": { "type": "object", "properties": { "email": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "phoneNumber": { "type": [ "string", "null" ] }, "customPlacement": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "warehouseId": { "type": "string", "nullable": false }, "mskus": { "type": "array", "items": { "type": "string" }, "nullable": false } }, "required": [ "warehouseId", "mskus" ] } }, "delivery_date": { "type": [ "string", "null" ], "description": "Expected delivery date for shipment" } }, "nullable": false, "description": "Data used to generate WM Inbound Preview or AZ Inbound Plan" }, "archived": { "type": [ "boolean", "null" ] }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_name": { "type": "string", "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_id": { "type": [ "string", "null" ] } } } } } }, "UpdatePlanItem": { "type": "object", "properties": { "plan_item_id": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "plan_id": { "type": "object" }, "user_id": { "type": "object" }, "sku": { "type": "object" }, "marketplace_id": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "az-AE" ] }, { "type": "string", "enum": [ "az-AU" ] }, { "type": "string", "enum": [ "az-BE" ] }, { "type": "string", "enum": [ "az-BR" ] }, { "type": "string", "enum": [ "az-CA" ] }, { "type": "string", "enum": [ "az-CN" ] }, { "type": "string", "enum": [ "az-DE" ] }, { "type": "string", "enum": [ "az-EG" ] }, { "type": "string", "enum": [ "az-ES" ] }, { "type": "string", "enum": [ "az-FR" ] }, { "type": "string", "enum": [ "az-GB" ] }, { "type": "string", "enum": [ "az-IE" ] }, { "type": "string", "enum": [ "az-IN" ] }, { "type": "string", "enum": [ "az-IT" ] }, { "type": "string", "enum": [ "az-JP" ] }, { "type": "string", "enum": [ "az-MX" ] }, { "type": "string", "enum": [ "az-NL" ] }, { "type": "string", "enum": [ "az-PL" ] }, { "type": "string", "enum": [ "az-SA" ] }, { "type": "string", "enum": [ "az-SE" ] }, { "type": "string", "enum": [ "az-SG" ] }, { "type": "string", "enum": [ "az-TR" ] }, { "type": "string", "enum": [ "az-US" ] }, { "type": "string", "enum": [ "az-ZA" ] }, { "type": "string", "enum": [ "wm-CA" ] }, { "type": "string", "enum": [ "wm-CL" ] }, { "type": "string", "enum": [ "wm-MX" ] }, { "type": "string", "enum": [ "wm-US" ] } ] }, "quantity": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "creation_source": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "purchase_order" ] }, { "type": "string", "enum": [ "api" ] }, { "type": "string", "enum": [ "import" ] }, { "type": "string", "enum": [ "manual" ] }, { "type": "string", "enum": [ "spreadsheet" ] } ] }, "errors": { "type": "object" }, "created": { "oneOf": [ { "type": "object" }, { "type": "string", "format": "date-time" } ] }, "created_by": { "type": "object" }, "updated": { "oneOf": [ { "type": "object" }, { "type": "string", "format": "date-time" } ] }, "updated_by": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "deleted": { "type": "object" }, "deleted_by": { "type": "object" }, "expires": { "type": "object" }, "cost": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "supplier_id": { "type": "object" }, "lot_code": { "type": "object" }, "packing_group_ids": { "oneOf": [ { "type": "object" }, { "type": "object", "additionalProperties": { "type": "number" } } ] }, "print_fnsku_label_quantity": { "type": "object" }, "quantity_in_case": { "type": "object" }, "item_prep": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "addOnServices": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "serviceType": { "type": "string", "enum": [ "LABEL", "BAG", "TAPE", "WRAP" ] } }, "required": [ "serviceType" ] } } ] }, "labelOwner": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "NONE" ] }, { "type": "string", "enum": [ "AMAZON" ] }, { "type": "string", "enum": [ "SELLER" ] } ] }, "prepOwner": { "type": "object" }, "prepInstructions": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "fee": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "number" }, "code": { "type": "string" } }, "required": [ "amount", "code" ] } ] }, "prepOwner": { "type": "object" }, "prepType": { "type": "object" } } } } ] }, "label_type": { "type": "object" }, "prep_category": { "type": "object" } } } ] }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "object" }, "tag_name": { "type": "object" }, "color": { "type": "object" }, "uri": { "type": "object" }, "icon": { "type": "object" } } } } ] } } }, "UpdatePlanItemBody": { "type": "object", "properties": { "plan_item": { "type": "object", "properties": { "plan_item_id": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "plan_id": { "type": "object" }, "user_id": { "type": "object" }, "sku": { "type": "object" }, "marketplace_id": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "az-AE" ] }, { "type": "string", "enum": [ "az-AU" ] }, { "type": "string", "enum": [ "az-BE" ] }, { "type": "string", "enum": [ "az-BR" ] }, { "type": "string", "enum": [ "az-CA" ] }, { "type": "string", "enum": [ "az-CN" ] }, { "type": "string", "enum": [ "az-DE" ] }, { "type": "string", "enum": [ "az-EG" ] }, { "type": "string", "enum": [ "az-ES" ] }, { "type": "string", "enum": [ "az-FR" ] }, { "type": "string", "enum": [ "az-GB" ] }, { "type": "string", "enum": [ "az-IE" ] }, { "type": "string", "enum": [ "az-IN" ] }, { "type": "string", "enum": [ "az-IT" ] }, { "type": "string", "enum": [ "az-JP" ] }, { "type": "string", "enum": [ "az-MX" ] }, { "type": "string", "enum": [ "az-NL" ] }, { "type": "string", "enum": [ "az-PL" ] }, { "type": "string", "enum": [ "az-SA" ] }, { "type": "string", "enum": [ "az-SE" ] }, { "type": "string", "enum": [ "az-SG" ] }, { "type": "string", "enum": [ "az-TR" ] }, { "type": "string", "enum": [ "az-US" ] }, { "type": "string", "enum": [ "az-ZA" ] }, { "type": "string", "enum": [ "wm-CA" ] }, { "type": "string", "enum": [ "wm-CL" ] }, { "type": "string", "enum": [ "wm-MX" ] }, { "type": "string", "enum": [ "wm-US" ] } ] }, "quantity": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "creation_source": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "purchase_order" ] }, { "type": "string", "enum": [ "api" ] }, { "type": "string", "enum": [ "import" ] }, { "type": "string", "enum": [ "manual" ] }, { "type": "string", "enum": [ "spreadsheet" ] } ] }, "errors": { "type": "object" }, "created": { "oneOf": [ { "type": "object" }, { "type": "string", "format": "date-time" } ] }, "created_by": { "type": "object" }, "updated": { "oneOf": [ { "type": "object" }, { "type": "string", "format": "date-time" } ] }, "updated_by": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "deleted": { "type": "object" }, "deleted_by": { "type": "object" }, "expires": { "type": "object" }, "cost": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "supplier_id": { "type": "object" }, "lot_code": { "type": "object" }, "packing_group_ids": { "oneOf": [ { "type": "object" }, { "type": "object", "additionalProperties": { "type": "number" } } ] }, "print_fnsku_label_quantity": { "type": "object" }, "quantity_in_case": { "type": "object" }, "item_prep": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "addOnServices": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "serviceType": { "type": "string", "enum": [ "LABEL", "BAG", "TAPE", "WRAP" ] } }, "required": [ "serviceType" ] } } ] }, "labelOwner": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "NONE" ] }, { "type": "string", "enum": [ "AMAZON" ] }, { "type": "string", "enum": [ "SELLER" ] } ] }, "prepOwner": { "type": "object" }, "prepInstructions": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "fee": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "number" }, "code": { "type": "string" } }, "required": [ "amount", "code" ] } ] }, "prepOwner": { "type": "object" }, "prepType": { "type": "object" } } } } ] }, "label_type": { "type": "object" }, "prep_category": { "type": "object" } } } ] }, "tags": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "object" }, "tag_name": { "type": "object" }, "color": { "type": "object" }, "uri": { "type": "object" }, "icon": { "type": "object" } } } } ] } }, "nullable": false } }, "required": [ "plan_item" ] }, "UpdatePlanItemResponse": { "type": "object", "properties": { "plan_item": { "type": "object", "properties": {} } }, "required": [ "plan_item" ] }, "UpdatePlanItems": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false } } } }, "UpdatePlanItemsBody": { "type": "object", "properties": { "plan_items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false } } }, "nullable": false } }, "required": [ "plan_items" ] }, "UpdatePlanItemsResponse": { "type": "object", "properties": { "plan_items": { "type": "array", "items": { "type": "object", "properties": { "plan_item_id": { "type": "string" }, "plan_id": { "type": "string" }, "user_id": { "type": "string" }, "sku": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "purchase_order", "api", "import", "manual", "spreadsheet" ] }, "errors": { "type": "object" }, "created": { "type": "string" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ] }, "updated_by": { "type": "object" }, "deleted": { "type": "object" }, "deleted_by": { "type": "object" }, "expires": { "type": "object" }, "cost": { "type": [ "number", "null" ] }, "supplier_id": { "type": "object" }, "lot_code": { "type": "object" }, "packing_group_ids": { "type": [ "object", "null" ], "additionalProperties": { "type": "number" } }, "print_fnsku_label_quantity": { "type": "number" }, "quantity_in_case": { "type": "number" }, "item_prep": { "type": [ "object", "null" ], "properties": { "addOnServices": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "serviceType": { "type": "string", "enum": [ "LABEL", "BAG", "TAPE", "WRAP" ] } }, "required": [ "serviceType" ] } } ] }, "labelOwner": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "NONE" ] }, { "type": "string", "enum": [ "AMAZON" ] }, { "type": "string", "enum": [ "SELLER" ] } ] }, "prepOwner": { "type": "object" }, "prepInstructions": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "fee": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "amount": { "type": "number" }, "code": { "type": "string" } }, "required": [ "amount", "code" ] } ] }, "prepOwner": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "prepType": { "type": "object" } } } } ] }, "label_type": { "type": "object" }, "prep_category": { "type": "object" } } } }, "required": [ "plan_item_id", "plan_id", "user_id", "sku", "marketplace_id", "quantity", "creation_source", "errors", "created", "created_by", "updated", "updated_by", "deleted", "deleted_by", "expires", "cost", "supplier_id", "lot_code", "packing_group_ids", "print_fnsku_label_quantity", "quantity_in_case", "item_prep" ] } } }, "required": [ "plan_items" ] }, "UpdatePlanPathParams": { "type": "object", "properties": { "plan_id": { "type": "string", "description": "A comma separated list of `plan_id`s, eg. `123,456`" } }, "required": [ "plan_id" ] }, "UpdatePlanResponse": { "type": "object" }, "UpdatePlansResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "number" }, "data": {}, "message": { "type": "string" } }, "required": [ "message" ] } }, "plans": { "type": "array", "items": { "type": "object" } } } }, "UpdatePriceBody": { "type": "object", "properties": { "sku": { "type": "string" }, "pricing": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "effectiveDate": { "oneOf": [ { "type": "object" }, { "type": "string", "format": "date-time" } ] }, "expirationDate": { "type": "object" }, "promoId": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "processMode": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "UPSERT" ] }, { "type": "string", "enum": [ "DELETE" ] } ] }, "currentPriceType": { "type": "string", "enum": [ "BASE", "REDUCED", "CLEARANCE" ] }, "currentPrice": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "CAD", "USD" ] }, "amount": { "type": "number" } }, "required": [ "currency", "amount" ] }, "comparisonPriceType": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "BASE" ] } ] }, "comparisonPrice": { "oneOf": [ { "type": "object" }, { "type": "object" } ] }, "priceDisplayCodes": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "CART" ] }, { "type": "string", "enum": [ "CHECKOUT" ] } ] } }, "required": [ "currentPriceType", "currentPrice" ] } } ] }, "offerId": { "type": "object" }, "replaceAll": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "true" ] }, { "type": "string", "enum": [ "false" ] } ] }, "definitions": { "oneOf": [ { "type": "object" }, { "type": "object", "additionalProperties": { "type": "string" } } ] }, "no_save": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] } } }, "UpdatePriceResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "ItemPriceResponse": { "type": "object", "properties": { "statusCode": { "type": "number" }, "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ] }, "sku": { "type": "string" }, "message": { "type": "string" } }, "required": [ "mart", "sku", "message" ] } } }, "UpdatePriceSearchParams": { "type": "object", "properties": { "price": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "currency": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "CAD" ] }, { "type": "string", "enum": [ "USD" ] } ] }, "sku": { "type": "string" }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "UpdatePurchaseOrderItem": { "type": "object", "properties": { "gtin": { "type": "string" }, "condition_id": { "type": "number", "description": "The GTIN of the item" }, "notes": { "type": [ "string", "null" ] }, "shopper": { "type": [ "string", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "purchased": { "type": "string", "format": "date-time" }, "price": { "type": [ "number", "null" ] }, "cost": { "type": [ "number", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item." }, "missing": { "type": "number", "description": "Any damaged quantity" }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities" }, "lot_code": { "type": [ "string", "null" ] }, "intent": { "type": [ "object", "null" ], "properties": { "marketplace": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": "array", "items": { "type": "object" } } }, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "sku": { "type": "string" }, "condition_name": { "type": "string" }, "supplier": { "type": "string" }, "set_ordered": { "type": "number" }, "set_received": { "type": "number" }, "set_damaged": { "type": "number" }, "set_missing": { "type": "number" }, "set_not_ordered": { "type": "number" }, "delete": { "type": "boolean" } }, "required": [ "sku" ] }, "UpdatePurchaseOrderItemsBody": { "type": "object", "properties": { "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "gtin": { "type": "string", "nullable": false }, "condition_id": { "type": "number", "description": "The GTIN of the item", "nullable": false }, "notes": { "type": "string", "nullable": false }, "shopper": { "type": "string", "nullable": false }, "supplier_id": { "type": "number", "nullable": false }, "purchased": { "type": "string", "format": "date-time", "nullable": false }, "price": { "type": "number", "nullable": false }, "cost": { "type": "number", "nullable": false }, "expires": { "type": "string", "format": "date-time", "nullable": false }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received.", "nullable": false }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received.", "nullable": false }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item.", "nullable": false }, "missing": { "type": "number", "description": "Any damaged quantity", "nullable": false }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities", "nullable": false }, "lot_code": { "type": "string", "nullable": false }, "intent": { "type": "object", "properties": { "marketplace": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "external_id": { "type": [ "string", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "quantity": { "type": [ "number", "null" ] } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": [ "array", "null" ], "items": { "type": "object" } } }, "nullable": false, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_id": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false } } } }, "sku": { "type": "string", "nullable": false }, "condition_name": { "type": [ "string", "null" ] }, "supplier": { "type": [ "string", "null" ] }, "set_ordered": { "type": [ "number", "null" ] }, "set_received": { "type": [ "number", "null" ] }, "set_damaged": { "type": [ "number", "null" ] }, "set_missing": { "type": [ "number", "null" ] }, "set_not_ordered": { "type": [ "number", "null" ] }, "delete": { "type": [ "boolean", "null" ] } }, "required": [ "sku" ] }, "nullable": false } }, "required": [ "purchase_order_items" ] }, "UpdatePurchaseOrderItemsParams": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "gtin": { "type": "string" }, "condition_id": { "type": "number", "description": "The GTIN of the item" }, "notes": { "type": [ "string", "null" ] }, "shopper": { "type": [ "string", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "purchased": { "type": "string", "format": "date-time" }, "price": { "type": [ "number", "null" ] }, "cost": { "type": [ "number", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item." }, "missing": { "type": "number", "description": "Any damaged quantity" }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities" }, "lot_code": { "type": [ "string", "null" ] }, "intent": { "type": [ "object", "null" ], "properties": { "marketplace": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": "array", "items": { "type": "object" } } }, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } }, "sku": { "type": "string" }, "condition_name": { "type": "string" }, "supplier": { "type": "string" }, "set_ordered": { "type": "number" }, "set_received": { "type": "number" }, "set_damaged": { "type": "number" }, "set_missing": { "type": "number" }, "set_not_ordered": { "type": "number" }, "delete": { "type": "boolean" } }, "required": [ "sku" ] } }, "purchased": { "type": "string", "format": "date-time" }, "ledger_entry_type": { "type": "string", "enum": [ "PO_CREATED", "PO_RECEIPT_ADJUSTED", "PO_RECEIVED" ] } }, "required": [ "purchase_order_id", "purchase_order_items" ] }, "UpdatePurchaseOrderItemsResponse": { "type": "object", "properties": { "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_item_id": { "type": "string" }, "user_id": { "type": "string" }, "purchase_order_id": { "type": "string" }, "gtin": { "type": "string" }, "condition_id": { "type": "number", "description": "The GTIN of the item" }, "sku": { "type": "string" }, "notes": { "type": [ "string", "null" ] }, "ordered": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "received": { "type": "number", "description": "For the PO context, this is the quantity the user ordered from the supplier. This may differ from the actual quantity received." }, "damaged": { "type": "number", "description": "In the PO context, this is the quantity the user received from the supplier. Otherwise, it is simply the quantity of the item." }, "missing": { "type": "number", "description": "Any damaged quantity" }, "not_ordered": { "type": "number", "description": "We explicitly track missing quantities" }, "intent": { "type": [ "object", "null" ], "properties": { "marketplace": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "external_id": { "type": "string" }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "quantity": { "type": "number" } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": "array", "items": { "type": "object" } } }, "description": "Quantity received that was not part of the original order. This can happen when suppliers send more than ordered." }, "shopper": { "type": [ "string", "null" ] }, "supplier_id": { "type": [ "number", "null" ] }, "purchased": { "type": "string", "format": "date-time" }, "price": { "type": [ "number", "null" ] }, "cost": { "type": [ "number", "null" ] }, "lot_code": { "type": [ "string", "null" ] }, "expires": { "type": [ "string", "null" ], "format": "date-time" }, "product_tax_code": { "type": [ "string", "null" ], "enum": [ "A_AUTOMOTIVE_MOTOROIL", "A_BABY_BRSTPUMP", "A_BABY_CARSEAT", "A_BABY_CLOTH", "A_BABY_DIAPER", "A_BOOKS_GEN", "A_BOOKS_RELIG", "A_BOOKS_RENTAL", "A_BUNDLE_PERDCL", "A_CLSFD_52W-4Q", "A_CLSFD_52WKLY", "A_CLSFD_ANNUAL", "A_CLSFD_SEMIANNL", "A_CLTH_ATHL", "A_CLTH_BATH", "A_CLTH_BOOKBAG", "A_CLTH_BUCKLS", "A_CLTH_COMPON", "A_CLTH_CSTUMS", "A_CLTH_FORMAL", "A_CLTH_FUR", "A_CLTH_GEN", "A_CLTH_HAIRACCESSORIES", "A_CLTH_HANDKE", "A_CLTH_HBAGS", "A_CLTH_IFUR", "A_CLTH_PROTECTIVE", "A_CLTH_UMBRELLA", "A_COLLECTIBLE_COIN", "A_COMP_COMPUTER", "A_COMP_EDUSOFT", "A_COMP_GAMPER", "A_COMP_PDA", "A_COMP_PERIPH", "A_COMP_PRINT", "A_COMP_PRTSUP", "A_COMP_SCANNER", "A_COMP_SOFTOP", "A_COMP_SOFTRC", "A_COMP_STORAGEMEDIA", "A_EGOODS_DIGITALAUDIOBOOKS", "A_EGOODS_DIGITALBOOKS", "A_EGOODS_DIGITALBOOK_RENTAL", "A_EGOODS_DIGITALGAMES", "A_EGOODS_DIGITALMUSIC", "A_EGOODS_DIGITALNEWS", "A_EGOODS_DIGITALNEWSSUBS", "A_EGOODS_DIGITALPERDCL", "A_EGOODS_DIGITALPERDCLSUBS", "A_EGOODS_MISC1", "A_EGOODS_ONLINEGAMINGSUBS", "A_EGOODS_SOFT", "A_EMERGENCY_SUPPLIES", "A_FOOD_BKTCDY50-90", "A_FOOD_BKTGN50-75", "A_FOOD_BKTGN76-90", "A_FOOD_CARBSFTDK", "A_FOOD_CARBWTR", "A_FOOD_CNDY", "A_FOOD_CNDYFL", "A_FOOD_GEN", "A_FOOD_JUICE0-50", "A_FOOD_JUICE51-99", "A_FOOD_NCARBWTR", "A_FOOD_PETFOOD", "A_FOOD_WINE", "A_GEN_NOTAX", "A_GEN_RENTAL", "A_GEN_TAX", "A_HLTH_BABYSUPPLS", "A_HLTH_BANDKIT", "A_HLTH_CONTACTSOLN", "A_HLTH_CONTRCEPV", "A_HLTH_COSMETIC", "A_HLTH_DIABSUPPLS", "A_HLTH_DIETSUPMT", "A_HLTH_DISPOSABLE_PACK", "A_HLTH_FAMPLANTEST", "A_HLTH_FEMHYG", "A_HLTH_HEARINGAID_BATT", "A_HLTH_INCONT", "A_HLTH_MEDHAIRLOSS", "A_HLTH_MOBILITY", "A_HLTH_MONITOR", "A_HLTH_OTCMED", "A_HLTH_PROSTHETIC", "A_HLTH_SPFCORALHYG", "A_HLTH_SPFCOTCMED", "A_HLTH_SUNSCRN", "A_HLTH_THRMTR", "A_HLTH_TISSUETOW", "A_HLTH_TOOTHPASTEFL", "A_HOUSEHOLD_LINEN", "A_HOUSEHOLD_PAPERPRODS", "A_NEWS_104PLUS", "A_NEWS_12MTHLY", "A_NEWS_26BIWKLY", "A_NEWS_4QTLY", "A_NEWS_52WKLY", "A_PERDCL_104PLUS", "A_PERDCL_52W-4Q", "A_PERDCL_52WKLY", "A_PERDCL_ANNUAL", "A_PERDCL_SEMIANNL", "A_SCHL_GRAPHCALC", "A_SCHL_INSTRUMENT", "A_SCHL_SUPPLS", "A_SERV_INSTALL", "A_SPORT_ASUPPORT", "A_SPORT_ATHLSHOES", "A_SPORT_BIKEHLMT", "A_SPORT_MISCSPORTS1", "A_SPORT_SKISUIT", "A_SPORT_WINTERSPORTBOOTS", "A_WARR_PARTSNSRVC", "A_WARR_PARTSNSVCE" ], "description": "Amazon's product tax code identifier" }, "created": { "type": [ "string", "null" ], "format": "date-time", "description": "Amazon's product tax code identifier" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "condition_name": { "type": "string" } }, "required": [ "condition_name" ] } } }, "required": [ "purchase_order_items" ] }, "UpdatePurchaseOrderItemsSearchParams": { "type": "object", "properties": { "purchased": { "type": "string", "format": "date-time" }, "ledger_entry_type": { "type": "string", "enum": [ "PO_CREATED", "PO_RECEIPT_ADJUSTED", "PO_RECEIVED" ] } } }, "UpdatePurchaseOrderParams": { "type": "object", "properties": { "purchase_order_name": { "type": "string" }, "ship_from_id": { "type": "string", "description": "The ID of the supplier." }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view" }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time", "description": "A transitional column marking this PO created in the WFS plan view" }, "purchase_order_id": { "type": "string" }, "purchase_order_status": { "type": "string", "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "supplier": { "type": "string" }, "archived": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_name": { "type": "string" }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] }, "tag_id": { "type": "string" } } } } }, "required": [ "purchase_order_id" ] }, "UpdatePurchaseOrderResponse": { "type": "object", "properties": { "purchase_order_id": { "type": "string" }, "purchase_order_name": { "type": "string" }, "user_id": { "type": "string" }, "ship_from_id": { "type": "string", "description": "The ID of the supplier." }, "created": { "type": "string", "format": "date-time", "description": "The ID of the supplier." }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_status": { "type": "string", "enum": [ "CREATED", "RECEIVED", "RECEIVING", "SHIPPED", "UNLOADED" ], "description": "The method by which the first purchase order item was created" }, "purchase_order_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when the purchase order was generated" }, "supplier_id": { "type": [ "string", "null" ], "description": "The date when the purchase order was generated" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "external_id": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "notes": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "attachment_id": { "type": [ "number", "null" ] }, "wfs": { "type": "boolean", "description": "A transitional column marking this PO created in the WFS plan view" }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time", "description": "A transitional column marking this PO created in the WFS plan view" } }, "required": [ "purchase_order_id", "purchase_order_name", "user_id", "ship_from_id", "created", "created_by", "creation_source", "purchase_order_status", "purchase_order_date", "supplier_id", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by", "external_id", "notes", "attachment_id", "wfs", "expected_delivery_date" ] }, "UpdateReportScheduleBody": { "type": "object", "properties": { "scheduleId": { "type": "string" }, "repeatsEvery": { "type": "number" }, "hour": { "type": "number" }, "dayOfMonth": { "type": "number" }, "dayOfWeek": { "type": "number" }, "monthOfYear": { "type": "number" }, "scheduleStartDate": { "type": "string" } } }, "UpdateReportScheduleResponse": { "type": "object", "properties": { "scheduleId": { "type": "string", "description": "Unique identifier for the schedule." }, "requestSubmissionDate": { "type": "string", "format": "date-time", "description": "The timestamp (date and time) indicating when the report request was submitted." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated." }, "reportVersion": { "type": "string", "description": "Specifies the version of report for which the request is created. Example: v1." }, "reportSummary": { "type": "string", "description": "Provides a brief summary of the report." }, "scheduleStartDate": { "type": "string", "description": "Specifies the start date for the schedule. The date should be in a valid date format (Example: YYYY-MM-DD)." }, "nextScheduledTime": { "type": "string", "description": "The next scheduled time for the report." }, "payload": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ], "description": "Specifies the frequency at which the report should be generated. For example, if set to YEARLY, the report will be generated once every year." }, "repeatsEvery": { "type": "number", "description": "Defines the interval at which the report repeats based on the selected frequency." }, "hour": { "type": "number", "description": "Specifies the hour of the day at which the schedule will be triggered. Allowed values are from 0 to 23, where 0 corresponds to 12:00 AM UTC and 23 corresponds to 11:00 PM UTC. The hour selection is based on the UTC timezone." }, "dayOfMonth": { "type": "number", "description": "Specifies the day of the month on which the schedule will be triggered." }, "dayOfWeek": { "type": "number", "description": "Specifies the day of the week on which the schedule will be triggered. Allowed values are from 0 to 6, where 0 represents Monday and 6 represents Sunday." }, "monthOfYear": { "type": "number", "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." }, "filters": { "type": "object", "properties": { "email": { "type": "string" }, "rowFilters": { "type": "object", "properties": { "type": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } }, "columnName": { "type": "string" } }, "required": [ "type", "values", "columnName" ] } }, "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." } }, "description": "The next scheduled time for the report." }, "requestModifiedTime": { "type": "string", "description": "The date and time when the report schedule was last modified." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } } } }, "UpdateReportScheduleSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "UpdateSettingsSearchParams": { "type": "object", "properties": { "client_id": { "type": "string", "description": "if provided, update the setting at the client-level" } } }, "UpdateShipFromBody": { "type": "object", "properties": { "ship_from": { "type": "object", "properties": { "ship_from_name": { "type": "string", "nullable": false }, "address_line_1": { "type": "string", "nullable": false }, "address_line_2": { "type": "string", "nullable": false }, "city": { "type": "string", "nullable": false }, "state_code": { "type": "string", "nullable": false }, "postal_code": { "type": "string", "nullable": false }, "country_code": { "type": "string", "nullable": false }, "contact_name": { "type": "string", "nullable": false }, "email": { "type": "string", "nullable": false }, "phone": { "type": "string", "nullable": false }, "archived": { "type": [ "boolean", "null" ] } }, "nullable": false } }, "required": [ "ship_from" ] }, "UpdateShipFromParams": { "type": "object", "properties": { "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "ship_from_id": { "type": "string" }, "archived": { "type": "boolean" } }, "required": [ "ship_from_id" ] }, "UpdateShipFromPathParams": { "type": "object", "properties": { "ship_from_id": { "type": "string" } }, "required": [ "ship_from_id" ] }, "UpdateShipFromResponse": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "place_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ] }, "UpdateShipFromRouteResponse": { "type": "object", "properties": { "ship_from": { "type": "object", "properties": { "ship_from_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ship_from_name": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state_code": { "type": [ "string", "null" ] }, "postal_code": { "type": "string" }, "country_code": { "type": "string" }, "contact_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "place_id": { "type": [ "string", "null" ] }, "created_by": { "type": "string", "description": "Who created this address, also doubles as the owner" }, "updated": { "type": [ "string", "null" ], "format": "date-time", "description": "Who created this address, also doubles as the owner" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "ship_from_id", "created", "ship_from_name", "address_line_1", "address_line_2", "city", "state_code", "postal_code", "country_code", "contact_name", "email", "phone", "place_id", "created_by", "updated", "updated_by", "archived", "archived_by" ] } }, "required": [ "ship_from" ] }, "UpdateShipmentNameBody": { "type": "object", "properties": { "name": { "type": "string", "description": "A human-readable name to update the shipment name to.", "nullable": false } }, "required": [ "name" ] }, "UpdateShipmentNameErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "UpdateShipmentNameSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "UpdateShipmentQuantitiesBody": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "inboundOrderId": { "type": "string", "description": "Unique ID identifying inbound shipment request.", "nullable": false }, "shipmentId": { "type": "string", "description": "Unique ID identifying inbound shipment.", "nullable": false }, "orderItems": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "description": "Seller Item ID", "nullable": false }, "updatedShipmentQty": { "type": "number", "description": "updated quantity", "nullable": false } }, "required": [ "sku", "updatedShipmentQty" ] }, "description": "update shipment qty line items. Length between 1 and 5000", "nullable": false } } }, "UpdateShipmentQuantitiesResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code identifying the failure." }, "field": { "type": "string", "description": "Name of the request field or entity associated with the error, when applicable." }, "description": { "type": "string", "description": "Human-readable explanation of the error." }, "info": { "type": "string", "description": "Additional diagnostic details or a link-friendly message." }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ], "description": "Error severity." }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ], "description": "Error category." }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Sub-error code indicating a specific cause." }, "field": { "type": "string", "description": "Field related to the sub-error, if any." }, "type": { "type": "string", "description": "Classification of the sub-error (implementation-specific)." }, "description": { "type": "string", "description": "Details describing the sub-error." } } }, "description": "List of underlying causes contributing to the error." }, "errorIdentifiers": { "type": "object", "additionalProperties": {}, "description": "Key-value container for service-specific error identifiers." }, "component": { "type": "string", "description": "Originating component or subsystem name." }, "type": { "type": "string", "description": "High-level error type or family (implementation-specific)." }, "serviceName": { "type": "string", "description": "Service that produced the error." }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ], "description": "Gateway error grouping." } }, "required": [ "code" ] } }, "status": { "type": "string", "enum": [ "OK", "CREATED", "ACCEPTED", "NO_CONTENT", "PARTIAL", "MOVED_PERMANENT", "FOUND", "SEE_OTHER", "NOT_MODIFIED", "TEMPORARY_REDIRECT", "BAD_REQUEST", "UNAUTHORIZED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "REQUEST_TIMEOUT", "CONFLICT", "REQUEST_ENTITY_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "UNPROCESSABLE_ENTITY", "TOO_MANY_REQUESTS", "FAIL", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "GATEWAY_TIMEOUT" ] }, "header": { "type": "object", "properties": { "headerAttributes": { "type": "object", "additionalProperties": {} } }, "required": [ "headerAttributes" ] }, "payload": { "type": "object", "additionalProperties": {} } } }, "UpdateShipmentQuantitiesSearchParams": { "type": "object", "properties": { "mp": { "type": "string" } }, "required": [ "mp" ] }, "UpdateShipmentTrackingDetailsBody": { "type": "object", "properties": { "trackingDetails": { "type": "object", "properties": { "ltlTrackingDetail": { "type": [ "object", "null" ], "properties": { "billOfLadingNumber": { "type": [ "string", "null" ], "description": "The number of the carrier shipment acknowledgement document." }, "freightBillNumber": { "type": "array", "items": { "type": "string" }, "description": "Number associated with the freight bill.", "nullable": false } }, "required": [ "freightBillNumber" ] }, "spdTrackingDetail": { "type": [ "object", "null" ], "properties": { "spdTrackingItems": { "type": "array", "items": { "type": "object", "properties": { "boxId": { "type": "string", "description": "The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box.", "nullable": false }, "trackingId": { "type": "string", "description": "The tracking Id associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. The seller must provide this information.", "nullable": false } }, "required": [ "boxId", "trackingId" ] }, "description": "List of Small Parcel Delivery (SPD) tracking items input.", "nullable": false } }, "required": [ "spdTrackingItems" ] } }, "nullable": false } }, "required": [ "trackingDetails" ] }, "UpdateShipmentTrackingDetailsErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." }, "message": { "type": "string", "description": "A message that describes the error condition." } }, "required": [ "code", "message" ] }, "description": "List of errors." } }, "required": [ "errors" ] }, "UpdateShipmentTrackingDetailsResponse": { "type": "object", "properties": { "operationId": { "type": "string", "description": "UUID for the given operation." } }, "required": [ "operationId" ] }, "UpdateShipmentTrackingDetailsSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } }, "required": [ "mp" ] }, "UpdateSubscriptionBody": { "type": "object", "properties": { "eventType": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "partnerId": { "type": "object" }, "eventVersion": { "type": "object" }, "resourceName": { "type": "object" }, "status": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "INACTIVE" ] } ] }, "eventUrl": { "type": "object" }, "authDetails": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "authMethod": { "type": "string", "enum": [ "BASIC_AUTH", "OAUTH", "HMAC" ] }, "userName": { "type": "string" }, "password": { "type": "string" }, "authHeaderName": { "type": "string" }, "authUrl": { "type": "string" }, "clientSecret": { "type": "string" }, "clientId": { "type": "string" } }, "required": [ "authMethod", "userName", "password", "authHeaderName", "authUrl", "clientSecret", "clientId" ] } ] }, "headers": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "content-type": { "type": "string" } }, "required": [ "content-type" ] } ] }, "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "UpdateSubscriptionResponse": { "type": "object", "properties": { "eventType": { "type": "string", "description": "Event type for which the subscription was created." }, "subscriptionId": { "type": "string", "description": "Unique identifier for the subscription that you can use to fetch details, edit, or delete the subscription." }, "partnerId": { "type": "string", "description": "Partner ID of the seller who created the subscription." }, "eventVersion": { "type": "string", "description": "Version of the event type for which the subscription was created." }, "resourceName": { "type": "string", "description": "Resource or functional category that the event type is mapped to (for example, ITEM, ORDER, PRICE)." }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ], "description": "Current state of the subscription." }, "eventUrl": { "type": "string", "description": "Destination URL where notifications for this subscription will be delivered." }, "authDetails": { "type": "object", "properties": { "authMethod": { "type": "string", "enum": [ "BASIC_AUTH", "OAUTH", "HMAC" ], "description": "Authentication method for the destination URL." }, "userName": { "type": "string", "description": "Username used to access the destination URL (required for BASIC_AUTH)." }, "password": { "type": "string", "description": "Password used to access the destination URL (required for BASIC_AUTH)." }, "authHeaderName": { "type": "string", "description": "Header name used to pass the authorization value to the destination URL (for example, Authorization)." }, "authUrl": { "type": "string", "description": "OAuth server or token URL used when the authentication method is OAUTH." }, "clientSecret": { "type": "string", "description": "Client secret used with the OAuth server (OAUTH) or as key material for HMAC." }, "clientId": { "type": "string", "description": "Client ID used with the OAuth server when the authentication method is OAUTH." } }, "required": [ "authMethod", "userName", "password", "authHeaderName", "authUrl", "clientSecret", "clientId" ], "description": "Destination URL where notifications for this subscription will be delivered." }, "headers": { "type": "object", "properties": { "content-type": { "type": "string" } }, "required": [ "content-type" ], "description": "Headers required for accessing the destination URL." } }, "required": [ "eventType", "subscriptionId", "partnerId", "eventVersion", "resourceName", "status", "eventUrl", "authDetails", "headers" ] }, "UpdateSubscriptionSearchParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] } } }, "UpdateSupplier": { "type": "object", "properties": { "supplier_id": { "type": "string", "nullable": false }, "supplier_name": { "type": [ "string", "null" ] } }, "required": [ "supplier_id" ] }, "UpdateSuppliersParams": { "type": "object", "properties": { "suppliers": { "type": "array", "items": { "type": "object", "properties": { "supplier_id": { "type": "string", "nullable": false }, "supplier_name": { "type": [ "string", "null" ] } }, "required": [ "supplier_id" ] }, "nullable": false } }, "required": [ "suppliers" ] }, "UpdateSuppliersResponse": { "type": "object", "properties": { "suppliers": { "type": "array", "items": { "type": "object", "properties": { "supplier_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "supplier_name": { "type": "string" }, "user_id": { "type": "string" }, "created_by": { "type": [ "string", "null" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] } }, "required": [ "supplier_id", "created", "supplier_name", "user_id", "created_by", "updated", "updated_by", "archived", "archived_by" ] } } }, "required": [ "suppliers" ] }, "UpdateTag": { "type": "object", "properties": { "tag_name": { "type": "string", "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_id": { "type": "string", "nullable": false } }, "required": [ "tag_id" ] }, "UpdateTagsParams": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_name": { "type": "string", "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false }, "tag_id": { "type": "string", "nullable": false } }, "required": [ "tag_id" ] }, "nullable": false } }, "required": [ "tags" ] }, "UpdateTagsResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "user_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } }, "required": [ "tag_id", "user_id", "tag_name", "tag_type", "color", "uri", "icon" ] } } }, "required": [ "tags" ] }, "UpdateUserClientsParams": { "type": "object", "properties": { "user_clients": { "type": "array", "items": { "type": "object", "properties": { "client_ids": { "type": "array", "items": { "type": "string", "nullable": false }, "nullable": false }, "user_ids": { "type": "array", "items": { "type": "string", "nullable": false }, "nullable": false }, "deleted": { "type": [ "boolean", "null" ] } }, "required": [ "client_ids", "user_ids" ] }, "nullable": false } }, "required": [ "user_clients" ] }, "UpdateUserClientsResponse": { "type": "object", "properties": { "user_clients": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string" }, "client_id": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "client_id", "deleted" ] } } }, "required": [ "user_clients" ] }, "UpdateUserFunctionResponse": { "type": "object", "properties": { "user_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "user_name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" }, "business_name": { "type": [ "string", "null" ], "description": "The name of the user" }, "email": { "type": "string" }, "last_ip": { "type": [ "string", "null" ], "description": "Most recent IP address user logged in from" }, "last_login": { "type": [ "string", "null" ], "format": "date-time", "description": "Most recent IP address user logged in from" }, "last_proxy": { "type": [ "string", "null" ], "format": "date-time" }, "last_instance": { "type": [ "string", "null" ], "description": "The last instance the user logged in from" }, "referred_by_id": { "type": [ "string", "null" ], "description": "The last instance the user logged in from" }, "parent_id": { "type": [ "string", "null" ] }, "next_auto": { "type": [ "number", "null" ] }, "abbreviated_business": { "type": [ "string", "null" ], "description": "The user provided abbreviated version of their business name" }, "abbreviated_name": { "type": [ "string", "null" ], "description": "The user provided abbreviated version of their business name" }, "sync_orders": { "type": "boolean", "description": "The user provided abbreviated version of their name" }, "save_inventory_value": { "type": "boolean", "description": "Whether or not to sync the user's orders" }, "attach_unshipped_cogs": { "type": "boolean", "description": "Whether or not to save the user's inventory value" }, "region": { "type": "string", "enum": [ "eu-west-1", "us-east-1", "us-west-1" ], "description": "Whether or not to attach the user's unshipped COGS to their orders" }, "active": { "type": "boolean", "description": "Whether or not the user is active. Generally used for toggling sub user access" }, "otp_type": { "type": [ "string", "null" ], "enum": [ "app", "email" ] }, "locked": { "type": "boolean" }, "locked_until": { "type": [ "string", "null" ], "format": "date-time" }, "wfs_inventory_report_schedule_id": { "type": [ "string", "null" ] }, "shiphero_refresh_token": { "type": [ "string", "null" ] }, "subscription_id": { "type": [ "string", "null" ] }, "subscription_start": { "type": [ "string", "null" ], "format": "date-time" }, "subscription_valid_thru": { "type": [ "string", "null" ], "format": "date-time" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "rate_limit": { "type": [ "string", "null" ], "enum": [ "fast", "medium", "slow", "ui" ], "description": "Number of requests per second the user is allowed to make" } } }, "UpdateUserParams": { "type": "object", "properties": { "user_id": { "type": "string", "nullable": false }, "user_name": { "type": [ "string", "null" ], "description": "The user's name" }, "abbreviated_name": { "type": [ "string", "null" ], "description": "The user provided abbreviated version of their name" }, "email": { "type": [ "string", "null" ], "description": "The user's email" }, "password": { "type": [ "string", "null" ], "description": "Plaintext password, will be hashed before storing" }, "active": { "type": [ "boolean", "null" ], "description": "Whether or not the user is active." } }, "required": [ "user_id" ] }, "UpdateUserResponse": { "type": "object", "properties": { "user": { "type": "object", "properties": { "user_id": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "user_name": { "type": [ "string", "null" ], "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" }, "business_name": { "type": [ "string", "null" ], "description": "The name of the user" }, "email": { "type": "string" }, "last_ip": { "type": [ "string", "null" ], "description": "Most recent IP address user logged in from" }, "last_login": { "type": [ "string", "null" ], "format": "date-time", "description": "Most recent IP address user logged in from" }, "last_proxy": { "type": [ "string", "null" ], "format": "date-time" }, "last_instance": { "type": [ "string", "null" ], "description": "The last instance the user logged in from" }, "referred_by_id": { "type": [ "string", "null" ], "description": "The last instance the user logged in from" }, "parent_id": { "type": [ "string", "null" ] }, "next_auto": { "type": [ "number", "null" ] }, "abbreviated_business": { "type": [ "string", "null" ], "description": "The user provided abbreviated version of their business name" }, "abbreviated_name": { "type": [ "string", "null" ], "description": "The user provided abbreviated version of their business name" }, "sync_orders": { "type": "boolean", "description": "The user provided abbreviated version of their name" }, "save_inventory_value": { "type": "boolean", "description": "Whether or not to sync the user's orders" }, "attach_unshipped_cogs": { "type": "boolean", "description": "Whether or not to save the user's inventory value" }, "region": { "type": "string", "enum": [ "eu-west-1", "us-east-1", "us-west-1" ], "description": "Whether or not to attach the user's unshipped COGS to their orders" }, "active": { "type": "boolean", "description": "Whether or not the user is active. Generally used for toggling sub user access" }, "otp_type": { "type": [ "string", "null" ], "enum": [ "app", "email" ] }, "locked": { "type": "boolean" }, "locked_until": { "type": [ "string", "null" ], "format": "date-time" }, "wfs_inventory_report_schedule_id": { "type": [ "string", "null" ] }, "shiphero_refresh_token": { "type": [ "string", "null" ] }, "subscription_id": { "type": [ "string", "null" ] }, "subscription_start": { "type": [ "string", "null" ], "format": "date-time" }, "subscription_valid_thru": { "type": [ "string", "null" ], "format": "date-time" }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "rate_limit": { "type": [ "string", "null" ], "enum": [ "fast", "medium", "slow", "ui" ], "description": "Number of requests per second the user is allowed to make" } } } }, "required": [ "user" ] }, "UpdateUserRolesParams": { "type": "object", "properties": { "user_roles": { "type": "array", "items": { "type": "object", "properties": { "role_ids": { "type": "array", "items": { "type": "string", "enum": [ "3pl-billing", "admin", "api", "integration", "manage-team", "prep-center", "prep-client" ] }, "nullable": false }, "user_ids": { "type": "array", "items": { "type": "string", "nullable": false }, "nullable": false }, "deleted": { "type": [ "boolean", "null" ] } }, "required": [ "role_ids", "user_ids" ] }, "nullable": false } }, "required": [ "user_roles" ] }, "UpdateUserRolesResponse": { "type": "object", "properties": { "user_roles": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string" }, "role_id": { "type": "string", "enum": [ "3pl-billing", "admin", "api", "integration", "manage-team", "prep-center", "prep-client" ] }, "deleted": { "type": "boolean" } }, "required": [ "role_id", "deleted" ] } } }, "required": [ "user_roles" ] }, "UpdateUserShipFromsParams": { "type": "object", "properties": { "user_ship_froms": { "type": "array", "items": { "type": "object", "properties": { "ship_from_ids": { "type": "array", "items": { "type": "string", "nullable": false }, "nullable": false }, "user_ids": { "type": "array", "items": { "type": "string", "nullable": false }, "nullable": false }, "deleted": { "type": [ "boolean", "null" ] } }, "required": [ "ship_from_ids", "user_ids" ] }, "nullable": false } }, "required": [ "user_ship_froms" ] }, "UpdateUserShipFromsResponse": { "type": "object", "properties": { "user_ship_froms": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string" }, "ship_from_id": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "ship_from_id", "deleted" ] } } }, "required": [ "user_ship_froms" ] }, "UpdateWmPalletParams": { "type": "object", "properties": { "shipment_id": { "type": "string", "nullable": false }, "pallet_id": { "type": "string", "nullable": false }, "pallet": { "type": "object", "properties": { "pallet_id": { "type": "string", "nullable": false }, "shipment_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "package_sequence_number": { "type": "number", "nullable": false }, "weight": { "type": "number", "nullable": false }, "weight_uom": { "type": "string", "enum": [ "lb" ], "nullable": false }, "length": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "length_uom": { "type": "string", "enum": [ "in" ], "nullable": false }, "no_of_packages": { "type": "number", "nullable": false }, "stackable": { "type": "boolean", "nullable": false } }, "nullable": false } }, "required": [ "shipment_id", "pallet_id", "pallet" ] }, "UpdateWmPalletsBody": { "type": "object", "properties": { "pallets": { "type": "array", "items": { "type": "object", "properties": { "pallet_id": { "type": "string", "nullable": false }, "shipment_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "package_sequence_number": { "type": "number", "nullable": false }, "weight": { "type": "number", "nullable": false }, "weight_uom": { "type": "string", "enum": [ "lb" ], "nullable": false }, "length": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "length_uom": { "type": "string", "enum": [ "in" ], "nullable": false }, "no_of_packages": { "type": "number", "nullable": false }, "stackable": { "type": "boolean", "nullable": false } }, "required": [ "pallet_id" ] }, "nullable": false } }, "required": [ "pallets" ] }, "UpdateWmPalletsBodyItem": { "type": "object", "properties": { "pallet_id": { "type": "string", "nullable": false }, "shipment_id": { "type": "string", "nullable": false }, "user_id": { "type": "string", "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "created_by": { "type": "string", "nullable": false }, "creation_source": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "nullable": false }, "updated": { "type": "string", "format": "date-time", "nullable": false }, "updated_by": { "type": "string", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "deleted_by": { "type": "string", "nullable": false }, "package_sequence_number": { "type": "number", "nullable": false }, "weight": { "type": "number", "nullable": false }, "weight_uom": { "type": "string", "enum": [ "lb" ], "nullable": false }, "length": { "type": "number", "nullable": false }, "height": { "type": "number", "nullable": false }, "width": { "type": "number", "nullable": false }, "length_uom": { "type": "string", "enum": [ "in" ], "nullable": false }, "no_of_packages": { "type": "number", "nullable": false }, "stackable": { "type": "boolean", "nullable": false } }, "required": [ "pallet_id" ] }, "UpdateWmPalletsResponse": { "type": "object", "properties": { "pallets": { "type": "array", "items": { "type": "object" } }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "pallets", "errors" ] }, "UpdateWmShipment": { "type": "object", "properties": { "shipment_items": { "type": "array", "items": { "type": "object", "properties": { "images": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] } }, "user_id": { "type": "string" }, "plan_id": { "type": [ "number", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "creation_source": { "type": [ "string", "null" ], "enum": [ "purchase_order", "api", "import", "manual", "spreadsheet" ] }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "deleted": { "type": "object" }, "deleted_by": { "type": "object" }, "status": { "type": "string" }, "shipment_id": { "type": "string", "nullable": false }, "ship_from_id": { "type": "number" }, "archived": { "type": "object" }, "archived_by": { "type": "object" }, "synced": { "type": "object" }, "ship_to_address": { "type": [ "object", "null" ], "properties": { "fcName": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "fcName", "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "shipment_units": { "type": "object" }, "received_units": { "type": "object" }, "items_submitted": { "type": "object" }, "received_units_at_fc": { "type": "object" }, "expected_delivery_date": { "type": "object" }, "updated_expected_delivery_date": { "type": "object" }, "actual_delivery_date": { "type": "object" }, "tracking_no": { "type": [ "object", "null" ] }, "carrier_name": { "type": "object" }, "channel_method": { "type": "object" }, "ship_node": { "type": "object" }, "shipment_type": { "type": "object" }, "po_type": { "type": "object" }, "shipment_carrier_type": { "type": "object" }, "is_exception_occurred": { "type": [ "boolean", "null" ], "enum": [ false, true ] }, "exception_status": { "type": "object" }, "is_po_box_enabled": { "type": "object" }, "transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object" }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "object" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "object" }, "carrierName": { "type": "string" }, "shipmentType": { "type": "string" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": { "type": "object" } } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "consolidated_transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object" } }, "receipt_start_date": { "type": "object" }, "receipt_end_date": { "type": "object" }, "data": { "type": "object" }, "carrier_rate_quotes": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "assessorialCharge": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "carrier": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "carrierId": { "type": "object" }, "carrierName": { "type": "object" } } } ] }, "currency": { "type": "object" }, "declaredValue": { "type": "object" }, "discountCharge": { "type": "object" }, "effectiveDate": { "type": "object" }, "equipmentTypeCode": { "type": "object" }, "estimatedDeliveryDateTime": { "type": "object" }, "expiryDate": { "type": "object" }, "freightCharge": { "type": "object" }, "freightReadyDate": { "type": "object" }, "fuelCharge": { "type": "object" }, "minimumCharge": { "type": "object" }, "mixedSKUs": { "type": "object" }, "mode": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "LTL" ] }, { "type": "string", "enum": [ "PARCEL" ] }, { "type": "string", "enum": [ "FTL" ] } ] }, "netCharge": { "type": "object" }, "nominalCharge": { "type": "object" }, "numberOfPallets": { "type": "object" }, "quoteId": { "type": "object" }, "sellerFreightClassCode": { "type": "object" }, "serviceCharge": { "type": "object" }, "serviceCode": { "type": "object" }, "singleSKUs": { "type": "object" }, "status": { "type": "object" }, "surchargeType": { "type": "object" }, "surchargeValue": { "type": "object" }, "totalBillingWeight": { "type": "object" }, "totalVolume": { "type": "object" }, "totalWeight": { "type": "object" }, "transitDays": { "type": "object" }, "sp_status": { "type": "object" } } } }, "inbound_order_id": { "type": "string" }, "single_sku_box_count": { "type": "object" }, "mixed_sku_box_count": { "type": "object" }, "user_shipment_carrier_type": { "type": "object" }, "preferred_pickup_date": { "type": "object" }, "freight_class": { "type": "object" }, "declared_value": { "type": "object" }, "pickup_instructions": { "type": "object" }, "pickup_seller_schedule": { "type": "object" }, "tags": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "tag_id": { "type": "string", "nullable": false }, "tag_name": { "type": "string", "nullable": false }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ], "nullable": false }, "color": { "type": "number", "nullable": false }, "uri": { "type": "string", "nullable": false }, "icon": { "type": "string", "nullable": false } } } }, "append_tracking_no": { "type": [ "object", "null" ] } }, "required": [ "shipment_id" ] }, "UploadReportBody": { "type": "string" }, "UploadReportFileParams": { "type": "object", "properties": { "mp": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "reportType": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] }, "reportId": { "type": "string", "description": "required for AZ reports" }, "requestId": { "type": "string", "description": "required for WM reports" }, "bg": { "type": "boolean", "description": "pass to return immediately without waiting for rows to actually save, useful for large files that may time out" } }, "required": [ "mp", "reportType" ] }, "UploadReportFileResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok" ] } }, "required": [ "status" ] }, "User": { "type": "object", "properties": { "user_id": { "type": "string", "nullable": false }, "created": { "type": "string", "format": "date-time", "nullable": false }, "password": { "type": "string", "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash", "nullable": false }, "user_name": { "type": "string", "nullable": false, "description": "Password stored as 59 or 60 byte ASCII encoded bcrypt hash" }, "business_name": { "type": "string", "nullable": false, "description": "The name of the user" }, "email": { "type": "string", "nullable": false }, "last_ip": { "type": "string", "nullable": false, "description": "Most recent IP address user logged in from" }, "last_login": { "type": "string", "format": "date-time", "nullable": false, "description": "Most recent IP address user logged in from" }, "last_proxy": { "type": "string", "format": "date-time", "nullable": false }, "last_instance": { "type": "string", "nullable": false, "description": "The last instance the user logged in from" }, "referred_by_id": { "type": "string", "nullable": false, "description": "The last instance the user logged in from" }, "parent_id": { "type": "string", "nullable": false }, "next_auto": { "type": "number", "nullable": false }, "abbreviated_business": { "type": "string", "nullable": false, "description": "The user provided abbreviated version of their business name" }, "abbreviated_name": { "type": "string", "nullable": false, "description": "The user provided abbreviated version of their business name" }, "sync_orders": { "type": "boolean", "description": "The user provided abbreviated version of their name", "nullable": false }, "save_inventory_value": { "type": "boolean", "description": "Whether or not to sync the user's orders", "nullable": false }, "attach_unshipped_cogs": { "type": "boolean", "description": "Whether or not to save the user's inventory value", "nullable": false }, "region": { "type": "string", "enum": [ "eu-west-1", "us-east-1", "us-west-1" ], "description": "Whether or not to attach the user's unshipped COGS to their orders", "nullable": false }, "active": { "type": "boolean", "description": "Whether or not the user is active. Generally used for toggling sub user access", "nullable": false }, "otp_secret": { "type": "string", "nullable": false, "description": "Whether or not the user is active. Generally used for toggling sub user access" }, "otp_type": { "type": "string", "enum": [ "app", "email" ], "nullable": false }, "locked": { "type": "boolean", "nullable": false }, "locked_until": { "type": "string", "format": "date-time", "nullable": false }, "wfs_inventory_report_schedule_id": { "type": "string", "nullable": false }, "shiphero_refresh_token": { "type": "string", "nullable": false }, "subscription_id": { "type": "string", "nullable": false }, "subscription_start": { "type": "string", "format": "date-time", "nullable": false }, "subscription_valid_thru": { "type": "string", "format": "date-time", "nullable": false }, "deleted": { "type": "string", "format": "date-time", "nullable": false }, "rate_limit": { "type": "string", "enum": [ "fast", "medium", "slow", "ui" ], "nullable": false, "description": "Number of requests per second the user is allowed to make" } }, "required": [ "user_id", "created", "password", "user_name", "business_name", "email", "last_ip", "last_login", "last_proxy", "last_instance", "referred_by_id", "parent_id", "next_auto", "abbreviated_business", "abbreviated_name", "sync_orders", "save_inventory_value", "attach_unshipped_cogs", "region", "active", "otp_secret", "otp_type", "locked", "locked_until", "wfs_inventory_report_schedule_id", "shiphero_refresh_token", "subscription_id", "subscription_start", "subscription_valid_thru", "deleted", "rate_limit" ] }, "user_rate_limit": { "type": "string", "enum": [ "fast", "medium", "slow", "ui" ] }, "user_region": { "type": "string", "enum": [ "eu-west-1", "us-east-1", "us-west-1" ] }, "UserClientGroup": { "type": "object", "properties": { "client_ids": { "type": "array", "items": { "type": "string", "nullable": false }, "nullable": false }, "user_ids": { "type": "array", "items": { "type": "string", "nullable": false }, "nullable": false }, "deleted": { "type": [ "boolean", "null" ] } }, "required": [ "client_ids", "user_ids" ] }, "UserClientUser": { "type": "object", "properties": { "user_id": { "type": "string" }, "client_id": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "client_id", "deleted" ] }, "UserRoleGroup": { "type": "object", "properties": { "role_ids": { "type": "array", "items": { "type": "string", "enum": [ "3pl-billing", "admin", "api", "integration", "manage-team", "prep-center", "prep-client" ] }, "nullable": false }, "user_ids": { "type": "array", "items": { "type": "string", "nullable": false }, "nullable": false }, "deleted": { "type": [ "boolean", "null" ] } }, "required": [ "role_ids", "user_ids" ] }, "UserRoleUser": { "type": "object", "properties": { "user_id": { "type": "string" }, "role_id": { "type": "string", "enum": [ "3pl-billing", "admin", "api", "integration", "manage-team", "prep-center", "prep-client" ] }, "deleted": { "type": "boolean" } }, "required": [ "role_id", "deleted" ] }, "UserShipFromGroup": { "type": "object", "properties": { "ship_from_ids": { "type": "array", "items": { "type": "string", "nullable": false }, "nullable": false }, "user_ids": { "type": "array", "items": { "type": "string", "nullable": false }, "nullable": false }, "deleted": { "type": [ "boolean", "null" ] } }, "required": [ "ship_from_ids", "user_ids" ] }, "UserShipFromUser": { "type": "object", "properties": { "user_id": { "type": "string" }, "ship_from_id": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "ship_from_id", "deleted" ] }, "Uuid": { "type": "string" }, "ValidatedBundle": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "quantity": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "items": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" } }, "required": [ "marketplace_id", "external_id" ] } } ] } }, "required": [ "input_sku", "output_sku", "input_quantity", "output_quantity" ] } } ] } }, "required": [ "bundle_id", "bundle_name" ] }, "ValidateItem": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "intent": { "type": [ "object", "null" ], "properties": { "marketplace": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "external_id": { "type": [ "string", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "quantity": { "type": [ "number", "null" ] } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": [ "array", "null" ], "items": { "type": "object" } } } } }, "required": [ "sku", "quantity" ] }, "ValidateItemsBody": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "intent": { "type": [ "object", "null" ], "properties": { "marketplace": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "external_id": { "type": [ "string", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "quantity": { "type": [ "number", "null" ] } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": [ "array", "null" ], "items": { "type": "object" } } } } }, "required": [ "sku", "quantity" ] }, "nullable": false }, "purchase_order_id": { "type": [ "string", "null" ] } } }, "ValidateItemsParams": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "intent": { "type": [ "object", "null" ], "properties": { "marketplace": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "sku": { "type": "string", "nullable": false }, "external_id": { "type": [ "string", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "nullable": false }, "quantity": { "type": [ "number", "null" ] } }, "required": [ "sku", "marketplace_id" ] } }, "bundle": { "type": [ "array", "null" ], "items": { "type": "object" } } } } }, "required": [ "sku", "quantity" ] }, "nullable": false } }, "required": [ "items" ] }, "ValidateItemsResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "valid", "invalid" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "skus": { "type": "array", "items": { "type": "string" } }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "warning", "error" ] } }, "required": [ "message", "severity" ] } }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "bundle_id": { "type": "string" }, "bundle_name": { "type": [ "string", "null" ] }, "quantity": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "items": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "input_sku": { "type": "string" }, "output_sku": { "type": "string" }, "input_quantity": { "type": "number" }, "output_quantity": { "type": "number" }, "marketplace": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "external_id": { "type": "string" } }, "required": [ "marketplace_id", "external_id" ] } } ] } }, "required": [ "input_sku", "output_sku", "input_quantity", "output_quantity" ] } } ] } }, "required": [ "bundle_id", "bundle_name" ] } } }, "required": [ "sku" ] } } }, "required": [ "status" ] }, "Weight": { "type": "object", "properties": { "value": { "type": "number" }, "unit": { "type": "string" } }, "required": [ "value" ] }, "WithErrors": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "number" }, "data": {}, "message": { "type": "string" } }, "required": [ "message" ] } } } }, "WithNext": { "type": "object", "properties": { "next": { "type": "string" } } }, "WithTags": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object", "properties": { "tag_id": { "type": "string" }, "tag_name": { "type": "string" }, "tag_type": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] }, "color": { "type": [ "number", "null" ] }, "uri": { "type": [ "string", "null" ] }, "icon": { "type": [ "string", "null" ] } } } } } }, "WmAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "WmApiShipment": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] }, "WmCarrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "WmCarrierRateQuote": { "type": "object", "properties": { "assessorialCharge": { "type": "number" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "declaredValue": { "type": "string" }, "discountCharge": { "type": "number" }, "effectiveDate": { "type": "string" }, "equipmentTypeCode": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string" }, "expiryDate": { "type": "string" }, "freightCharge": { "type": "number" }, "freightReadyDate": { "type": "string" }, "fuelCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "mixedSKUs": { "type": "number" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "netCharge": { "type": "number" }, "nominalCharge": { "type": "number" }, "numberOfPallets": { "type": "number" }, "quoteId": { "type": "string" }, "sellerFreightClassCode": { "type": "string" }, "serviceCharge": { "type": "number" }, "serviceCode": { "type": "string" }, "singleSKUs": { "type": "number" }, "status": { "type": "string" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "totalWeight": { "type": "number" }, "transitDays": { "type": "string" }, "sp_status": { "type": "string" } } }, "WmFeedBase": { "type": "object", "properties": { "feedId": { "type": "string", "description": "Unique ID used for tracking the feed file." }, "feedType": { "type": "string", "enum": [ "MP_ITEM_MATCH", "MP_ITEM", "inventory", "PRICE_AND_PROMOTION", "OMNI_WFS", "price" ], "description": "Type of feed submitted" }, "feedStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "PROCESSED", "ERROR", "Submitted" ], "description": "Current feed processing state." }, "itemsReceived": { "type": "number", "description": "Number of items received in the feed." }, "itemsSucceeded": { "type": "number", "description": "Number of items that processed successfully." }, "itemsFailed": { "type": "number", "description": "Number of items that failed due to a data or system error." }, "itemsProcessing": { "type": "number", "description": "Number of items still processing." } }, "required": [ "feedId", "feedType", "feedStatus", "itemsReceived", "itemsSucceeded", "itemsFailed", "itemsProcessing" ] }, "WmFeedError": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ] }, "code": { "type": "string", "description": "Item-level error code." }, "field": { "type": "string", "description": "Item-level error code." }, "description": { "type": "string", "description": "Item-level error description." } }, "required": [ "type", "code" ] }, "WmFeedStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "PROCESSED", "ERROR", "Submitted" ] }, "WmFeedType": { "type": "string", "enum": [ "MP_ITEM_MATCH", "MP_ITEM", "inventory", "PRICE_AND_PROMOTION", "OMNI_WFS", "price" ] }, "WmFtlPayload": { "type": "object", "properties": { "quoteId": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "aggregates": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "totalCharge": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "unitOfMeasure": { "type": "object" }, "measurementValue": { "oneOf": [ { "type": "object" }, { "type": "number" } ] } } } ] }, "totalDiscount": { "type": "object" }, "totalBillingWeight": { "type": "object" }, "totalWeight": { "type": "object" }, "totalVolume": { "type": "object" } } } ] }, "netCharge": { "type": "object" }, "fedExFreightCharge": { "type": "object" }, "serviceCharge": { "type": "object" }, "quoteStatus": { "type": "object" }, "mpsShipment": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "eligibleForITS": { "type": "object" }, "transitDetails": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object", "properties": { "stopOrigin": { "type": "object" }, "stopDestination": { "type": "object" }, "type": { "type": "object" }, "transitTime": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "unitOfMeasure": { "type": "object" }, "measurementValue": { "type": "object" }, "length": { "type": "number" }, "toString": { "type": "object" }, "toLocaleString": { "type": "object" }, "pop": { "type": "object" }, "push": { "type": "object" }, "concat": { "type": "object" }, "join": { "type": "object" }, "reverse": { "type": "object" }, "shift": { "type": "object" }, "slice": { "type": "object" }, "sort": { "type": "object" }, "splice": { "type": "object" }, "unshift": { "type": "object" }, "indexOf": { "type": "object" }, "lastIndexOf": { "type": "object" }, "every": { "type": "object" }, "some": { "type": "object" }, "forEach": { "type": "object" }, "map": { "type": "object" }, "filter": { "type": "object" }, "reduce": { "type": "object" }, "reduceRight": { "type": "object" }, "find": { "type": "object" }, "findIndex": { "type": "object" }, "fill": { "type": "object" }, "copyWithin": { "type": "object" }, "entries": { "type": "object" }, "keys": { "type": "object" }, "values": { "type": "object" }, "includes": { "type": "object" }, "flatMap": { "type": "object" }, "flat": { "type": "object" }, "at": { "type": "object" }, "findLast": { "type": "object" }, "findLastIndex": { "type": "object" }, "toReversed": { "type": "object" }, "toSorted": { "type": "object" }, "toSpliced": { "type": "object" }, "with": { "type": "object" }, "__@iterator@894": { "type": "object" }, "__@unscopables@896": { "type": "object", "properties": { "length": { "type": "object" }, "toString": { "type": "object" }, "toLocaleString": { "type": "object" }, "pop": { "type": "object" }, "push": { "type": "object" }, "concat": { "type": "object" }, "join": { "type": "object" }, "reverse": { "type": "object" }, "shift": { "type": "object" }, "slice": { "type": "object" }, "sort": { "type": "object" }, "splice": { "type": "object" }, "unshift": { "type": "object" }, "indexOf": { "type": "object" }, "lastIndexOf": { "type": "object" }, "every": { "type": "object" }, "some": { "type": "object" }, "forEach": { "type": "object" }, "map": { "type": "object" }, "filter": { "type": "object" }, "reduce": { "type": "object" }, "reduceRight": { "type": "object" }, "find": { "type": "object" }, "findIndex": { "type": "object" }, "fill": { "type": "object" }, "copyWithin": { "type": "object" }, "entries": { "type": "object" }, "keys": { "type": "object" }, "values": { "type": "object" }, "includes": { "type": "object" }, "flatMap": { "type": "object" }, "flat": { "type": "object" }, "at": { "type": "object" }, "findLast": { "type": "object" }, "findLastIndex": { "type": "object" }, "toReversed": { "type": "object" }, "toSorted": { "type": "object" }, "toSpliced": { "type": "object" }, "with": { "type": "object" }, "__@iterator@894": { "type": "object" }, "__@unscopables@896": { "type": "object" } } } }, "required": [ "length", "toString", "toLocaleString", "pop", "push", "concat", "join", "reverse", "shift", "slice", "sort", "splice", "unshift", "indexOf", "lastIndexOf", "every", "some", "forEach", "map", "filter", "reduce", "reduceRight", "find", "findIndex", "fill", "copyWithin", "entries", "keys", "values", "includes", "flatMap", "flat", "at", "findLast", "findLastIndex", "toReversed", "toSorted", "toSpliced", "with", "__@iterator@894", "__@unscopables@896" ] } ] } } } } ] }, "mode": { "type": "object" }, "effectiveDate": { "oneOf": [ { "type": "object" }, { "type": "string", "format": "date-time" } ] }, "expiryDate": { "type": "object" }, "schedule": { "oneOf": [ { "type": "object" }, { "type": "object", "properties": { "minPickupTs": { "type": "object" }, "maxPickupTs": { "type": "object" }, "minDueTs": { "type": "object" }, "maxDueTs": { "type": "object" } } } ] } } }, "WmGetCarrierRateQuotePayload": { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Unique identifier identifying each shipment" }, "shipmentPackages": { "type": "array", "items": { "type": "object", "properties": { "packageSequenceNumber": { "type": "number", "description": "Package Sequence Number" }, "isStackable": { "type": "boolean", "description": "Package Sequence Number" }, "width": { "type": "number", "description": "Width. ≥ -1" }, "length": { "type": "number", "description": "Length. ≥ -1" }, "weightUOM": { "type": "string", "enum": [ "lb" ], "description": "Weight unit of measurement, should always be \"lb\"" }, "lengthUOM": { "type": "string", "enum": [ "in" ], "description": "Length unit of measurement, should always be \"in\"" }, "height": { "type": "number", "description": "Height. ≥ -1" }, "noOfPackages": { "type": "number", "description": "Number of Packages" }, "weight": { "type": "number", "description": "Weight. -1 to 150" }, "volume": { "type": "number", "description": "Weight. -1 to 150" }, "totalMasterCases": { "type": "number" }, "totalUnitsPerMasterCases": { "type": "number" }, "totalUnits": { "type": "number" }, "billingWeight": { "type": "number", "description": "Billing Weight" }, "netCharge": { "type": "number", "description": "Billing Weight" }, "nominalCharge": { "type": "number" }, "assessorialCharge": { "type": "number" }, "serviceCharge": { "type": "number" }, "fedExFreightCharge": { "type": "number" }, "discountCharge": { "type": "number" } }, "required": [ "packageSequenceNumber", "width", "length", "weightUOM", "lengthUOM", "height", "weight" ] }, "description": "List of packages being shipped" }, "quoteType": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ], "description": "List of packages being shipped" }, "quoteId": { "type": "string", "description": "Unique identifier identifying each quote" }, "quoteCreationDate": { "type": "string", "format": "date-time", "description": "Creation date of quote" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } }, "description": "Creation date of quote" }, "originLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] } }, "required": [ "locationName", "address" ] }, "destinationLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] } }, "required": [ "locationName", "address" ] }, "rateQuote": { "type": "object", "properties": { "assessorialCharge": { "type": "number" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "declaredValue": { "type": "string" }, "discountCharge": { "type": "number" }, "effectiveDate": { "type": "string" }, "equipmentTypeCode": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string" }, "expiryDate": { "type": "string" }, "freightCharge": { "type": "number" }, "freightReadyDate": { "type": "string" }, "fuelCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "mixedSKUs": { "type": "number" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "netCharge": { "type": "number" }, "nominalCharge": { "type": "number" }, "numberOfPallets": { "type": "number" }, "quoteId": { "type": "string" }, "sellerFreightClassCode": { "type": "string" }, "serviceCharge": { "type": "number" }, "serviceCode": { "type": "string" }, "singleSKUs": { "type": "number" }, "status": { "type": "string" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "totalWeight": { "type": "number" }, "transitDays": { "type": "string" }, "sp_status": { "type": "string" } } }, "aggregates": { "type": "object", "properties": { "totalCharge": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalDiscount": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalBillingWeight": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalWeight": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalVolume": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } } } }, "netCharge": { "type": "number" }, "fedExFreightCharge": { "type": "number" }, "serviceCharge": { "type": "number" }, "quoteStatus": { "type": "string" }, "mpsShipment": { "type": "boolean" }, "estimatedDeliveryDateTime": { "type": "string", "format": "date-time" }, "eligibleForITS": { "type": "boolean" }, "status": { "type": "string", "enum": [ "OK", "ERROR" ] } }, "required": [ "shipmentId", "shipmentPackages", "status" ] }, "WmItemDetails": { "type": "object", "properties": { "itemIngestionStatus": { "type": "array", "items": { "type": "object", "properties": { "martId": { "type": "number", "description": "Mart identifier associated with the marketplace." }, "wpid": { "type": "string", "description": "Walmart product identifier assigned after item creation." }, "index": { "type": "number", "description": "Item position within the original feed payload." }, "ingestionStatus": { "type": "string", "enum": [ "INPROGRESS", "SUCCESS", "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ], "description": "Item ingestion status." }, "sku": { "type": "string", "description": "Seller-defined unique Stock Keeping Unit (SKU) for the item." }, "ingestionErrors": { "type": "object", "properties": { "ingestionError": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ] }, "code": { "type": "string", "description": "Item-level error code." }, "field": { "type": "string", "description": "Item-level error code." }, "description": { "type": "string", "description": "Item-level error description." } }, "required": [ "type", "code" ] } } }, "description": "List of errors for the item." } } }, "description": "Ingestion status entries for individual items in the feed." } } }, "WmItemIngestionStatus": { "type": "object", "properties": { "martId": { "type": "number", "description": "Mart identifier associated with the marketplace." }, "wpid": { "type": "string", "description": "Walmart product identifier assigned after item creation." }, "index": { "type": "number", "description": "Item position within the original feed payload." }, "ingestionStatus": { "type": "string", "enum": [ "INPROGRESS", "SUCCESS", "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ], "description": "Item ingestion status." }, "sku": { "type": "string", "description": "Seller-defined unique Stock Keeping Unit (SKU) for the item." }, "ingestionErrors": { "type": "object", "properties": { "ingestionError": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATA_ERROR", "SYSTEM_ERROR", "TIMEOUT_ERROR" ] }, "code": { "type": "string", "description": "Item-level error code." }, "field": { "type": "string", "description": "Item-level error code." }, "description": { "type": "string", "description": "Item-level error description." } }, "required": [ "type", "code" ] } } }, "description": "List of errors for the item." } } }, "WmLtlPayload": { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Unique identifier identifying each shipment" }, "shipmentPackages": { "type": "array", "items": { "type": "object", "properties": { "packageSequenceNumber": { "type": "number", "description": "Package Sequence Number" }, "isStackable": { "type": "boolean", "description": "Package Sequence Number" }, "width": { "type": "number", "description": "Width. ≥ -1" }, "length": { "type": "number", "description": "Length. ≥ -1" }, "weightUOM": { "type": "string", "enum": [ "lb" ], "description": "Weight unit of measurement, should always be \"lb\"" }, "lengthUOM": { "type": "string", "enum": [ "in" ], "description": "Length unit of measurement, should always be \"in\"" }, "height": { "type": "number", "description": "Height. ≥ -1" }, "noOfPackages": { "type": "number", "description": "Number of Packages" }, "weight": { "type": "number", "description": "Weight. -1 to 150" }, "volume": { "type": "number", "description": "Weight. -1 to 150" }, "totalMasterCases": { "type": "number" }, "totalUnitsPerMasterCases": { "type": "number" }, "totalUnits": { "type": "number" }, "billingWeight": { "type": "number", "description": "Billing Weight" }, "netCharge": { "type": "number", "description": "Billing Weight" }, "nominalCharge": { "type": "number" }, "assessorialCharge": { "type": "number" }, "serviceCharge": { "type": "number" }, "fedExFreightCharge": { "type": "number" }, "discountCharge": { "type": "number" } }, "required": [ "packageSequenceNumber", "width", "length", "weightUOM", "lengthUOM", "height", "weight" ] }, "description": "List of packages being shipped" }, "quoteType": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ], "description": "List of packages being shipped" }, "quoteId": { "type": "string", "description": "Unique identifier identifying each quote" }, "quoteCreationDate": { "type": "string", "format": "date-time", "description": "Creation date of quote" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } }, "description": "Creation date of quote" }, "originLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] } }, "required": [ "locationName", "address" ] }, "destinationLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] } }, "required": [ "locationName", "address" ] }, "rateQuote": { "type": "object", "properties": { "assessorialCharge": { "type": "number" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "declaredValue": { "type": "string" }, "discountCharge": { "type": "number" }, "effectiveDate": { "type": "string" }, "equipmentTypeCode": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string" }, "expiryDate": { "type": "string" }, "freightCharge": { "type": "number" }, "freightReadyDate": { "type": "string" }, "fuelCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "mixedSKUs": { "type": "number" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "netCharge": { "type": "number" }, "nominalCharge": { "type": "number" }, "numberOfPallets": { "type": "number" }, "quoteId": { "type": "string" }, "sellerFreightClassCode": { "type": "string" }, "serviceCharge": { "type": "number" }, "serviceCode": { "type": "string" }, "singleSKUs": { "type": "number" }, "status": { "type": "string" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "totalWeight": { "type": "number" }, "transitDays": { "type": "string" }, "sp_status": { "type": "string" } } }, "aggregates": { "type": "object", "properties": { "totalCharge": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalDiscount": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalBillingWeight": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalWeight": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalVolume": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } } } }, "netCharge": { "type": "number" }, "fedExFreightCharge": { "type": "number" }, "serviceCharge": { "type": "number" }, "quoteStatus": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "OK", "ERROR" ] } } }, "WmOrderItem": { "type": "object", "properties": { "productId": { "type": "string", "description": "Unique ID identifying product" }, "productType": { "type": "string", "enum": [ "GTIN" ], "description": "Supported product types are GTIN" }, "sku": { "type": "string", "description": "Seller Item ID" }, "itemDesc": { "type": "string", "description": "Item description" }, "itemQty": { "type": "number", "description": "Total number of sellable units. ≥ 1" }, "vendorPackQty": { "type": "number", "description": "Total number of cases. ≥ 1" }, "innerPackQty": { "type": "number", "description": "Total number of sellable units per case. ≥ 1" }, "expectedDeliveryDate": { "type": "string", "description": "Expected delivery date for shipment" }, "addOnServices": { "type": "array", "items": { "type": "object", "properties": { "serviceType": { "type": "string", "enum": [ "LABEL", "BAG", "TAPE", "WRAP" ] } } }, "description": "Indicate whether add-on services (e.g. item labeling or poly bagging) are needed" }, "itemNbr": { "type": "number", "description": "Indicate whether add-on services (e.g. item labeling or poly bagging) are needed" }, "dimensions": { "type": "array", "items": { "type": "number" } }, "itemWeightQty": { "type": "number" }, "nonSortItem": { "type": "boolean" }, "shipNode": { "type": "string" } }, "required": [ "productId", "productType", "sku", "itemDesc", "itemQty", "vendorPackQty", "innerPackQty", "expectedDeliveryDate" ] }, "WmPackageType": { "type": "string", "enum": [ "SINGLE SKUS", "MIXED SKUS", "PALLET" ] }, "WmParcelPayload": { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Unique identifier identifying each shipment" }, "shipmentPackages": { "type": "array", "items": { "type": "object", "properties": { "packageSequenceNumber": { "type": "number", "description": "Package Sequence Number" }, "isStackable": { "type": "boolean", "description": "Package Sequence Number" }, "width": { "type": "number", "description": "Width. ≥ -1" }, "length": { "type": "number", "description": "Length. ≥ -1" }, "weightUOM": { "type": "string", "enum": [ "lb" ], "description": "Weight unit of measurement, should always be \"lb\"" }, "lengthUOM": { "type": "string", "enum": [ "in" ], "description": "Length unit of measurement, should always be \"in\"" }, "height": { "type": "number", "description": "Height. ≥ -1" }, "noOfPackages": { "type": "number", "description": "Number of Packages" }, "weight": { "type": "number", "description": "Weight. -1 to 150" }, "volume": { "type": "number", "description": "Weight. -1 to 150" }, "totalMasterCases": { "type": "number" }, "totalUnitsPerMasterCases": { "type": "number" }, "totalUnits": { "type": "number" }, "billingWeight": { "type": "number", "description": "Billing Weight" }, "netCharge": { "type": "number", "description": "Billing Weight" }, "nominalCharge": { "type": "number" }, "assessorialCharge": { "type": "number" }, "serviceCharge": { "type": "number" }, "fedExFreightCharge": { "type": "number" }, "discountCharge": { "type": "number" } }, "required": [ "packageSequenceNumber", "width", "length", "weightUOM", "lengthUOM", "height", "weight" ] }, "description": "List of packages being shipped" }, "quoteType": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ], "description": "List of packages being shipped" }, "quoteId": { "type": "string", "description": "Unique identifier identifying each quote" }, "quoteCreationDate": { "type": "string", "format": "date-time", "description": "Creation date of quote" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } }, "description": "Creation date of quote" }, "originLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] } }, "required": [ "locationName", "address" ] }, "destinationLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] } }, "required": [ "locationName", "address" ] }, "rateQuote": { "type": "object", "properties": { "assessorialCharge": { "type": "number" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "declaredValue": { "type": "string" }, "discountCharge": { "type": "number" }, "effectiveDate": { "type": "string" }, "equipmentTypeCode": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string" }, "expiryDate": { "type": "string" }, "freightCharge": { "type": "number" }, "freightReadyDate": { "type": "string" }, "fuelCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "mixedSKUs": { "type": "number" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "netCharge": { "type": "number" }, "nominalCharge": { "type": "number" }, "numberOfPallets": { "type": "number" }, "quoteId": { "type": "string" }, "sellerFreightClassCode": { "type": "string" }, "serviceCharge": { "type": "number" }, "serviceCode": { "type": "string" }, "singleSKUs": { "type": "number" }, "status": { "type": "string" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "totalWeight": { "type": "number" }, "transitDays": { "type": "string" }, "sp_status": { "type": "string" } } }, "aggregates": { "type": "object", "properties": { "totalCharge": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalDiscount": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalBillingWeight": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalWeight": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "totalVolume": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } } } }, "netCharge": { "type": "number" }, "fedExFreightCharge": { "type": "number" }, "serviceCharge": { "type": "number" }, "quoteStatus": { "type": "string" }, "mpsShipment": { "type": "boolean" }, "estimatedDeliveryDateTime": { "type": "string", "format": "date-time" }, "eligibleForITS": { "type": "boolean" }, "status": { "type": "string", "enum": [ "OK", "ERROR" ] } }, "required": [ "shipmentId", "shipmentPackages", "status" ] }, "WmPreview": { "type": "object", "properties": { "shipNode": { "type": "string" }, "isSortable": { "type": "boolean" }, "isNonSortable": { "type": "boolean" }, "nodeType": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "totalNetTransferCharge": { "type": "number" }, "currencyUnit": { "type": "string" }, "shipmentItems": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] } }, "shippingSummary": { "type": "object", "properties": { "boxes": { "type": "array", "items": {} } }, "required": [ "boxes" ] } }, "required": [ "shipNode", "isSortable", "isNonSortable", "nodeType", "shipToAddress", "totalNetTransferCharge", "currencyUnit", "shipmentItems", "shippingSummary" ] }, "WmPreviewPlan": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "correlationId": { "type": "string" }, "previews": { "type": "array", "items": { "type": "object", "properties": { "previewType": { "type": "string", "enum": [ "inbound", "selfMirroring" ] }, "preview": { "type": "array", "items": { "type": "object", "properties": { "shipNode": { "type": "string" }, "isSortable": { "type": "boolean" }, "isNonSortable": { "type": "boolean" }, "nodeType": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "totalNetTransferCharge": { "type": "number" }, "currencyUnit": { "type": "string" }, "shipmentItems": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] } }, "shippingSummary": { "type": "object", "properties": { "boxes": { "type": "array", "items": {} } }, "required": [ "boxes" ] } }, "required": [ "shipNode", "isSortable", "isNonSortable", "nodeType", "shipToAddress", "totalNetTransferCharge", "currencyUnit", "shipmentItems", "shippingSummary" ] } } }, "required": [ "previewType", "preview" ] } } }, "required": [ "inboundOrderId", "correlationId", "previews" ] }, "WmPreviewType": { "type": "string", "enum": [ "inbound", "selfMirroring" ] }, "WmProductData": { "type": "object", "properties": { "getAnItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the product." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ], "description": "The currency type. Example: USD for US Dollars" }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "required": [ "currency", "amount" ], "description": "Specifies item purchase price information, including currency and amount." }, "publishedStatus": { "type": "string", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM." ], "description": "The status of an item when the item is in the submission process." }, "additionalAttributes": { "type": "object", "properties": { "nameValueAttribute": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "LOCALIZABLE_TEXT", "STRING", "BOOLEAN", "INTEGER", "DECIMAL", "DATE", "TIMESTAMP" ] }, "isVariant": { "type": "boolean" }, "variantResourceType": { "type": "string" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "rank": { "type": "number" }, "isVariant": { "type": "boolean" } }, "required": [ "value" ] } } }, "required": [ "name", "type", "value" ] } } }, "description": "Bag of additional attributes" }, "unpublishedReasons": { "type": "object", "properties": { "reason": { "type": "array", "items": { "type": "string" } } }, "description": "Outlines the reason for an item when unpublished, ie, when 'publishedStatus' is set to 'UNPUBLISHED'." }, "lifecycleStatus": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ], "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle." }, "isDuplicate": { "type": "boolean", "description": "This will be included by default irrespective of the query parameter set for show duplicate's info or not" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates if the item is a customer favorite. Included only if includeCustomerFavoriteStatus is set to true." }, "duplicateItemdetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Current Status of the item" }, "lastUpdatedDate": { "type": "string", "description": "Date when an action was taken on the item" }, "identifiedDate": { "type": "string", "description": "Date when the item was identified duplicate" }, "destinationItem": { "type": "object", "properties": { "mart": { "type": "string", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ], "description": "The marketplace name." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "itemId": { "type": "string", "description": "The Item ID assigned by Walmart" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "additionalAttributes": { "type": "array", "items": { "type": "string" }, "description": "List all product attributes of the destination item" } }, "description": "Duplicate item found for the given item" } }, "description": "Duplicate item details" } } }, "getSearchResult": { "type": "object", "properties": { "itemId": { "type": "string" }, "condition": { "type": "string" }, "isMarketPlaceItem": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } }, "customerRating": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] }, "description": { "type": "string" }, "title": { "type": "string" }, "brand": { "type": "string" }, "productType": { "type": "string" }, "properties": { "type": "object", "properties": { "variant_items_num": { "type": "string" }, "num_reviews": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "object", "properties": { "variantMeta": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "variantData": { "type": "array", "items": { "type": "object", "properties": { "productImageUrl": { "type": "string" }, "itemId": { "type": "string" }, "isAvailable": { "type": "string" }, "title": { "type": "string" }, "variantValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "required": [ "variantData" ] }, "next_day_eligible": { "type": "boolean" } } }, "parent": { "type": "object", "properties": { "itemId": { "type": "object" }, "images": { "type": "object" }, "title": { "type": "object" } }, "required": [ "itemId", "images", "title" ] } } } } }, "WmReport": { "type": "object", "properties": { "requestId": { "type": "string", "description": "System-generated ID that uniquely identifies the report request." }, "requestStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ], "description": "Filters report requests by status." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated. Example: ITEM for Item Report." }, "reportVersion": { "type": "string", "description": "Version of report for which the request is created. Example, v1." } } }, "WmReportFrequency": { "type": "string", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "WmReportSchedule": { "type": "object", "properties": { "scheduleId": { "type": "string", "description": "Unique identifier for the schedule." }, "requestSubmissionDate": { "type": "string", "format": "date-time", "description": "The timestamp (date and time) indicating when the report request was submitted." }, "reportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated." }, "reportVersion": { "type": "string", "description": "Specifies the version of report for which the request is created. Example: v1." }, "reportSummary": { "type": "string", "description": "Provides a brief summary of the report." }, "scheduleStartDate": { "type": "string", "description": "Specifies the start date for the schedule. The date should be in a valid date format (Example: YYYY-MM-DD)." }, "nextScheduledTime": { "type": "string", "description": "The next scheduled time for the report." }, "payload": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ], "description": "Specifies the frequency at which the report should be generated. For example, if set to YEARLY, the report will be generated once every year." }, "repeatsEvery": { "type": "number", "description": "Defines the interval at which the report repeats based on the selected frequency." }, "hour": { "type": "number", "description": "Specifies the hour of the day at which the schedule will be triggered. Allowed values are from 0 to 23, where 0 corresponds to 12:00 AM UTC and 23 corresponds to 11:00 PM UTC. The hour selection is based on the UTC timezone." }, "dayOfMonth": { "type": "number", "description": "Specifies the day of the month on which the schedule will be triggered." }, "dayOfWeek": { "type": "number", "description": "Specifies the day of the week on which the schedule will be triggered. Allowed values are from 0 to 6, where 0 represents Monday and 6 represents Sunday." }, "monthOfYear": { "type": "number", "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." }, "filters": { "type": "object", "properties": { "email": { "type": "string" }, "rowFilters": { "type": "object", "properties": { "type": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } }, "columnName": { "type": "string" } }, "required": [ "type", "values", "columnName" ] } }, "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." } }, "description": "The next scheduled time for the report." }, "requestModifiedTime": { "type": "string", "description": "The date and time when the report schedule was last modified." } }, "required": [ "scheduleId", "requestSubmissionDate", "reportType", "reportVersion", "payload" ] }, "WmReportSchedulePayload": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ], "description": "Specifies the frequency at which the report should be generated. For example, if set to YEARLY, the report will be generated once every year." }, "repeatsEvery": { "type": "number", "description": "Defines the interval at which the report repeats based on the selected frequency." }, "hour": { "type": "number", "description": "Specifies the hour of the day at which the schedule will be triggered. Allowed values are from 0 to 23, where 0 corresponds to 12:00 AM UTC and 23 corresponds to 11:00 PM UTC. The hour selection is based on the UTC timezone." }, "dayOfMonth": { "type": "number", "description": "Specifies the day of the month on which the schedule will be triggered." }, "dayOfWeek": { "type": "number", "description": "Specifies the day of the week on which the schedule will be triggered. Allowed values are from 0 to 6, where 0 represents Monday and 6 represents Sunday." }, "monthOfYear": { "type": "number", "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." }, "filters": { "type": "object", "properties": { "email": { "type": "string" }, "rowFilters": { "type": "object", "properties": { "type": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } }, "columnName": { "type": "string" } }, "required": [ "type", "values", "columnName" ] } }, "description": "Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12." } } }, "WmReportSource": { "type": "string", "enum": [ "SC", "API", "Scheduler" ] }, "WmReportType": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] }, "WmRequestStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ] }, "WmShipment": { "type": "object", "properties": { "shipment_id": { "type": "string" }, "user_id": { "type": "string" }, "plan_id": { "type": [ "number", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": "number" }, "status": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "synced": { "type": [ "string", "null" ], "format": "date-time" }, "ship_to_address": { "type": [ "object", "null" ], "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "shipment_items": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] } }, "shipment_units": { "type": [ "number", "null" ] }, "received_units": { "type": [ "number", "null" ] }, "items_submitted": { "type": [ "number", "null" ] }, "received_units_at_fc": { "type": [ "number", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "updated_expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "actual_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "tracking_no": { "type": [ "array", "null" ], "items": { "type": "string" } }, "carrier_name": { "type": [ "string", "null" ] }, "channel_method": { "type": [ "string", "null" ] }, "ship_node": { "type": [ "string", "null" ] }, "shipment_type": { "type": [ "string", "null" ] }, "po_type": { "type": [ "string", "null" ] }, "shipment_carrier_type": { "type": [ "string", "null" ] }, "is_exception_occurred": { "type": [ "boolean", "null" ] }, "exception_status": { "type": [ "string", "null" ] }, "is_po_box_enabled": { "type": [ "boolean", "null" ] }, "transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "consolidated_transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "receipt_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "receipt_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "anyOf": [ {}, { "type": "null" } ] }, "carrier_rate_quotes": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "assessorialCharge": { "type": "number" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "declaredValue": { "type": "string" }, "discountCharge": { "type": "number" }, "effectiveDate": { "type": "string" }, "equipmentTypeCode": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string" }, "expiryDate": { "type": "string" }, "freightCharge": { "type": "number" }, "freightReadyDate": { "type": "string" }, "fuelCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "mixedSKUs": { "type": "number" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "netCharge": { "type": "number" }, "nominalCharge": { "type": "number" }, "numberOfPallets": { "type": "number" }, "quoteId": { "type": "string" }, "sellerFreightClassCode": { "type": "string" }, "serviceCharge": { "type": "number" }, "serviceCode": { "type": "string" }, "singleSKUs": { "type": "number" }, "status": { "type": "string" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "totalWeight": { "type": "number" }, "transitDays": { "type": "string" }, "sp_status": { "type": "string" } } } }, "inbound_order_id": { "type": "string" }, "single_sku_box_count": { "type": [ "number", "null" ] }, "mixed_sku_box_count": { "type": [ "number", "null" ] }, "user_shipment_carrier_type": { "type": [ "string", "null" ], "description": "The user-provided non/partnered SPT/LTL/FTL status" }, "preferred_pickup_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The user-provided non/partnered SPT/LTL/FTL status" }, "freight_class": { "type": [ "number", "null" ] }, "declared_value": { "type": [ "number", "null" ] }, "pickup_instructions": { "type": [ "string", "null" ] }, "pickup_seller_schedule": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "shipment_id", "user_id", "plan_id", "marketplace_id", "ship_from_id", "status", "created", "created_by", "creation_source", "updated", "updated_by", "archived", "archived_by", "deleted", "deleted_by", "synced", "ship_to_address", "shipment_items", "shipment_units", "received_units", "items_submitted", "received_units_at_fc", "expected_delivery_date", "updated_expected_delivery_date", "actual_delivery_date", "tracking_no", "carrier_name", "channel_method", "ship_node", "shipment_type", "po_type", "shipment_carrier_type", "is_exception_occurred", "exception_status", "is_po_box_enabled", "transfer_shipments", "consolidated_transfer_shipments", "receipt_start_date", "receipt_end_date", "data", "carrier_rate_quotes", "inbound_order_id", "single_sku_box_count", "mixed_sku_box_count", "user_shipment_carrier_type", "preferred_pickup_date", "freight_class", "declared_value", "pickup_instructions", "pickup_seller_schedule" ] }, "WmShipmentCarrierRateQuotes": { "type": "array", "items": { "type": "object", "properties": { "assessorialCharge": { "type": "number" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "declaredValue": { "type": "string" }, "discountCharge": { "type": "number" }, "effectiveDate": { "type": "string" }, "equipmentTypeCode": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string" }, "expiryDate": { "type": "string" }, "freightCharge": { "type": "number" }, "freightReadyDate": { "type": "string" }, "fuelCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "mixedSKUs": { "type": "number" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "netCharge": { "type": "number" }, "nominalCharge": { "type": "number" }, "numberOfPallets": { "type": "number" }, "quoteId": { "type": "string" }, "sellerFreightClassCode": { "type": "string" }, "serviceCharge": { "type": "number" }, "serviceCode": { "type": "string" }, "singleSKUs": { "type": "number" }, "status": { "type": "string" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "totalWeight": { "type": "number" }, "transitDays": { "type": "string" }, "sp_status": { "type": "string" } } } }, "WmShipmentConsolidatedTransferShipments": { "type": "array", "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "WmShipmentItem": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] }, "WmShipmentItems": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" } }, "required": [ "vendorSku", "productType", "productId", "itemQty", "itemDesc", "itemPrice", "shpmentLineNo" ] } }, "WmShipmentItemWithImages": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" }, "images": { "type": "array", "items": { "type": "string" } } } }, "WmShipmentPackage": { "type": "object", "properties": { "packageSequenceNumber": { "type": "number", "description": "Package Sequence Number" }, "weight": { "type": "number", "description": "Weight. -1 to 150" }, "weightUOM": { "type": "string", "enum": [ "lb" ], "description": "Weight unit of measurement, should always be \"lb\"" }, "length": { "type": "number", "description": "Length. ≥ -1" }, "height": { "type": "number", "description": "Length. ≥ -1" }, "width": { "type": "number" }, "lengthUOM": { "type": "string", "enum": [ "in" ], "description": "Length unit of measurement, should always be \"in\"" }, "packageType": { "type": "string", "enum": [ "SINGLE SKUS", "MIXED SKUS", "PALLET" ], "description": "Length unit of measurement, should always be \"in\"" }, "isStackable": { "type": "boolean", "description": "Only for LTL / FTL" }, "noOfPackages": { "type": "number", "description": "Only for FTL" } }, "required": [ "packageSequenceNumber", "weight", "weightUOM", "length", "height", "width", "lengthUOM" ] }, "WmShipmentSummary": { "type": "object", "properties": { "boxes": { "type": "array", "items": {} } }, "required": [ "boxes" ] }, "WmShipmentTransferShipments": { "type": "array", "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "WmShipmentWithImages": { "type": "object", "properties": { "shipment_id": { "type": "string" }, "user_id": { "type": "string" }, "plan_id": { "type": [ "number", "null" ] }, "marketplace_id": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "ship_from_id": { "type": "number" }, "status": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "updated": { "type": [ "string", "null" ], "format": "date-time" }, "updated_by": { "type": [ "string", "null" ] }, "archived": { "type": [ "string", "null" ], "format": "date-time" }, "archived_by": { "type": [ "string", "null" ] }, "deleted": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_by": { "type": [ "string", "null" ] }, "synced": { "type": [ "string", "null" ], "format": "date-time" }, "ship_to_address": { "type": [ "object", "null" ], "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "shipment_units": { "type": [ "number", "null" ] }, "received_units": { "type": [ "number", "null" ] }, "items_submitted": { "type": [ "number", "null" ] }, "received_units_at_fc": { "type": [ "number", "null" ] }, "expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "updated_expected_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "actual_delivery_date": { "type": [ "string", "null" ], "format": "date-time" }, "tracking_no": { "type": [ "array", "null" ], "items": { "type": "string" } }, "carrier_name": { "type": [ "string", "null" ] }, "channel_method": { "type": [ "string", "null" ] }, "ship_node": { "type": [ "string", "null" ] }, "shipment_type": { "type": [ "string", "null" ] }, "po_type": { "type": [ "string", "null" ] }, "shipment_carrier_type": { "type": [ "string", "null" ] }, "is_exception_occurred": { "type": [ "boolean", "null" ] }, "exception_status": { "type": [ "string", "null" ] }, "is_po_box_enabled": { "type": [ "boolean", "null" ] }, "transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "consolidated_transfer_shipments": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "returnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "addressLine1", "city", "stateCode", "postalCode", "countryCode" ] }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "number" }, "receivedUnits": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "latestMilestone": { "type": "string" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "shipmentType": { "type": "string", "description": "The following are not mentioned in the WM docs, but are returned from the getInboundShipments API" }, "itemsSubmitted": { "type": "number" }, "receivedUnitsAtFC": { "type": "number" }, "poType": { "type": "string" }, "shipmentCarrierType": { "type": "string" }, "isExceptionOccurred": { "type": "boolean" }, "isPOBoxEnabled": { "type": "boolean" }, "channelMethod": { "type": "string" }, "shipNode": { "type": "string" }, "shipmentItems": { "type": "array", "items": {} } }, "required": [ "inboundOrderId", "shipmentId", "shipToAddress", "returnAddress", "status", "createdDate", "shipmentUnits", "receivedUnits", "expectedDeliveryDate", "updatedExpectedDeliveryDate", "latestMilestone", "actualDeliveryDate", "trackingNo", "carrierName", "shipmentType", "itemsSubmitted", "receivedUnitsAtFC", "poType", "shipmentCarrierType", "isExceptionOccurred", "isPOBoxEnabled", "channelMethod", "shipNode", "shipmentItems" ] } }, "receipt_start_date": { "type": [ "string", "null" ], "format": "date-time" }, "receipt_end_date": { "type": [ "string", "null" ], "format": "date-time" }, "data": { "anyOf": [ {}, { "type": "null" } ] }, "carrier_rate_quotes": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "assessorialCharge": { "type": "number" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "declaredValue": { "type": "string" }, "discountCharge": { "type": "number" }, "effectiveDate": { "type": "string" }, "equipmentTypeCode": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string" }, "expiryDate": { "type": "string" }, "freightCharge": { "type": "number" }, "freightReadyDate": { "type": "string" }, "fuelCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "mixedSKUs": { "type": "number" }, "mode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "netCharge": { "type": "number" }, "nominalCharge": { "type": "number" }, "numberOfPallets": { "type": "number" }, "quoteId": { "type": "string" }, "sellerFreightClassCode": { "type": "string" }, "serviceCharge": { "type": "number" }, "serviceCode": { "type": "string" }, "singleSKUs": { "type": "number" }, "status": { "type": "string" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "totalWeight": { "type": "number" }, "transitDays": { "type": "string" }, "sp_status": { "type": "string" } } } }, "inbound_order_id": { "type": "string" }, "single_sku_box_count": { "type": [ "number", "null" ] }, "mixed_sku_box_count": { "type": [ "number", "null" ] }, "user_shipment_carrier_type": { "type": [ "string", "null" ], "description": "The user-provided non/partnered SPT/LTL/FTL status" }, "preferred_pickup_date": { "type": [ "string", "null" ], "format": "date-time", "description": "The user-provided non/partnered SPT/LTL/FTL status" }, "freight_class": { "type": [ "number", "null" ] }, "declared_value": { "type": [ "number", "null" ] }, "pickup_instructions": { "type": [ "string", "null" ] }, "pickup_seller_schedule": { "anyOf": [ {}, { "type": "null" } ] }, "shipment_items": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "number" }, "itemDesc": { "type": "string" }, "itemPrice": { "type": "number" }, "shpmentLineNo": { "type": "number" }, "images": { "type": "array", "items": { "type": "string" } } } } } }, "required": [ "shipment_items" ] }, "WmShippingMode": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "WmShipToAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "fcName": { "type": "string" } }, "required": [ "fcName" ] }, "WmSubscriptionEvent": { "type": "object", "properties": { "eventType": { "type": "string", "description": "Event type for which the subscription was created." }, "subscriptionId": { "type": "string", "description": "Unique identifier for the subscription that you can use to fetch details, edit, or delete the subscription." }, "partnerId": { "type": "string", "description": "Partner ID of the seller who created the subscription." }, "eventVersion": { "type": "string", "description": "Version of the event type for which the subscription was created." }, "resourceName": { "type": "string", "description": "Resource or functional category that the event type is mapped to (for example, ITEM, ORDER, PRICE)." }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ], "description": "Current state of the subscription." }, "eventUrl": { "type": "string", "description": "Destination URL where notifications for this subscription will be delivered." }, "authDetails": { "type": "object", "properties": { "authMethod": { "type": "string", "enum": [ "BASIC_AUTH", "OAUTH", "HMAC" ], "description": "Authentication method for the destination URL." }, "userName": { "type": "string", "description": "Username used to access the destination URL (required for BASIC_AUTH)." }, "password": { "type": "string", "description": "Password used to access the destination URL (required for BASIC_AUTH)." }, "authHeaderName": { "type": "string", "description": "Header name used to pass the authorization value to the destination URL (for example, Authorization)." }, "authUrl": { "type": "string", "description": "OAuth server or token URL used when the authentication method is OAUTH." }, "clientSecret": { "type": "string", "description": "Client secret used with the OAuth server (OAUTH) or as key material for HMAC." }, "clientId": { "type": "string", "description": "Client ID used with the OAuth server when the authentication method is OAUTH." } }, "required": [ "authMethod", "userName", "password", "authHeaderName", "authUrl", "clientSecret", "clientId" ], "description": "Destination URL where notifications for this subscription will be delivered." }, "headers": { "type": "object", "properties": { "content-type": { "type": "string" } }, "required": [ "content-type" ], "description": "Headers required for accessing the destination URL." } }, "required": [ "eventType", "subscriptionId", "partnerId", "eventVersion", "resourceName", "status", "eventUrl", "authDetails", "headers" ] }, "WmUnitAddress": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string" }, "phone": { "type": "string" }, "locationName": { "type": "string" }, "locationType": { "type": "string", "description": "Length between 0 and 15" } }, "required": [ "state", "countryCode" ] }, "WmUom": { "type": "object", "properties": { "unitOfMeasure": { "type": "string" }, "measurementValue": { "type": "number" } } }, "WrappedParams": { "type": "object", "properties": { "plan_id": { "type": "string" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "Invalid request parameters" ] }, "code": { "type": "string", "examples": [ "400" ] } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "Unauthorized" ] }, "code": { "type": "string", "examples": [ "401" ] } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "Access denied" ] }, "code": { "type": "string", "examples": [ "403" ] } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "Resource not found" ] }, "code": { "type": "string", "examples": [ "404" ] } } } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "Resource already exists" ] }, "code": { "type": "string", "examples": [ "409" ] } } } } } } } } }, "418": { "description": "I'm a teapot", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "I'm a teapot" ] }, "code": { "type": "string", "examples": [ "418" ] } } } } } } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "Too Many Requests" ] }, "code": { "type": "string", "examples": [ "429" ] } } } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string", "examples": [ "An unexpected error occurred" ] }, "code": { "type": "string", "examples": [ "500" ] } } } } } } } } } } }, "tags": [ { "name": "Audit" }, { "name": "Auth" }, { "name": "Bundle" }, { "name": "Dashboard" }, { "name": "Feed" }, { "name": "Inventory" }, { "name": "Label" }, { "name": "Location" }, { "name": "ItemLocation", "x-displayName": "Items at Location" }, { "name": "Mapping" }, { "name": "Manage Team" }, { "name": "Plan" }, { "name": "Purchase Order" }, { "name": "Attachment" }, { "name": "Report" }, { "name": "Ship From" }, { "name": "Supplier" }, { "name": "Tag" }, { "name": "WebHook" }, { "name": "Amazon Shipment" }, { "name": "Walmart Shipment" }, { "name": "Amazon", "description": "Wrappers around Amazon APIs" }, { "name": "Amazon/catalogItems_2022-04-01", "x-displayName": "Catalog Items" }, { "name": "Amazon/definitionsProductTypes_2020-09-01", "x-displayName": "Definitions Product Types" }, { "name": "Amazon/fbaInbound", "x-displayName": "FBA Inbound" }, { "name": "Amazon/fbaInventory", "x-displayName": "FBA Inventory" }, { "name": "Amazon/fulfillmentInbound_2024-03-20", "x-displayName": "Fulfillment Inbound" }, { "name": "Amazon/fulfillmentInboundV0", "x-displayName": "Fulfillment Inbound V0" }, { "name": "Amazon/listingsItems_2021-08-01", "x-displayName": "Listings Items" }, { "name": "Amazon/listingsRestrictions_2021-08-01", "x-displayName": "Listings Restrictions" }, { "name": "Amazon/notifications", "x-displayName": "Notifications" }, { "name": "Amazon/orders_2026-01-01", "x-displayName": "Orders" }, { "name": "Amazon/productFeesV0", "x-displayName": "Product Fees" }, { "name": "Amazon/productPricing_2022-05-01", "x-displayName": "Product Pricing" }, { "name": "Amazon/reports_2021-06-30", "x-displayName": "Reports" }, { "name": "Walmart", "description": "Wrappers around Walmart APIs" }, { "name": "Walmart/Auth", "description": "Token generation and validation", "x-displayName": "Auth" }, { "name": "Walmart/Feed", "x-displayName": "Feed" }, { "name": "Walmart/Inventory", "x-displayName": "Inventory" }, { "name": "Walmart/Item", "x-displayName": "Item" }, { "name": "Walmart/Notification", "x-displayName": "Notification" }, { "name": "Walmart/Price", "x-displayName": "Price" }, { "name": "Walmart/Report", "x-displayName": "Report" }, { "name": "Walmart/Shipment", "x-displayName": "Shipment" }, { "name": "3PL Billing" }, { "name": "Integration" }, { "name": "Pack Template" }, { "name": "Seller" }, { "name": "Settings" }, { "name": "Shipment" }, { "name": "V3" } ], "x-tagGroups": [ { "name": "ScanPower", "tags": [ "Attachment", "Audit", "Auth", "Bundle", "Dashboard", "Feed", "Integration", "Inventory", "ItemLocation", "Label", "Location", "Mapping", "Manage Team", "Pack Template", "Plan", "Purchase Order", "Report", "Settings", "Ship From", "Supplier", "Tag", "WebHook", "Amazon Shipment", "Walmart Shipment" ] }, { "name": "Amazon", "tags": [ "Amazon/catalogItems_2022-04-01", "Amazon/definitionsProductTypes_2020-09-01", "Amazon/fbaInbound", "Amazon/fbaInventory", "Amazon/fulfillmentInbound_2024-03-20", "Amazon/fulfillmentInboundV0", "Amazon/listingsItems_2021-08-01", "Amazon/listingsRestrictions_2021-08-01", "Amazon/notifications", "Amazon/orders_2026-01-01", "Amazon/productFeesV0", "Amazon/productPricing_2022-05-01", "Amazon/reports_2021-06-30" ] }, { "name": "Walmart", "tags": [ "Walmart/Auth", "Walmart/Feed", "Walmart/Inventory", "Walmart/Item", "Walmart/Notification", "Walmart/Price", "Walmart/Report", "Walmart/Shipment" ] } ], "paths": { "/v3/3pl-billing": { "get": { "operationId": "get-v3-3pl-billing", "summary": "selectThreePlBilling", "description": "", "tags": [ "3PL Billing" ], "parameters": [ { "in": "query", "name": "query_type", "required": false, "schema": { "type": "string", "enum": [ "new", "legacy" ] }, "example": "new" }, { "in": "query", "name": "region", "required": false, "schema": { "oneOf": [ { "type": "string", "enum": [ "east", "west", "uk" ] }, { "type": "string", "enum": [ "all" ] } ] }, "example": "example" }, { "in": "query", "name": "user_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "user_email", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "ship_from_id", "required": false, "schema": { "type": "number" }, "example": 123 }, { "in": "query", "name": "client_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "client_email", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "channel", "required": false, "schema": { "type": "string", "enum": [ "az", "wm" ] }, "example": "az" }, { "in": "query", "name": "start", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "end", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "number" }, "example": 1 } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectThreePlBillingResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az-box": { "get": { "operationId": "get-v3-az-box", "summary": "selectAzBoxes", "description": "List shipment boxes", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "box_ids", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "inbound_plan_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "packing_group_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "plan_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "shipment_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "with_items", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "only_with_items", "required": false, "schema": { "type": "boolean" }, "example": true } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectAzBoxesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-box", "summary": "insertAzBoxes", "description": "Create one or more shipment boxes", "tags": [ "Amazon Shipment" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertAzBoxesParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertAzBoxesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az-pallet": { "get": { "operationId": "get-v3-az-pallet", "summary": "selectAzPallets", "description": "List Amazon shipment pallets", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "shipment_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "inbound_plan_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "pallet_ids", "required": false, "schema": { "type": "array", "items": { "type": "number" } }, "example": "example" }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean" }, "example": true } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectAzPalletsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-pallet", "summary": "insertAzPallets", "description": "Create one or more Amazon shipment pallets", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "pallets", "required": true, "schema": { "type": "array", "items": { "type": "object", "properties": { "shipment_id": { "type": [ "string", "null" ] }, "plan_id": { "type": [ "string", "null" ] }, "index": { "type": "number" }, "quantity": { "type": "number" }, "stackability": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ] }, "inbound_plan_id": { "type": "string" }, "placement_option_id": { "type": [ "string", "null" ] }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "unit_of_measurement": { "type": "string", "enum": [ "CM", "IN" ] }, "weight": { "type": "number" }, "unit_of_weight": { "type": "string", "enum": [ "KG", "LB" ] }, "creation_source": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] } } } }, "example": "example" }, { "in": "query", "name": "shipment_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "placement_option_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "creation_source", "required": false, "schema": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "example": "api" }, { "in": "query", "name": "unit_of_measurement", "required": false, "schema": { "type": "string", "enum": [ "CM", "IN" ] }, "example": "CM" }, { "in": "query", "name": "unit_of_weight", "required": false, "schema": { "type": "string", "enum": [ "KG", "LB" ] }, "example": "KG" }, { "in": "query", "name": "stackability", "required": false, "schema": { "type": "string", "enum": [ "NON_STACKABLE", "STACKABLE" ] }, "example": "NON_STACKABLE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertAzPalletsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-az-pallet", "summary": "updateAzPallets", "description": "Update one or more Amazon shipment pallets", "tags": [ "Amazon Shipment" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAzPalletsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAzPalletsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-az-pallet", "summary": "deleteAzPallets", "description": "Delete the specified Amazon shipment pallets", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "shipment_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "pallet_ids", "required": true, "schema": { "type": "array", "items": { "type": "number" } }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAzPalletsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az-shipment": { "get": { "operationId": "get-v3-az-shipment", "summary": "selectAzShipments", "description": "List Amazon shipments", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "shipment_ids", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "shipment_confirmation_ids", "required": false, "schema": { "type": "array", "items": { "type": [ "string", "null" ] } }, "example": "example" }, { "in": "query", "name": "plan_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "inbound_plan_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "ship_from_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "statuses", "required": false, "schema": { "type": "array", "items": { "type": [ "string", "null" ], "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "UNCONFIRMED", "WORKING" ] } }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean" }, "example": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectAzShipmentsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/inbound-plan": { "get": { "operationId": "get-v3-inbound-plan", "summary": "selectInboundPlans", "description": "List inbound plans", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "inboundPlanId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "plan_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "statuses", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACTIVE", "ERRORED", "SHIPPED", "VOIDED" ] } }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectInboundPlansResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az-box/{box_id}": { "patch": { "operationId": "patch-v3-az-box-{box_id}", "summary": "updateAzBoxes", "description": "Update a shipment box by ID", "tags": [ "Amazon Shipment" ], "parameters": [ { "name": "box_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: box_id" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAzBoxesBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAzBoxesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-az-box-{box_id}", "summary": "deleteAzBoxes", "description": "Delete shipment boxes by ID", "tags": [ "Amazon Shipment" ], "parameters": [ { "name": "box_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: box_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAzBoxesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az-box/items": { "get": { "operationId": "get-v3-az-box-items", "summary": "selectAzBoxItems", "description": "List items assigned to shipment boxes", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "plan_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "box_id", "required": false, "schema": { "type": "number" }, "example": 123 }, { "in": "query", "name": "box_item_ids", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectAzBoxItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-box-items", "summary": "selectAzBoxItemsPost", "description": "List shipment box items", "tags": [ "Amazon Shipment" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectAzBoxItemsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectAzBoxItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-az-box-items", "summary": "mergeAzBoxItems", "description": "Merge items into shipment boxes", "tags": [ "Amazon Shipment" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeAzBoxItemsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeAzBoxItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az-pallet/{pallet_id}": { "get": { "operationId": "get-v3-az-pallet-{pallet_id}", "summary": "selectAzPallet", "description": "Get an Amazon shipment pallet by ID", "tags": [ "Amazon Shipment" ], "parameters": [ { "name": "pallet_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: pallet_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectAzPalletResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-az-pallet-{pallet_id}", "summary": "deleteAzPallets", "description": "Delete an Amazon shipment pallet by ID", "tags": [ "Amazon Shipment" ], "parameters": [ { "name": "pallet_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: pallet_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAzPalletsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az-shipment/{shipment_id}": { "patch": { "operationId": "patch-v3-az-shipment-{shipment_id}", "summary": "updateAzShipment", "description": "Update an Amazon shipment by ID", "tags": [ "Amazon Shipment" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpateAzShipmentBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAzShipmentResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/inbound-plan/import": { "get": { "operationId": "get-v3-inbound-plan-import", "summary": "listInboundPlansToImport", "description": "List inbound plans that exist in Amazon but haven't been imported into ScanPower", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "status", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "SHIPPED" ] }, { "type": "string", "enum": [ "VOIDED" ] } ] }, "example": "example" }, { "in": "query", "name": "sortBy", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "LAST_UPDATED_TIME" ] }, { "type": "string", "enum": [ "CREATION_TIME" ] } ] }, "example": "example" }, { "in": "query", "name": "sortOrder", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ASC" ] }, { "type": "string", "enum": [ "DESC" ] } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInboundPlansToImportResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-inbound-plan-import", "summary": "importInboundPlan", "description": "Import an inbound plan from Amazon", "tags": [ "Amazon Shipment" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportInboundPlanParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportInboundPlanResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/inbound-plan/{inboundPlanId}/delivery-window-option": { "get": { "operationId": "get-v3-inbound-plan-{inboundPlanId}-delivery-window-option", "summary": "selectDeliveryWindowOptions", "description": "List delivery window options for an inbound plan", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "inboundPlanId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "deliveryWindowOptionId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "force", "required": false, "schema": { "type": "boolean", "description": "pass `true` to force loading data from SP-API" }, "description": "pass `true` to force loading data from SP-API", "example": true }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "shipmentId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectDeliveryWindowOptionsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/inbound-plan/{inboundPlanId}/packing-option": { "get": { "operationId": "get-v3-inbound-plan-{inboundPlanId}-packing-option", "summary": "selectPackingOptions", "description": "List packing options for an inbound plan", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "inboundPlanId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "packingOptionId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "statuses", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] } }, "example": "example" }, { "in": "query", "name": "expired", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "force", "required": false, "schema": { "type": "boolean", "description": "pass `true` to force loading data from SP-API" }, "description": "pass `true` to force loading data from SP-API", "example": true }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPackingOptionsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/inbound-plan/{inboundPlanId}/placement-option": { "get": { "operationId": "get-v3-inbound-plan-{inboundPlanId}-placement-option", "summary": "selectPlacementOptions", "description": "List placement options for an inbound plan", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "inboundPlanId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "placementOptionId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "statuses", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "EXPIRED", "OFFERED" ] } }, "example": "example" }, { "in": "query", "name": "expired", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "force", "required": false, "schema": { "type": "boolean", "description": "pass `true` to force loading data from SP-API" }, "description": "pass `true` to force loading data from SP-API", "example": true }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPlacementOptionsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/inbound-plan/{inboundPlanId}/transportation-option": { "get": { "operationId": "get-v3-inbound-plan-{inboundPlanId}-transportation-option", "summary": "selectTransportationOptions", "description": "List transportation options for an inbound plan", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "query", "name": "inboundPlanId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "transportationOptionIds", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "placementOptionId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "shipmentId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "statuses", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "OFFERED" ] } }, "example": "example" }, { "in": "query", "name": "force", "required": false, "schema": { "type": "boolean", "description": "pass `true` to force loading data from SP-API" }, "description": "pass `true` to force loading data from SP-API", "example": true }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPackingOptionsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/plan/{plan_id}/submit-boxes": { "get": { "operationId": "get-v3-plan-{plan_id}-submit-boxes", "summary": "submitAzBoxes", "description": "Submit a plan's boxes for processing", "tags": [ "Amazon Shipment" ], "parameters": [ { "in": "path", "name": "plan_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitAzBoxesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/catalog/2022-04-01/items": { "get": { "operationId": "get-v3-az-catalog-2022-04-01-items", "summary": "searchCatalogItems", "description": "Thin wrapper around Amazon's [searchCatalogItems](https://developer-docs.amazon/sp-api/reference/searchcatalogitems) API", "tags": [ "Amazon/catalogItems_2022-04-01" ], "parameters": [ { "in": "query", "name": "identifiers", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "example": "example" }, { "in": "query", "name": "identifiersType", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ASIN" ] }, { "type": "string", "enum": [ "EAN" ] }, { "type": "string", "enum": [ "GTIN" ] }, { "type": "string", "enum": [ "ISBN" ] }, { "type": "string", "enum": [ "JAN" ] }, { "type": "string", "enum": [ "MINSAN" ] }, { "type": "string", "enum": [ "SKU" ] }, { "type": "string", "enum": [ "UPC" ] } ] }, "example": "example" }, { "in": "query", "name": "locale", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "sellerId", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": 123 }, { "in": "query", "name": "keywords", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "brandNames", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "classificationIds", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "pageToken", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "keywordsLocale", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "marketplaceIds", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "includedData", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "images", "attributes", "classifications", "dimensions", "identifiers", "productTypes", "relationships", "salesRanks", "summaries", "vendorDetails" ] } } ] }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCatalogItemsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCatalogItemsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/catalog/2022-04-01/items/{asin}": { "get": { "operationId": "get-v3-az-catalog-2022-04-01-items-{asin}", "summary": "getCatalogItem", "description": "Thin wrapper around Amazon's [getCatalogItem](https://developer-docs.amazon/sp-api/reference/getcatalogitem) API", "tags": [ "Amazon/catalogItems_2022-04-01" ], "parameters": [ { "in": "query", "name": "marketplaceIds", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "includedData", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "images", "attributes", "classifications", "dimensions", "identifiers", "productTypes", "relationships", "salesRanks", "summaries", "vendorDetails" ] } } ] }, "example": "example" }, { "in": "query", "name": "locale", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "asin", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: asin" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetCatalogItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetCatalogItemErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/definitions/2020-09-01/productTypes": { "get": { "operationId": "get-v3-az-definitions-2020-09-01-productTypes", "summary": "searchDefinitionsProductTypes", "description": "Thin wrapper around Amazon's [searchDefinitionsProductTypes](https://developer-docs.amazon/sp-api/reference/searchdefinitionsproducttypes) API", "tags": [ "Amazon/definitionsProductTypes_2020-09-01" ], "parameters": [ { "in": "query", "name": "keywords", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "example": "example" }, { "in": "query", "name": "marketplaceIds", "required": true, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "itemName", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "locale", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "searchLocale", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSearchDefinitionsProductTypesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSearchDefinitionsProductTypesErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/definitions/2020-09-01/productTypes/{productType}": { "get": { "operationId": "get-v3-az-definitions-2020-09-01-productTypes-{productType}", "summary": "getDefinitionsProductType", "description": "Thin wrapper around Amazon's [getDefinitionsProductType](https://developer-docs.amazon/sp-api/reference/getdefinitionsproducttype) API", "tags": [ "Amazon/definitionsProductTypes_2020-09-01" ], "parameters": [ { "in": "query", "name": "sellerId", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "123" }, { "in": "query", "name": "marketplaceIds", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "productTypeVersion", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "requirements", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "LISTING" ] }, { "type": "string", "enum": [ "LISTING_PRODUCT_ONLY" ] }, { "type": "string", "enum": [ "LISTING_OFFER_ONLY" ] } ] }, "example": "example" }, { "in": "query", "name": "requirementsEnforced", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ENFORCED" ] }, { "type": "string", "enum": [ "NOT_ENFORCED" ] } ] }, "example": "example" }, { "in": "query", "name": "locale", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "DEFAULT" ] }, { "type": "string", "enum": [ "ar" ] }, { "type": "string", "enum": [ "ar_AE" ] }, { "type": "string", "enum": [ "de" ] }, { "type": "string", "enum": [ "de_DE" ] }, { "type": "string", "enum": [ "en" ] }, { "type": "string", "enum": [ "en_AE" ] }, { "type": "string", "enum": [ "en_AU" ] }, { "type": "string", "enum": [ "en_CA" ] }, { "type": "string", "enum": [ "en_GB" ] }, { "type": "string", "enum": [ "en_IN" ] }, { "type": "string", "enum": [ "en_SG" ] }, { "type": "string", "enum": [ "en_US" ] }, { "type": "string", "enum": [ "es" ] }, { "type": "string", "enum": [ "es_ES" ] }, { "type": "string", "enum": [ "es_MX" ] }, { "type": "string", "enum": [ "es_US" ] }, { "type": "string", "enum": [ "fr" ] }, { "type": "string", "enum": [ "fr_CA" ] }, { "type": "string", "enum": [ "fr_FR" ] }, { "type": "string", "enum": [ "it" ] }, { "type": "string", "enum": [ "it_IT" ] }, { "type": "string", "enum": [ "ja" ] }, { "type": "string", "enum": [ "ja_JP" ] }, { "type": "string", "enum": [ "nl" ] }, { "type": "string", "enum": [ "nl_NL" ] }, { "type": "string", "enum": [ "pl" ] }, { "type": "string", "enum": [ "pl_PL" ] }, { "type": "string", "enum": [ "pt" ] }, { "type": "string", "enum": [ "pt_BR" ] }, { "type": "string", "enum": [ "pt_PT" ] }, { "type": "string", "enum": [ "sv" ] }, { "type": "string", "enum": [ "sv_SE" ] }, { "type": "string", "enum": [ "tr" ] }, { "type": "string", "enum": [ "tr_TR" ] }, { "type": "string", "enum": [ "zh" ] }, { "type": "string", "enum": [ "zh_CN" ] }, { "type": "string", "enum": [ "zh_TW" ] } ] }, "example": "example" }, { "in": "query", "name": "parentageLevel", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "NONE" ] }, { "type": "string", "enum": [ "CHILD" ] }, { "type": "string", "enum": [ "PARENT" ] } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "productType", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: productType" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetDefinitionsProductTypeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetDefinitionsProductTypeErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/fba/inbound/v1/eligibility/itemPreview": { "get": { "operationId": "get-v3-az-fba-inbound-v1-eligibility-itemPreview", "summary": "getItemEligibilityPreview", "description": "Thin wrapper around Amazon's [getItemEligibilityPreview](https://developer-docs.amazon/sp-api/reference/getitemeligibilitypreview) API", "tags": [ "Amazon/fbaInbound" ], "parameters": [ { "in": "query", "name": "marketplaceIds", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "example": "example" }, { "in": "query", "name": "asin", "required": true, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "program", "required": true, "schema": { "type": "string", "enum": [ "INBOUND", "COMMINGLING" ] }, "example": "INBOUND" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetItemEligibilityPreviewResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetItemEligibilityPreviewErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/fba/inventory/v1/items": { "post": { "operationId": "post-v3-az-fba-inventory-v1-items", "summary": "createInventoryItem", "description": "Thin wrapper around Amazon's [createInventoryItem](https://developer-docs.amazon/sp-api/reference/createinventoryitem) API", "tags": [ "Amazon/fbaInventory" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateInventoryItemBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateInventoryItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateInventoryItemErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/fba/inventory/v1/summaries": { "get": { "operationId": "get-v3-az-fba-inventory-v1-summaries", "summary": "getInventorySummaries", "description": "Thin wrapper around Amazon's [getInventorySummaries](https://developer-docs.amazon/sp-api/reference/getinventorysummaries) API", "tags": [ "Amazon/fbaInventory" ], "parameters": [ { "in": "query", "name": "details", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "example": "example" }, { "in": "query", "name": "startDateTime", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "sellerSkus", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "example": "example" }, { "in": "query", "name": "sellerSku", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "nextToken", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "granularityType", "required": false, "schema": { "type": "string", "enum": [ "Marketplace" ] }, "example": "Marketplace" }, { "in": "query", "name": "granularityId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "marketplaceIds", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInventorySummariesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInventorySummariesErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/fba/inventory/v1/items/{sellerSku}": { "delete": { "operationId": "delete-v3-az-fba-inventory-v1-items-{sellerSku}", "summary": "deleteInventoryItem", "description": "Thin wrapper around Amazon's [deleteInventoryItem](https://developer-docs.amazon/sp-api/reference/deleteinventoryitem) API", "tags": [ "Amazon/fbaInventory" ], "parameters": [ { "in": "query", "name": "marketplaceId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "sellerSku", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: sellerSku" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiDeleteInventoryItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiDeleteInventoryItemErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/fba/inventory/v1/items/inventory": { "post": { "operationId": "post-v3-az-fba-inventory-v1-items-inventory", "summary": "addInventory", "description": "Thin wrapper around Amazon's [addInventory](https://developer-docs.amazon/sp-api/reference/addinventory) API", "tags": [ "Amazon/fbaInventory" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiAddInventoryBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiAddInventoryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiAddInventoryErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans", "summary": "listInboundPlans", "description": "Thin wrapper around Amazon's [listInboundPlans](https://developer-docs.amazon/sp-api/reference/listinboundplans) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "status", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ACTIVE" ] }, { "type": "string", "enum": [ "SHIPPED" ] }, { "type": "string", "enum": [ "VOIDED" ] } ] }, "example": "example" }, { "in": "query", "name": "sortBy", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "LAST_UPDATED_TIME" ] }, { "type": "string", "enum": [ "CREATION_TIME" ] } ] }, "example": "example" }, { "in": "query", "name": "sortOrder", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ASC" ] }, { "type": "string", "enum": [ "DESC" ] } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListInboundPlansResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListInboundPlansErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans", "summary": "createInboundPlan", "description": "Thin wrapper around Amazon's [createInboundPlan](https://developer-docs.amazon/sp-api/reference/createinboundplan) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "plan_id", "required": false, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInboundPlanBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInboundPlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInboundPlanErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}", "summary": "getInboundPlan", "description": "Thin wrapper around Amazon's [getInboundPlan](https://developer-docs.amazon/sp-api/reference/getinboundplan) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetInboundPlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetInboundPlanErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/items/compliance": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-items-compliance", "summary": "listItemComplianceDetails", "description": "Thin wrapper around Amazon's [listItemComplianceDetails](https://developer-docs.amazon/sp-api/reference/listitemcompliancedetails) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mskus", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "marketplaceId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListItemComplianceDetailsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListItemComplianceDetailsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "put": { "operationId": "put-v3-az-inbound-fba-2024-03-20-items-compliance", "summary": "updateItemComplianceDetails", "description": "Thin wrapper around Amazon's [updateItemComplianceDetails](https://developer-docs.amazon/sp-api/reference/updateitemcompliancedetails) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "marketplaceId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiUpdateItemComplianceDetailsBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiUpdateItemComplianceDetailsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiUpdateItemComplianceDetailsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/items/labels": { "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-items-labels", "summary": "createMarketplaceItemLabels", "description": "Thin wrapper around Amazon's [createMarketplaceItemLabels](https://developer-docs.amazon/sp-api/reference/createmarketplaceitemlabels) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateMarketplaceItemLabelsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateMarketplaceItemLabelsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateMarketplaceItemLabelsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/items/prepDetails": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-items-prepDetails", "summary": "listPrepDetails", "description": "Thin wrapper around Amazon's [listPrepDetails](https://developer-docs.amazon/sp-api/reference/listprepdetails) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "marketplaceId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "mskus", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListPrepDetailsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListPrepDetailsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-items-prepDetails", "summary": "setPrepDetails", "description": "Thin wrapper around Amazon's [setPrepDetails](https://developer-docs.amazon/sp-api/reference/setprepdetails) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSetPrepDetailsBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSetPrepDetailsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSetPrepDetailsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/operations/{operationId}": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-operations-{operationId}", "summary": "getInboundOperationStatus", "description": "Thin wrapper around Amazon's [getInboundOperationStatus](https://developer-docs.amazon/sp-api/reference/getinboundoperationstatus) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "operationId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: operationId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetInboundOperationStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetInboundOperationStatusErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/boxes": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-boxes", "summary": "listInboundPlanBoxes", "description": "Thin wrapper around Amazon's [listInboundPlanBoxes](https://developer-docs.amazon/sp-api/reference/listinboundplanboxes) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListInboundPlanBoxesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListInboundPlanBoxesErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/cancellation": { "put": { "operationId": "put-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-cancellation", "summary": "cancelInboundPlan", "description": "Thin wrapper around Amazon's [cancelInboundPlan](https://developer-docs.amazon/sp-api/reference/cancelinboundplan) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "put_back", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelInboundPlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelInboundPlanErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/items": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-items", "summary": "listInboundPlanItems", "description": "Thin wrapper around Amazon's [listInboundPlanItems](https://developer-docs.amazon/sp-api/reference/listinboundplanitems) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListInboundPlanItemsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListInboundPlanItemsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/name": { "put": { "operationId": "put-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-name", "summary": "updateInboundPlanName", "description": "Thin wrapper around Amazon's [updateInboundPlanName](https://developer-docs.amazon/sp-api/reference/updateinboundplanname) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInboundPlanNameBody" } } } }, "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingInformation": { "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-packingInformation", "summary": "setPackingInformation", "description": "Thin wrapper around Amazon's [setPackingInformation](https://developer-docs.amazon/sp-api/reference/setpackinginformation) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSetPackingInformationBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSetPackingInformationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSetPackingInformationErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-packingOptions", "summary": "listPackingOptions", "description": "Thin wrapper around Amazon's [listPackingOptions](https://developer-docs.amazon/sp-api/reference/listpackingoptions) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "all_pages", "required": false, "schema": { "type": "boolean", "description": "loop through all pages. defaults to true" }, "description": "loop through all pages. defaults to true", "example": true }, { "in": "query", "name": "maybe_202", "required": false, "schema": { "type": "boolean", "description": "return a 202 response if we have to wait for more than 5 seconds. defaults to true" }, "description": "return a 202 response if we have to wait for more than 5 seconds. defaults to true", "example": true }, { "in": "query", "name": "sleepMs", "required": false, "schema": { "type": "number", "description": "how long to sleep between pages. defaults to 500ms" }, "description": "how long to sleep between pages. defaults to 500ms", "example": 1 }, { "in": "query", "name": "accept_first_packing_option", "required": false, "schema": { "type": "boolean", "description": "defaults to true, pass `false` to prevent auto-accept of first packing option" }, "description": "defaults to true, pass `false` to prevent auto-accept of first packing option", "example": true }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPackingOptionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPackingOptionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-packingOptions", "summary": "generatePackingOptions", "description": "Thin wrapper around Amazon's [generatePackingOptions](https://developer-docs.amazon/sp-api/reference/generatepackingoptions) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGeneratePackingOptionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGeneratePackingOptionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/pallets": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-pallets", "summary": "listInboundPlanPallets", "description": "Thin wrapper around Amazon's [listInboundPlanPallets](https://developer-docs.amazon/sp-api/reference/listinboundplanpallets) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListInboundPlanPalletsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListInboundPlanPalletsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-placementOptions", "summary": "listPlacementOptions", "description": "Thin wrapper around Amazon's [listPlacementOptions](https://developer-docs.amazon/sp-api/reference/listplacementoptions) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "all_pages", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "example": "example" }, { "in": "query", "name": "maybe_202", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "sleepMs", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPlacementOptionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPlacementOptionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-placementOptions", "summary": "generatePlacementOptions", "description": "Thin wrapper around Amazon's [generatePlacementOptions](https://developer-docs.amazon/sp-api/reference/generateplacementoptions) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "plan_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "operation_complete", "required": false, "schema": { "type": "boolean", "description": "wait for operation to complete. defaults to true" }, "description": "wait for operation to complete. defaults to true", "example": true }, { "in": "query", "name": "maybe_202", "required": false, "schema": { "type": "boolean", "description": "return a 202 response if we have to wait for more than 5 seconds. defaults to true" }, "description": "return a 202 response if we have to wait for more than 5 seconds. defaults to true", "example": true }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratePlacementOptionsBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratePlacementOptionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratePlacementOptionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-transportationOptions", "summary": "listTransportationOptions", "description": "Thin wrapper around Amazon's [listTransportationOptions](https://developer-docs.amazon/sp-api/reference/listtransportationoptions) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "placementOptionId", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": 123 }, { "in": "query", "name": "shipmentId", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": 123 }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransportationOptionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransportationOptionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-transportationOptions", "summary": "generateTransportationOptions", "description": "Thin wrapper around Amazon's [generateTransportationOptions](https://developer-docs.amazon/sp-api/reference/generatetransportationoptions) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateTransportationOptionsBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateTransportationOptionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateTransportationOptionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}", "summary": "getShipment", "description": "Thin wrapper around Amazon's [getShipment](https://developer-docs.amazon/sp-api/reference/getshipment) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShipmentErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions/confirmation": { "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-transportationOptions-confirmation", "summary": "confirmTransportationOptions", "description": "Thin wrapper around Amazon's [confirmTransportationOptions](https://developer-docs.amazon/sp-api/reference/confirmtransportationoptions) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmTransportationOptionsBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmTransportationOptionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmTransportationOptionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/boxes": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-packingGroups-{packingGroupId}-boxes", "summary": "listPackingGroupBoxes", "description": "Thin wrapper around Amazon's [listPackingGroupBoxes](https://developer-docs.amazon/sp-api/reference/listpackinggroupboxes) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "packingGroupId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: packingGroupId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListPackingGroupBoxesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListPackingGroupBoxesErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/items": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-packingGroups-{packingGroupId}-items", "summary": "listPackingGroupItems", "description": "Thin wrapper around Amazon's [listPackingGroupItems](https://developer-docs.amazon/sp-api/reference/listpackinggroupitems) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "all_pages", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "example": "example" }, { "in": "query", "name": "maybe_202", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "sleepMs", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "packingGroupId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: packingGroupId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPackingGroupItemsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPackingGroupItemsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions/{packingOptionId}/confirmation": { "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-packingOptions-{packingOptionId}-confirmation", "summary": "confirmPackingOption", "description": "Thin wrapper around Amazon's [confirmPackingOption](https://developer-docs.amazon/sp-api/reference/confirmpackingoption) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "packingOptionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: packingOptionId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmPackingOptionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmPackingOptionErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions/{placementOptionId}/confirmation": { "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-placementOptions-{placementOptionId}-confirmation", "summary": "confirmPlacementOption", "description": "Thin wrapper around Amazon's [confirmPlacementOption](https://developer-docs.amazon/sp-api/reference/confirmplacementoption) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "operation_complete", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "example": "example" }, { "in": "query", "name": "maybe_202", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "placementOptionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: placementOptionId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmPlacementOptionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmPlacementOptionErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxes": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-boxes", "summary": "listShipmentBoxes", "description": "Thin wrapper around Amazon's [listShipmentBoxes](https://developer-docs.amazon/sp-api/reference/listshipmentboxes) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShipmentBoxesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShipmentBoxesErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-contentUpdatePreviews", "summary": "listShipmentContentUpdatePreviews", "description": "Thin wrapper around Amazon's [listShipmentContentUpdatePreviews](https://developer-docs.amazon/sp-api/reference/listshipmentcontentupdatepreviews) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListShipmentContentUpdatePreviewsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListShipmentContentUpdatePreviewsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-contentUpdatePreviews", "summary": "generateShipmentContentUpdatePreviews", "description": "Thin wrapper around Amazon's [generateShipmentContentUpdatePreviews](https://developer-docs.amazon/sp-api/reference/generateshipmentcontentupdatepreviews) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGenerateShipmentContentUpdatePreviewsBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGenerateShipmentContentUpdatePreviewsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGenerateShipmentContentUpdatePreviewsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryChallanDocument": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-deliveryChallanDocument", "summary": "getDeliveryChallanDocument", "description": "Thin wrapper around Amazon's [getDeliveryChallanDocument](https://developer-docs.amazon/sp-api/reference/getdeliverychallandocument) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetDeliveryChallanDocumentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetDeliveryChallanDocumentErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-deliveryWindowOptions", "summary": "listDeliveryWindowOptions", "description": "Thin wrapper around Amazon's [listDeliveryWindowOptions](https://developer-docs.amazon/sp-api/reference/listdeliverywindowoptions) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDeliveryWindowOptionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDeliveryWindowOptionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-deliveryWindowOptions", "summary": "generateDeliveryWindowOptions", "description": "Thin wrapper around Amazon's [generateDeliveryWindowOptions](https://developer-docs.amazon/sp-api/reference/generatedeliverywindowoptions) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateDeliveryWindowOptionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateDeliveryWindowOptionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/items": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-items", "summary": "listShipmentItems", "description": "Thin wrapper around Amazon's [listShipmentItems](https://developer-docs.amazon/sp-api/reference/listshipmentitems) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShipmentItemsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShipmentItemsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/name": { "put": { "operationId": "put-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-name", "summary": "updateShipmentName", "description": "Thin wrapper around Amazon's [updateShipmentName](https://developer-docs.amazon/sp-api/reference/updateshipmentname) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShipmentNameBody" } } } }, "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/pallets": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-pallets", "summary": "listShipmentPallets", "description": "Thin wrapper around Amazon's [listShipmentPallets](https://developer-docs.amazon/sp-api/reference/listshipmentpallets) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListShipmentPalletsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiListShipmentPalletsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentCancellation": { "put": { "operationId": "put-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-selfShipAppointmentCancellation", "summary": "cancelSelfShipAppointment", "description": "Thin wrapper around Amazon's [cancelSelfShipAppointment](https://developer-docs.amazon/sp-api/reference/cancelselfshipappointment) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCancelSelfShipAppointmentBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCancelSelfShipAppointmentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCancelSelfShipAppointmentErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-selfShipAppointmentSlots", "summary": "getSelfShipAppointmentSlots", "description": "Thin wrapper around Amazon's [getSelfShipAppointmentSlots](https://developer-docs.amazon/sp-api/reference/getselfshipappointmentslots) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetSelfShipAppointmentSlotsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetSelfShipAppointmentSlotsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-selfShipAppointmentSlots", "summary": "generateSelfShipAppointmentSlots", "description": "Thin wrapper around Amazon's [generateSelfShipAppointmentSlots](https://developer-docs.amazon/sp-api/reference/generateselfshipappointmentslots) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGenerateSelfShipAppointmentSlotsBody" } } } }, "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/sourceAddress": { "put": { "operationId": "put-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-sourceAddress", "summary": "updateShipmentSourceAddress", "description": "Thin wrapper around Amazon's [updateShipmentSourceAddress](https://developer-docs.amazon/sp-api/reference/updateshipmentsourceaddress) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiUpdateShipmentSourceAddressBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiUpdateShipmentSourceAddressResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiUpdateShipmentSourceAddressErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/trackingDetails": { "put": { "operationId": "put-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-trackingDetails", "summary": "updateShipmentTrackingDetails", "description": "Thin wrapper around Amazon's [updateShipmentTrackingDetails](https://developer-docs.amazon/sp-api/reference/updateshipmenttrackingdetails) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShipmentTrackingDetailsBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShipmentTrackingDetailsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShipmentTrackingDetailsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}": { "get": { "operationId": "get-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-contentUpdatePreviews-{contentUpdatePreviewId}", "summary": "getShipmentContentUpdatePreview", "description": "Thin wrapper around Amazon's [getShipmentContentUpdatePreview](https://developer-docs.amazon/sp-api/reference/getshipmentcontentupdatepreview) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" }, { "name": "contentUpdatePreviewId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: contentUpdatePreviewId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetShipmentContentUpdatePreviewResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetShipmentContentUpdatePreviewErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}/confirmation": { "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-contentUpdatePreviews-{contentUpdatePreviewId}-confirmation", "summary": "confirmShipmentContentUpdatePreview", "description": "Thin wrapper around Amazon's [confirmShipmentContentUpdatePreview](https://developer-docs.amazon/sp-api/reference/confirmshipmentcontentupdatepreview) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" }, { "name": "contentUpdatePreviewId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: contentUpdatePreviewId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiConfirmShipmentContentUpdatePreviewResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiConfirmShipmentContentUpdatePreviewErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions/{deliveryWindowOptionId}/confirmation": { "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-deliveryWindowOptions-{deliveryWindowOptionId}-confirmation", "summary": "confirmDeliveryWindowOptions", "description": "Thin wrapper around Amazon's [confirmDeliveryWindowOptions](https://developer-docs.amazon/sp-api/reference/confirmdeliverywindowoptions) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" }, { "name": "deliveryWindowOptionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: deliveryWindowOptionId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmDeliveryWindowOptionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmDeliveryWindowOptionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots/{slotId}/schedule": { "post": { "operationId": "post-v3-az-inbound-fba-2024-03-20-inboundPlans-{inboundPlanId}-shipments-{shipmentId}-selfShipAppointmentSlots-{slotId}-schedule", "summary": "scheduleSelfShipAppointment", "description": "Thin wrapper around Amazon's [scheduleSelfShipAppointment](https://developer-docs.amazon/sp-api/reference/scheduleselfshipappointment) API", "tags": [ "Amazon/fulfillmentInbound_2024-03-20" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "inboundPlanId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundPlanId" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" }, { "name": "slotId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: slotId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiScheduleSelfShipAppointmentBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiScheduleSelfShipAppointmentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiScheduleSelfShipAppointmentErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/fba/inbound/v0/prepInstructions": { "get": { "operationId": "get-v3-az-fba-inbound-v0-prepInstructions", "summary": "getPrepInstructions", "description": "Thin wrapper around Amazon's [getPrepInstructions](https://developer-docs.amazon/sp-api/reference/getprepinstructions) API", "tags": [ "Amazon/fulfillmentInboundV0" ], "parameters": [ { "in": "query", "name": "ShipToCountryCode", "required": true, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "SellerSKUList", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "example": "example" }, { "in": "query", "name": "ASINList", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetPrepInstructionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetPrepInstructionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/fba/inbound/v0/shipmentItems": { "get": { "operationId": "get-v3-az-fba-inbound-v0-shipmentItems", "summary": "getShipmentItems", "description": "Thin wrapper around Amazon's [getShipmentItems](https://developer-docs.amazon/sp-api/reference/getshipmentitems) API", "tags": [ "Amazon/fulfillmentInboundV0" ], "parameters": [ { "in": "query", "name": "LastUpdatedAfter", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "LastUpdatedBefore", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "QueryType", "required": true, "schema": { "type": "string", "enum": [ "DATE_RANGE", "NEXT_TOKEN" ] }, "example": "DATE_RANGE" }, { "in": "query", "name": "NextToken", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "MarketplaceId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetShipmentItemsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetShipmentItemsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/fba/inbound/v0/shipments": { "get": { "operationId": "get-v3-az-fba-inbound-v0-shipments", "summary": "getShipments", "description": "Thin wrapper around Amazon's [getShipments](https://developer-docs.amazon/sp-api/reference/getshipments) API", "tags": [ "Amazon/fulfillmentInboundV0" ], "parameters": [ { "in": "query", "name": "ShipmentStatusList", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "WORKING", "READY_TO_SHIP", "SHIPPED", "RECEIVING", "CANCELLED", "DELETED", "CLOSED", "ERROR", "IN_TRANSIT", "DELIVERED", "CHECKED_IN" ] } } ] }, "example": "example" }, { "in": "query", "name": "ShipmentIdList", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "example": "example" }, { "in": "query", "name": "LastUpdatedAfter", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "LastUpdatedBefore", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "QueryType", "required": true, "schema": { "type": "string", "enum": [ "DATE_RANGE", "NEXT_TOKEN", "SHIPMENT" ] }, "example": "DATE_RANGE" }, { "in": "query", "name": "NextToken", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "MarketplaceId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetShipmentsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetShipmentsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/fba/inbound/v0/shipments/{shipmentId}/billOfLading": { "get": { "operationId": "get-v3-az-fba-inbound-v0-shipments-{shipmentId}-billOfLading", "summary": "getBillOfLading", "description": "Thin wrapper around Amazon's [getBillOfLading](https://developer-docs.amazon/sp-api/reference/getbilloflading) API", "tags": [ "Amazon/fulfillmentInboundV0" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetBillOfLadingResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetBillOfLadingErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/fba/inbound/v0/shipments/{shipmentId}/items": { "get": { "operationId": "get-v3-az-fba-inbound-v0-shipments-{shipmentId}-items", "summary": "getShipmentItemsByShipmentId", "description": "Thin wrapper around Amazon's [getShipmentItemsByShipmentId](https://developer-docs.amazon/sp-api/reference/getshipmentitemsbyshipmentid) API", "tags": [ "Amazon/fulfillmentInboundV0" ], "parameters": [ { "in": "query", "name": "MarketplaceId", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "123" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetShipmentItemsByShipmentIdResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetShipmentItemsByShipmentIdErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/fba/inbound/v0/shipments/{shipmentId}/labels": { "get": { "operationId": "get-v3-az-fba-inbound-v0-shipments-{shipmentId}-labels", "summary": "getLabels", "description": "Thin wrapper around Amazon's [getLabels](https://developer-docs.amazon/sp-api/reference/getlabels) API", "tags": [ "Amazon/fulfillmentInboundV0" ], "parameters": [ { "in": "query", "name": "PageType", "required": true, "schema": { "type": "string", "enum": [ "PackageLabel_Letter_2", "PackageLabel_Letter_4", "PackageLabel_Letter_6", "PackageLabel_Letter_6_CarrierLeft", "PackageLabel_A4_2", "PackageLabel_A4_4", "PackageLabel_Plain_Paper", "PackageLabel_Plain_Paper_CarrierBottom", "PackageLabel_Thermal", "PackageLabel_Thermal_Unified", "PackageLabel_Thermal_NonPCP", "PackageLabel_Thermal_No_Carrier_Rotation" ] }, "example": "PackageLabel_Letter_2" }, { "in": "query", "name": "LabelType", "required": true, "schema": { "type": "string", "enum": [ "BARCODE_2D", "UNIQUE", "PALLET" ] }, "example": "BARCODE_2D" }, { "in": "query", "name": "NumberOfPackages", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "PackageLabelsToPrint", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "example": "example" }, { "in": "query", "name": "NumberOfPallets", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "PageSize", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "PageStartIndex", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipmentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLabelsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLabelsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/listings/2021-08-01/items/{sellerId}": { "get": { "operationId": "get-v3-az-listings-2021-08-01-items-{sellerId}", "summary": "searchListingsItems", "description": "Thin wrapper around Amazon's [searchListingsItems](https://developer-docs.amazon/sp-api/reference/searchlistingsitems) API", "tags": [ "Amazon/listingsItems_2021-08-01" ], "parameters": [ { "in": "query", "name": "marketplaceIds", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "issueLocale", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "includedData", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "attributes", "productTypes", "relationships", "summaries", "issues", "offers", "fulfillmentAvailability", "procurement" ] } } ] }, "example": "example" }, { "in": "query", "name": "identifiers", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "object" } ] }, "example": "example" }, { "in": "query", "name": "identifiersType", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ASIN" ] }, { "type": "string", "enum": [ "EAN" ] }, { "type": "string", "enum": [ "GTIN" ] }, { "type": "string", "enum": [ "ISBN" ] }, { "type": "string", "enum": [ "JAN" ] }, { "type": "string", "enum": [ "MINSAN" ] }, { "type": "string", "enum": [ "SKU" ] }, { "type": "string", "enum": [ "UPC" ] }, { "type": "string", "enum": [ "FNSKU" ] } ] }, "example": "example" }, { "in": "query", "name": "variationParentSku", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "packageHierarchySku", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "lastUpdatedAfter", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "lastUpdatedBefore", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "withIssueSeverity", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "ERROR", "WARNING" ] } } ] }, "example": "example" }, { "in": "query", "name": "withStatus", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "BUYABLE", "DISCOVERABLE" ] } } ] }, "example": "example" }, { "in": "query", "name": "withoutStatus", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "sortBy", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "sku" ] }, { "type": "string", "enum": [ "createdDate" ] }, { "type": "string", "enum": [ "lastUpdatedDate" ] } ] }, "example": "example" }, { "in": "query", "name": "sortOrder", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "ASC" ] }, { "type": "string", "enum": [ "DESC" ] } ] }, "example": "example" }, { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "pageToken", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: sellerId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSearchListingsItemsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSearchListingsItemsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/listings/2021-08-01/items/{sellerId}/{sku}": { "get": { "operationId": "get-v3-az-listings-2021-08-01-items-{sellerId}-{sku}", "summary": "getListingsItem", "description": "Thin wrapper around Amazon's [getListingsItem](https://developer-docs.amazon/sp-api/reference/getlistingsitem) API", "tags": [ "Amazon/listingsItems_2021-08-01" ], "parameters": [ { "in": "query", "name": "marketplaceIds", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "issueLocale", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "includedData", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "attributes", "productTypes", "relationships", "summaries", "issues", "offers", "fulfillmentAvailability", "procurement" ] } } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: sellerId" }, { "name": "sku", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: sku" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetListingsItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetListingsItemErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "put": { "operationId": "put-v3-az-listings-2021-08-01-items-{sellerId}-{sku}", "summary": "putListingsItem", "description": "Thin wrapper around Amazon's [putListingsItem](https://developer-docs.amazon/sp-api/reference/putlistingsitem) API", "tags": [ "Amazon/listingsItems_2021-08-01" ], "parameters": [ { "in": "query", "name": "marketplaceIds", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "includedData", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "identifiers", "issues" ] } } ] }, "example": "example" }, { "in": "query", "name": "mode", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "VALIDATION_PREVIEW" ] } ] }, "example": "example" }, { "in": "query", "name": "issueLocale", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: sellerId" }, { "name": "sku", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: sku" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutListingsItemBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutListingsItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutListingsItemErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-az-listings-2021-08-01-items-{sellerId}-{sku}", "summary": "patchListingsItem", "description": "Thin wrapper around Amazon's [patchListingsItem](https://developer-docs.amazon/sp-api/reference/patchlistingsitem) API", "tags": [ "Amazon/listingsItems_2021-08-01" ], "parameters": [ { "in": "query", "name": "marketplaceIds", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "includedData", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "identifiers", "issues" ] } } ] }, "example": "example" }, { "in": "query", "name": "mode", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "VALIDATION_PREVIEW" ] } ] }, "example": "example" }, { "in": "query", "name": "issueLocale", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: sellerId" }, { "name": "sku", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: sku" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchListingsItemBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchListingsItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchListingsItemErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-az-listings-2021-08-01-items-{sellerId}-{sku}", "summary": "deleteListingsItem", "description": "Thin wrapper around Amazon's [deleteListingsItem](https://developer-docs.amazon/sp-api/reference/deletelistingsitem) API", "tags": [ "Amazon/listingsItems_2021-08-01" ], "parameters": [ { "in": "query", "name": "marketplaceIds", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "issueLocale", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: sellerId" }, { "name": "sku", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: sku" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiDeleteListingsItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiDeleteListingsItemErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/listings/2021-08-01/restrictions": { "get": { "operationId": "get-v3-az-listings-2021-08-01-restrictions", "summary": "getListingsRestrictions", "description": "Thin wrapper around Amazon's [getListingsRestrictions](https://developer-docs.amazon/sp-api/reference/getlistingsrestrictions) API", "tags": [ "Amazon/listingsRestrictions_2021-08-01" ], "parameters": [ { "in": "query", "name": "asin", "required": true, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "conditionType", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "new_new" ] }, { "type": "string", "enum": [ "new_open_box" ] }, { "type": "string", "enum": [ "new_oem" ] }, { "type": "string", "enum": [ "refurbished_refurbished" ] }, { "type": "string", "enum": [ "used_like_new" ] }, { "type": "string", "enum": [ "used_very_good" ] }, { "type": "string", "enum": [ "used_good" ] }, { "type": "string", "enum": [ "used_acceptable" ] }, { "type": "string", "enum": [ "collectible_like_new" ] }, { "type": "string", "enum": [ "collectible_very_good" ] }, { "type": "string", "enum": [ "collectible_good" ] }, { "type": "string", "enum": [ "collectible_acceptable" ] }, { "type": "string", "enum": [ "club_club" ] } ] }, "example": "example" }, { "in": "query", "name": "sellerId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "marketplaceIds", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "reasonLocale", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "productType", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetListingsRestrictionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetListingsRestrictionsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/notifications/v1/destinations": { "get": { "operationId": "get-v3-az-notifications-v1-destinations", "summary": "getDestinations", "description": "Thin wrapper around Amazon's [getDestinations](https://developer-docs.amazon/sp-api/reference/getdestinations) API", "tags": [ "Amazon/notifications" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetDestinationsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetDestinationsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-notifications-v1-destinations", "summary": "createDestination", "description": "Thin wrapper around Amazon's [createDestination](https://developer-docs.amazon/sp-api/reference/createdestination) API", "tags": [ "Amazon/notifications" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateDestinationBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateDestinationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateDestinationErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/notifications/v1/destinations/{destinationId}": { "get": { "operationId": "get-v3-az-notifications-v1-destinations-{destinationId}", "summary": "getDestination", "description": "Thin wrapper around Amazon's [getDestination](https://developer-docs.amazon/sp-api/reference/getdestination) API", "tags": [ "Amazon/notifications" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: destinationId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetDestinationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetDestinationErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-az-notifications-v1-destinations-{destinationId}", "summary": "deleteDestination", "description": "Thin wrapper around Amazon's [deleteDestination](https://developer-docs.amazon/sp-api/reference/deletedestination) API", "tags": [ "Amazon/notifications" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: destinationId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiDeleteDestinationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiDeleteDestinationErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/notifications/v1/subscriptions/{notificationType}": { "get": { "operationId": "get-v3-az-notifications-v1-subscriptions-{notificationType}", "summary": "getSubscription", "description": "Thin wrapper around Amazon's [getSubscription](https://developer-docs.amazon/sp-api/reference/getsubscription) API", "tags": [ "Amazon/notifications" ], "parameters": [ { "in": "query", "name": "payloadVersion", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "notificationType", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: notificationType" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetSubscriptionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetSubscriptionErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-notifications-v1-subscriptions-{notificationType}", "summary": "createSubscription", "description": "Thin wrapper around Amazon's [createSubscription](https://developer-docs.amazon/sp-api/reference/createsubscription) API", "tags": [ "Amazon/notifications" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "notificationType", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: notificationType" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateSubscriptionBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateSubscriptionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateSubscriptionErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/notifications/v1/subscriptions/{notificationType}/{subscriptionId}": { "get": { "operationId": "get-v3-az-notifications-v1-subscriptions-{notificationType}-{subscriptionId}", "summary": "getSubscriptionById", "description": "Thin wrapper around Amazon's [getSubscriptionById](https://developer-docs.amazon/sp-api/reference/getsubscriptionbyid) API", "tags": [ "Amazon/notifications" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "notificationType", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: notificationType" }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: subscriptionId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetSubscriptionByIdResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetSubscriptionByIdErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-az-notifications-v1-subscriptions-{notificationType}-{subscriptionId}", "summary": "deleteSubscriptionById", "description": "Thin wrapper around Amazon's [deleteSubscriptionById](https://developer-docs.amazon/sp-api/reference/deletesubscriptionbyid) API", "tags": [ "Amazon/notifications" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "notificationType", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: notificationType" }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: subscriptionId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiDeleteSubscriptionByIdResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiDeleteSubscriptionByIdErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/notifications/v1/subscriptions/{notificationType}/testNotification": { "post": { "operationId": "post-v3-az-notifications-v1-subscriptions-{notificationType}-testNotification", "summary": "sendTestNotification", "description": "Thin wrapper around Amazon's [sendTestNotification](https://developer-docs.amazon/sp-api/reference/sendtestnotification) API", "tags": [ "Amazon/notifications" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "notificationType", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: notificationType" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSendTestNotificationBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSendTestNotificationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSendTestNotificationErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/orders/2026-01-01/orders": { "get": { "operationId": "get-v3-az-orders-2026-01-01-orders", "summary": "searchOrders", "description": "Thin wrapper around Amazon's [searchOrders](https://developer-docs.amazon/sp-api/reference/searchorders) API", "tags": [ "Amazon/orders_2026-01-01" ], "parameters": [ { "in": "query", "name": "createdAfter", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "lastUpdatedAfter", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "lastUpdatedBefore", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "fulfillmentStatuses", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "SHIPPED", "CANCELLED", "PENDING_AVAILABILITY", "PENDING", "UNSHIPPED", "PARTIALLY_SHIPPED", "UNFULFILLABLE" ] } } ] }, "example": "example" }, { "in": "query", "name": "marketplaceIds", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "example": "example" }, { "in": "query", "name": "fulfilledBy", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "MERCHANT", "AMAZON" ] } } ] }, "example": "example" }, { "in": "query", "name": "maxResultsPerPage", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "paginationToken", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "includedData", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "BUYER", "RECIPIENT", "PROCEEDS", "EXPENSE", "PROMOTION", "CANCELLATION", "FULFILLMENT", "PACKAGES", "TAX", "PAYMENT", "FULFILLMENT_ORDERS" ] } } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSearchOrdersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiSearchOrdersErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/orders/2026-01-01/orders/{orderId}": { "get": { "operationId": "get-v3-az-orders-2026-01-01-orders-{orderId}", "summary": "getOrder", "description": "Thin wrapper around Amazon's [getOrder](https://developer-docs.amazon/sp-api/reference/getorder) API", "tags": [ "Amazon/orders_2026-01-01" ], "parameters": [ { "in": "query", "name": "includedData", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "BUYER", "RECIPIENT", "PROCEEDS", "EXPENSE", "PROMOTION", "CANCELLATION", "FULFILLMENT", "PACKAGES", "TAX", "PAYMENT", "FULFILLMENT_ORDERS" ] } } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: orderId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetOrderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetOrderErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/products/fees/v0/feesEstimate": { "post": { "operationId": "post-v3-az-products-fees-v0-feesEstimate", "summary": "getMyFeesEstimates", "description": "Thin wrapper around Amazon's [getMyFeesEstimates](https://developer-docs.amazon/sp-api/reference/getmyfeesestimates) API", "tags": [ "Amazon/productFeesV0" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetMyFeesEstimatesBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetMyFeesEstimatesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetMyFeesEstimatesErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/products/fees/v0/items/{Asin}/feesEstimate": { "post": { "operationId": "post-v3-az-products-fees-v0-items-{Asin}-feesEstimate", "summary": "getMyFeesEstimateForASIN", "description": "Thin wrapper around Amazon's [getMyFeesEstimateForASIN](https://developer-docs.amazon/sp-api/reference/getmyfeesestimateforasin) API", "tags": [ "Amazon/productFeesV0" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "Asin", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: Asin" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetMyFeesEstimateForASINBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetMyFeesEstimateForASINResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetMyFeesEstimateForASINErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/products/fees/v0/listings/{SellerSKU}/feesEstimate": { "post": { "operationId": "post-v3-az-products-fees-v0-listings-{SellerSKU}-feesEstimate", "summary": "getMyFeesEstimateForSKU", "description": "Thin wrapper around Amazon's [getMyFeesEstimateForSKU](https://developer-docs.amazon/sp-api/reference/getmyfeesestimateforsku) API", "tags": [ "Amazon/productFeesV0" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "SellerSKU", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: SellerSKU" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetMyFeesEstimateForSKUBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetMyFeesEstimateForSKUResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetMyFeesEstimateForSKUErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/batches/products/pricing/2022-05-01/items/competitiveSummary": { "post": { "operationId": "post-v3-az-batches-products-pricing-2022-05-01-items-competitiveSummary", "summary": "getCompetitiveSummary", "description": "Thin wrapper around Amazon's [getCompetitiveSummary](https://developer-docs.amazon/sp-api/reference/getcompetitivesummary) API", "tags": [ "Amazon/productPricing_2022-05-01" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetCompetitiveSummaryBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetCompetitiveSummaryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetCompetitiveSummaryErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/batches/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice": { "post": { "operationId": "post-v3-az-batches-products-pricing-2022-05-01-offer-featuredOfferExpectedPrice", "summary": "getFeaturedOfferExpectedPriceBatch", "description": "Thin wrapper around Amazon's [getFeaturedOfferExpectedPriceBatch](https://developer-docs.amazon/sp-api/reference/getfeaturedofferexpectedpricebatch) API", "tags": [ "Amazon/productPricing_2022-05-01" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetFeaturedOfferExpectedPriceBatchBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetFeaturedOfferExpectedPriceBatchResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetFeaturedOfferExpectedPriceBatchErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/reports/2021-06-30/reports": { "get": { "operationId": "get-v3-az-reports-2021-06-30-reports", "summary": "getReports", "description": "Thin wrapper around Amazon's [getReports](https://developer-docs.amazon/sp-api/reference/getreports) API", "tags": [ "Amazon/reports_2021-06-30" ], "parameters": [ { "in": "query", "name": "reportTypes", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "example": "example" }, { "in": "query", "name": "processingStatuses", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "array", "items": { "type": "string", "enum": [ "IN_PROGRESS", "CANCELLED", "DONE", "FATAL", "IN_QUEUE" ] } } ] }, "example": "example" }, { "in": "query", "name": "marketplaceIds", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "pageSize", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "createdSince", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "createdUntil", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "nextToken", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetReportsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetReportsErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-reports-2021-06-30-reports", "summary": "createReport", "description": "Thin wrapper around Amazon's [createReport](https://developer-docs.amazon/sp-api/reference/createreport) API", "tags": [ "Amazon/reports_2021-06-30" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportBody" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/reports/2021-06-30/schedules": { "get": { "operationId": "get-v3-az-reports-2021-06-30-schedules", "summary": "getReportSchedules", "description": "Thin wrapper around Amazon's [getReportSchedules](https://developer-docs.amazon/sp-api/reference/getreportschedules) API", "tags": [ "Amazon/reports_2021-06-30" ], "parameters": [ { "in": "query", "name": "reportTypes", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetReportSchedulesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetReportSchedulesErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-az-reports-2021-06-30-schedules", "summary": "createReportSchedule", "description": "Thin wrapper around Amazon's [createReportSchedule](https://developer-docs.amazon/sp-api/reference/createreportschedule) API", "tags": [ "Amazon/reports_2021-06-30" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiCreateReportScheduleBody" } } } }, "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/reports/2021-06-30/documents/{reportDocumentId}": { "get": { "operationId": "get-v3-az-reports-2021-06-30-documents-{reportDocumentId}", "summary": "getReportDocument", "description": "Thin wrapper around Amazon's [getReportDocument](https://developer-docs.amazon/sp-api/reference/getreportdocument) API", "tags": [ "Amazon/reports_2021-06-30" ], "parameters": [ { "in": "query", "name": "enableContentEncodingUrlHeader", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "reportDocumentId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: reportDocumentId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetReportDocumentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetReportDocumentErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/reports/2021-06-30/reports/{reportId}": { "get": { "operationId": "get-v3-az-reports-2021-06-30-reports-{reportId}", "summary": "getReport", "description": "Thin wrapper around Amazon's [getReport](https://developer-docs.amazon/sp-api/reference/getreport) API", "tags": [ "Amazon/reports_2021-06-30" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: reportId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetReportResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetReportErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-az-reports-2021-06-30-reports-{reportId}", "summary": "cancelReport", "description": "Thin wrapper around Amazon's [cancelReport](https://developer-docs.amazon/sp-api/reference/cancelreport) API", "tags": [ "Amazon/reports_2021-06-30" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: reportId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/az/reports/2021-06-30/schedules/{reportScheduleId}": { "get": { "operationId": "get-v3-az-reports-2021-06-30-schedules-{reportScheduleId}", "summary": "getReportSchedule", "description": "Thin wrapper around Amazon's [getReportSchedule](https://developer-docs.amazon/sp-api/reference/getreportschedule) API", "tags": [ "Amazon/reports_2021-06-30" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "reportScheduleId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: reportScheduleId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetReportScheduleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpApiGetReportScheduleErrorResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-az-reports-2021-06-30-schedules-{reportScheduleId}", "summary": "cancelReportSchedule", "description": "Thin wrapper around Amazon's [cancelReportSchedule](https://developer-docs.amazon/sp-api/reference/cancelreportschedule) API", "tags": [ "Amazon/reports_2021-06-30" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "reportScheduleId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: reportScheduleId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/attachment": { "get": { "operationId": "get-v3-attachment", "summary": "selectAttachments", "description": "List attachments", "tags": [ "Attachment" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "attachment_ids", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "file_name", "required": false, "schema": { "type": "string", "description": "The name of the attached file" }, "description": "The name of the attached file", "example": "example" }, { "in": "query", "name": "purchase_order_ids", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectAttachmentsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-attachment", "summary": "insertAttachments", "description": "Create one or more attachments", "tags": [ "Attachment" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertAttachmentsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertAttachmentsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-attachment", "summary": "updateAttachments", "description": "Update one or more attachments", "tags": [ "Attachment" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAttachmentsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAttachmentsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-attachment", "summary": "deleteAttachments", "description": "Delete the specified attachments", "tags": [ "Attachment" ], "parameters": [ { "in": "query", "name": "attachment_ids", "required": true, "schema": { "type": "string", "description": "comma separated list of `attachment_id`s" }, "description": "comma separated list of `attachment_id`s", "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAttachmentsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/audit/ledger": { "get": { "operationId": "get-v3-audit-ledger", "summary": "selectLedger", "description": "List ledger audit events", "tags": [ "Audit" ], "parameters": [ { "in": "query", "name": "input_sku", "required": false, "schema": { "type": "string", "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU." }, "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU.", "example": "example" }, { "in": "query", "name": "output_sku", "required": false, "schema": { "type": "string", "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU." }, "description": "When adding an item to a plan, it may have a different marketplace SKU from the internal one. The `input_sku` represents the internal SKU. When bundling, this represents the \"single\" SKU.", "example": "example" }, { "in": "query", "name": "purchase_order_item_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "location_id", "required": false, "schema": { "type": [ "number", "null" ] }, "example": 123 }, { "in": "query", "name": "plan_item_id", "required": false, "schema": { "type": [ "number", "null" ] }, "example": 123 }, { "in": "query", "name": "az_shipment_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "wm_shipment_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "before", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" }, "example": "example" }, { "in": "query", "name": "after", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" }, "example": "example" }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "example": "asc" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "with_user_name", "required": false, "schema": { "type": "boolean", "description": "Returns the user's name" }, "description": "Returns the user's name", "example": true }, { "in": "query", "name": "with_location_name", "required": false, "schema": { "type": "boolean", "description": "Returns the location's name" }, "description": "Returns the location's name", "example": true }, { "in": "query", "name": "with_purchase_order_name", "required": false, "schema": { "type": "boolean", "description": "Returns the purchase order's name" }, "description": "Returns the purchase order's name", "example": true }, { "in": "query", "name": "ledger_entry_types", "required": false, "schema": { "type": "string", "enum": [ "ALLOCATION", "ALLOCATION_RELEASED", "BUNDLE_BUILD", "BUNDLE_UNBUILD", "CYCLE_COUNT_ADJUST", "DAMAGE_WRITE_OFF", "INVENTORY_IMPORT", "LOCATION_TRANSFER", "PO_CANCELLED", "PO_CREATED", "PO_RECEIPT_ADJUSTED", "PO_RECEIVED", "RETURN_TO_STOCK", "SHIPMENT_CANCELLED", "SHIPMENT_CONFIRMED", "SHIPMENT_PACKED", "TRANSFER_DAMAGED" ], "description": "comma separated list of ledger entry types" }, "description": "comma separated list of ledger entry types", "example": "ALLOCATION" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectLedgerResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/audit/plan": { "get": { "operationId": "get-v3-audit-plan", "summary": "selectPlanAuditLog", "description": "List audit events for a plan", "tags": [ "Audit" ], "parameters": [ { "in": "query", "name": "plan_id", "required": false, "schema": { "type": "number" }, "example": 123 }, { "in": "query", "name": "created_by", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "before", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" }, "example": "example" }, { "in": "query", "name": "after", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" }, "example": "example" }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "example": "asc" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "with_user_name", "required": false, "schema": { "type": "boolean", "description": "Returns the user's name" }, "description": "Returns the user's name", "example": true }, { "in": "query", "name": "with_plan_name", "required": false, "schema": { "type": "boolean", "description": "Returns the plan's name" }, "description": "Returns the plan's name", "example": true } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPlanAuditLogResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/audit/shipment": { "get": { "operationId": "get-v3-audit-shipment", "summary": "selectAzShipmentLog", "description": "List audit events for an Amazon shipment", "tags": [ "Audit" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "inbound_plan_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "shipment_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "shipment_confirmation_id", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" }, { "in": "query", "name": "created_by", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "before", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" }, "example": "example" }, { "in": "query", "name": "after", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" }, "example": "example" }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "example": "asc" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "with_user_name", "required": false, "schema": { "type": "boolean", "description": "Returns the user's name" }, "description": "Returns the user's name", "example": true }, { "in": "query", "name": "with_ship_from_name", "required": false, "schema": { "type": "boolean", "description": "Returns ship from name" }, "description": "Returns ship from name", "example": true } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectAzShipmentLogResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/auth": { "get": { "operationId": "get-v3-auth", "summary": "Auth", "description": "Get an access token to make further API calls. Pass a client user id in the `x-proxy` header to generate a token that can be used to make calls on behalf of that user", "tags": [ "Auth" ], "parameters": [], "security": [ { "BasicAuth": [] } ], "responses": { "200": { "description": "Access token and meta info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-auth", "summary": "OAuth", "description": "Implements a subset of OAuth 2.0 for generating refresh and access tokens. Use `grant_type=client_credentials` to generate a refresh token. Pass a client user id in the `x-proxy` header to generate a token that can be used to make calls on behalf of that user.", "tags": [ "Auth" ], "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OAuthRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-auth", "summary": "revokeToken", "description": "Revoke an access or refresh token (WIP)", "tags": [ "Auth" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/clients": { "get": { "operationId": "get-v3-clients", "summary": "selectClients", "description": "List associated clients", "tags": [ "Auth" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "client_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectClientsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-clients", "summary": "disableClients", "description": "Disable access to clients", "tags": [ "Auth" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertProxyeesParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisableClientsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/oauth": { "get": { "operationId": "get-v3-oauth", "summary": "thirdPartyOAuth", "description": "Initiate authorization of Amazon or Walmart", "tags": [ "Auth" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "the marketplace you wish to connect to" }, "description": "the marketplace you wish to connect to", "example": "az-AE" }, { "in": "query", "name": "redir", "required": false, "schema": { "type": "string", "description": "url to redirect to after the connection has been established, defaults to `/account/`" }, "description": "url to redirect to after the connection has been established, defaults to `/account/`", "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "307": { "description": "Successful response", "headers": { "Location": { "description": "Redirect target URL", "schema": { "type": "string", "format": "uri" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/bundle": { "get": { "operationId": "get-v3-bundle", "summary": "selectBundles", "description": "List product bundles", "tags": [ "Bundle" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "input_sku", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "output_sku", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number", "description": "defaults to 100" }, "description": "defaults to 100", "example": 1 }, { "in": "query", "name": "bundle_ids", "required": false, "schema": { "type": "string", "description": "comma separated list of `bundle_id`s" }, "description": "comma separated list of `bundle_id`s", "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectBundlesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-bundle", "summary": "insertBundles", "description": "Create one or more product bundles", "tags": [ "Bundle" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertBundlesBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertBundlesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/bundle/{bundle_id}": { "patch": { "operationId": "patch-v3-bundle-{bundle_id}", "summary": "updateBundle", "description": "Update a product bundle by ID", "tags": [ "Bundle" ], "parameters": [ { "in": "path", "name": "bundle_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBundleBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBundleResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-bundle-{bundle_id}", "summary": "deleteBundles", "description": "Delete product bundles by ID", "tags": [ "Bundle" ], "parameters": [ { "in": "path", "name": "bundle_id", "required": true, "schema": { "type": "string", "description": "comma separated list of `bundle_id`s" }, "description": "comma separated list of `bundle_id`s", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteBundlesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/dashboard": { "get": { "operationId": "get-v3-dashboard", "summary": "selectDashboard", "description": "Get dashboard data", "tags": [ "Dashboard" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/feed": { "get": { "operationId": "get-v3-feed", "summary": "selectFeeds", "description": "List feed records matching the requested filters", "tags": [ "Feed" ], "parameters": [ { "in": "query", "name": "feed_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "marketplace_id", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "A list of feeds to be processed when this one completes" }, "description": "A list of feeds to be processed when this one completes", "example": "az-AE" }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "start", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "example" }, { "in": "query", "name": "end", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "example" }, { "in": "query", "name": "status", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "PROCESSED", "ERROR", "Submitted" ] } }, "example": "example" }, { "in": "query", "name": "type", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "MP_ITEM_MATCH", "MP_ITEM", "inventory", "PRICE_AND_PROMOTION", "OMNI_WFS", "price" ] } }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectFeedsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/integration": { "get": { "operationId": "get-v3-integration", "summary": "selectIntegrations", "description": "List integrations", "tags": [ "Integration" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectIntegrationsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-integration", "summary": "updateIntegration", "description": "For integrations to update their own integration details", "tags": [ "Integration" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIntegrationParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIntegrationResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/integration/{integration_id}": { "put": { "operationId": "put-v3-integration-{integration_id}", "summary": "enableUserIntegration", "description": "", "tags": [ "Integration" ], "parameters": [ { "name": "integration_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: integration_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnableUserIntegrationResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-integration-{integration_id}", "summary": "disableUserIntegration", "description": "", "tags": [ "Integration" ], "parameters": [ { "name": "integration_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: integration_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisableUserIntegrationResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/integration/users": { "get": { "operationId": "get-v3-integration-users", "summary": "selectIntegrationUsers", "description": "List users for integration", "tags": [ "Integration" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectIntegrationUsersResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/all-inventory": { "get": { "operationId": "get-v3-all-inventory", "summary": "selectAllInventory", "description": "List inventory across all supported marketplaces", "tags": [ "Inventory" ], "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "type": "number", "description": "Only select this number of records" }, "description": "Only select this number of records", "example": 1 }, { "in": "query", "name": "marketplace_id", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "Limit items to this marketplace" }, "description": "Limit items to this marketplace", "example": "az-AE" }, { "in": "query", "name": "country", "required": false, "schema": { "type": "string", "enum": [ "AE", "AU", "BE", "BR", "CA", "CL", "CN", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ], "description": "Limit items to this country across channels (ie. az and wm)" }, "description": "Limit items to this country across channels (ie. az and wm)", "example": "AE" }, { "in": "query", "name": "search", "required": false, "schema": { "type": "string", "description": "Search inventory for matching values keyed by `search_by`" }, "description": "Search inventory for matching values keyed by `search_by`", "example": "example" }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean", "description": "Return inventory tags" }, "description": "Return inventory tags", "example": true }, { "in": "query", "name": "with_data", "required": false, "schema": { "type": "boolean", "description": "Return `data` element" }, "description": "Return `data` element", "example": true }, { "in": "query", "name": "in_stock", "required": false, "schema": { "type": "boolean", "description": "defaults to true, return only inventory with quantity" }, "description": "defaults to true, return only inventory with quantity", "example": true }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "description": "the next token for paging" }, "description": "the next token for paging", "example": "example" }, { "in": "query", "name": "ship_from_id", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "search_by", "required": false, "schema": { "type": "string", "enum": [ "sku", "title", "fnsku" ] }, "example": "sku" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectAllInventoryResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/inventory": { "get": { "operationId": "get-v3-inventory", "summary": "selectInventory", "description": "List inventory records", "tags": [ "Inventory" ], "parameters": [ { "in": "query", "name": "fulfillment_channel", "required": false, "schema": { "type": [ "string", "null" ], "enum": [ "fba", "sf", "wfs" ], "description": "Channel specific data from various APIs" }, "description": "Channel specific data from various APIs", "example": "fba" }, { "in": "query", "name": "latest", "required": false, "schema": { "type": "boolean", "description": "Only select inventory in the latest report" }, "description": "Only select inventory in the latest report", "example": true }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number", "description": "Only select this number of records" }, "description": "Only select this number of records", "example": 1 }, { "in": "query", "name": "marketplace_id", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "Limit items to this marketplace" }, "description": "Limit items to this marketplace", "example": "az-AE" }, { "in": "query", "name": "country", "required": false, "schema": { "type": "string", "enum": [ "AE", "AU", "BE", "BR", "CA", "CL", "CN", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ], "description": "Limit items to this country across channels (ie. az and wm)" }, "description": "Limit items to this country across channels (ie. az and wm)", "example": "AE" }, { "in": "query", "name": "search", "required": false, "schema": { "type": "string", "description": "Search inventory for matching values keyed by `search_by`" }, "description": "Search inventory for matching values keyed by `search_by`", "example": "example" }, { "in": "query", "name": "search_by", "required": false, "schema": { "type": "string", "enum": [ "sku", "gtin", "upc", "title", "external_id", "asin", "item_id", "fnsku" ], "description": "Search inventory for matching values keyed by `search_by`" }, "description": "Search inventory for matching values keyed by `search_by`", "example": "sku" }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean", "description": "Return inventory tags" }, "description": "Return inventory tags", "example": true }, { "in": "query", "name": "with_data", "required": false, "schema": { "type": "boolean", "description": "Return `data` element" }, "description": "Return `data` element", "example": true }, { "in": "query", "name": "in_stock", "required": false, "schema": { "type": "boolean", "description": "defaults to true, return only inventory with quantity" }, "description": "defaults to true, return only inventory with quantity", "example": true }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "description": "the next token for paging" }, "description": "the next token for paging", "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectInventoryResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-inventory", "summary": "updateInventory", "description": "Update inventory quantities for one or more items", "tags": [ "Inventory" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInventoryParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInventoryResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/location/items": { "get": { "operationId": "get-v3-location-items", "summary": "selectItemsAcrossLocations", "description": "List inventory across warehouse locations", "tags": [ "ItemLocation" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "expires_after", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" }, "example": "example" }, { "in": "query", "name": "expires_before", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" }, "example": "example" }, { "in": "query", "name": "item_location_ids", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "location_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "lot_codes", "required": false, "schema": { "type": "array", "items": { "type": [ "string", "null" ] } }, "example": "example" }, { "in": "query", "name": "ship_from_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "skus", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "with_damaged", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "with_fulfillable", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "with_location_name", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "with_inventory", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean" }, "example": true } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectItemLocationsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/location/transfer": { "patch": { "operationId": "patch-v3-location-transfer", "summary": "transferItemLocations", "description": "Transfer inventory between warehouse locations", "tags": [ "ItemLocation" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferItemLocationsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferItemLocationsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/location/{location_id}/items": { "get": { "operationId": "get-v3-location-{location_id}-items", "summary": "selectItemLocations", "description": "List inventory assigned to a location", "tags": [ "ItemLocation" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "expires_after", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" }, "example": "example" }, { "in": "query", "name": "expires_before", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" }, "example": "example" }, { "in": "query", "name": "item_location_ids", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "lot_codes", "required": false, "schema": { "type": "array", "items": { "type": [ "string", "null" ] } }, "example": "example" }, { "in": "query", "name": "ship_from_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "skus", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "with_damaged", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "with_fulfillable", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "with_location_name", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "with_inventory", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: location_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectItemLocationsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-location-{location_id}-items", "summary": "receiveItemsToLocation", "description": "Receive inventory into a location", "tags": [ "ItemLocation" ], "parameters": [ { "in": "query", "name": "by_intent", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: location_id" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiveItemsToLocationBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiveItemsToLocationResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-location-{location_id}-items", "summary": "updateItemsAtLocation", "description": "Update inventory quantities at a location", "tags": [ "ItemLocation" ], "parameters": [ { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: location_id" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateItemsAtLocationBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateItemsAtLocationResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/label/box": { "get": { "operationId": "get-v3-label-box", "summary": "generateBoxLabels", "description": "Generate labels for shipment boxes", "tags": [ "Label" ], "parameters": [ { "in": "query", "name": "PageType", "required": false, "schema": { "type": "string", "enum": [ "PackageLabel_Letter_2", "PackageLabel_Letter_4", "PackageLabel_Letter_6", "PackageLabel_Letter_6_CarrierLeft", "PackageLabel_A4_2", "PackageLabel_A4_4", "PackageLabel_Plain_Paper", "PackageLabel_Plain_Paper_CarrierBottom", "PackageLabel_Thermal", "PackageLabel_Thermal_Unified", "PackageLabel_Thermal_NonPCP", "PackageLabel_Thermal_No_Carrier_Rotation" ] }, "example": "PackageLabel_Letter_2" }, { "in": "query", "name": "LabelType", "required": false, "schema": { "type": "string", "enum": [ "BARCODE_2D", "UNIQUE", "PALLET" ] }, "example": "BARCODE_2D" }, { "in": "query", "name": "NumberOfPackages", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "NumberOfPallets", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "PageSize", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "PageStartIndex", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "shipmentId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "PackageLabelsToPrint", "required": true, "schema": { "type": "string", "description": "a comma separated list of box ranges (eg. 1-10,20-300)" }, "description": "a comma separated list of box ranges (eg. 1-10,20-300)", "example": "example" }, { "in": "header", "name": "accept", "required": false, "schema": { "type": "string", "enum": [ "application/pdf" ] }, "example": "application/pdf" } ], "security": [ { "BearerAuth": [] } ], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-label-box", "summary": "generateCustomBoxLabels", "description": "Generate custom ScanPower FBA box labels from shipment contents", "tags": [ "Label" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateCustomBoxLabelsParams" } } } }, "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/label/item": { "post": { "operationId": "post-v3-label-item", "summary": "generateItemLabels", "description": "Generate labels for inventory items", "tags": [ "Label" ], "parameters": [ { "in": "header", "name": "accept", "required": false, "schema": { "type": "string", "enum": [ "application/pdf", "text/plain" ] }, "example": "application/pdf" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateItemLabelsParams" } } } }, "responses": { "200": { "description": "if `Accept` header is `application/pdf` then we'll generate a PDF response, otherwise we'll return a data uri string", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/GenerateItemLabelsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/label/pallet": { "post": { "operationId": "post-v3-label-pallet", "summary": "generateCustomPalletLabels", "description": "Generate custom ScanPower FBA pallet labels", "tags": [ "Label" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateCustomPalletLabelsParams" } } } }, "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/qz/sign": { "post": { "operationId": "post-v3-qz-sign", "summary": "signQzRequest", "description": "Sign a QZ Tray printing request", "tags": [ "Label" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignQzRequestParams" } } } }, "responses": { "200": { "description": "base64 SHA512 signature of the supplied request", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/location": { "get": { "operationId": "get-v3-location", "summary": "selectLocations", "description": "List warehouse locations", "tags": [ "Location" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "location_name", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "ship_from_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "with_summary", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "location_ids", "required": false, "schema": { "type": "string", "description": "comma separated list of `location_id`s" }, "description": "comma separated list of `location_id`s", "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectLocationsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-location", "summary": "insertLocations", "description": "Create one or more warehouse locations", "tags": [ "Location" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertLocationsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertLocationsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-location", "summary": "updateLocations", "description": "Update one or more warehouse locations", "tags": [ "Location" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocationsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocationsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/location/{location_id}": { "get": { "operationId": "get-v3-location-{location_id}", "summary": "selectLocation", "description": "Get a location by ID", "tags": [ "Location" ], "parameters": [ { "in": "path", "name": "location_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectLocationResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-location-{location_id}", "summary": "bulkUpdateLocations", "description": "Update a location by ID", "tags": [ "Location" ], "parameters": [ { "in": "path", "name": "location_id", "required": true, "schema": { "type": "string", "description": "comma separated list of `location_id`s" }, "description": "comma separated list of `location_id`s", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateLocationsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocationsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-location-{location_id}", "summary": "deleteLocations", "description": "Delete a location by ID", "tags": [ "Location" ], "parameters": [ { "in": "path", "name": "location_id", "required": true, "schema": { "type": "string", "description": "comma separated list of `location_id`s" }, "description": "comma separated list of `location_id`s", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLocationsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/user": { "get": { "operationId": "get-v3-user", "summary": "selectUsers", "description": "List associated users", "tags": [ "Manage Team" ], "parameters": [ { "in": "query", "name": "active", "required": false, "schema": { "type": "boolean", "description": "Only active sub-users or inactive. Defaults to true" }, "description": "Only active sub-users or inactive. Defaults to true", "example": true }, { "in": "query", "name": "with_ship_froms", "required": false, "schema": { "type": "boolean", "description": "Include ship froms users has access to" }, "description": "Include ship froms users has access to", "example": true }, { "in": "query", "name": "with_clients", "required": false, "schema": { "type": "boolean", "description": "Include clients users users has access to" }, "description": "Include clients users users has access to", "example": true }, { "in": "query", "name": "with_roles", "required": false, "schema": { "type": "boolean", "description": "Include roles users has access to" }, "description": "Include roles users has access to", "example": true } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectUsersResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-user", "summary": "insertUser", "description": "Create a new team member sharing the caller's team", "tags": [ "Manage Team" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/{ user: InsertUserParams }" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertUserResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-user", "summary": "updateUser", "description": "Update a sub-user's information", "tags": [ "Manage Team" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/user/client": { "post": { "operationId": "post-v3-user-client", "summary": "updateUserClients", "description": "Grant or revoke sub-users' access to proxy into one or more clients. Each entry in `user_clients` is a group of `client_ids` x `user_ids` to grant, or to revoke when `deleted` is true; a pair present in both a grant and a revoke group cancels out (no change)", "tags": [ "Manage Team" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserClientsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserClientsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/user/ship-from": { "post": { "operationId": "post-v3-user-ship-from", "summary": "updateUserShipFroms", "description": "Grant or revoke sub-users' access to one or more ship-from addresses. Each entry in `user_ship_froms` is a group of `ship_from_ids` x `user_ids` to grant, or to revoke when `deleted` is true; a pair present in both a grant and a revoke group cancels out (no change)", "tags": [ "Manage Team" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserShipFromsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserShipFromsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/mapping": { "get": { "operationId": "get-v3-mapping", "summary": "selectMappings", "description": "List mappings", "tags": [ "Mapping" ], "parameters": [ { "in": "query", "name": "mapping_type", "required": false, "schema": { "type": "string", "enum": [ "inventory", "product" ] }, "example": "inventory" }, { "in": "query", "name": "marketplace_id", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)" }, "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)", "example": "az-AE" }, { "in": "query", "name": "bundle_id", "required": false, "schema": { "type": [ "string", "null" ], "description": "Set if the input_value refers to a SKU from a bundle" }, "description": "Set if the input_value refers to a SKU from a bundle", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectMappingsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-mapping", "summary": "insertMappings", "description": "Create one or more mappings", "tags": [ "Mapping" ], "parameters": [ { "in": "query", "name": "mapping_type", "required": false, "schema": { "type": "string", "enum": [ "inventory", "product" ] }, "example": "inventory" }, { "in": "query", "name": "marketplace_id", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)" }, "description": "When mapping_type = inventory, this is the external sku, otherwise it is an external id (asin/itemid)", "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertMappingsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertMappingsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-mapping", "summary": "updateMappings", "description": "Update one or more mappings", "tags": [ "Mapping" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMappingsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMappingsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-mapping", "summary": "deleteMappings", "description": "Delete the specified mappings", "tags": [ "Mapping" ], "parameters": [ { "in": "query", "name": "mapping_ids", "required": true, "schema": { "type": "string", "description": "comma separated list of `mapping_id`s" }, "description": "comma separated list of `mapping_id`s", "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMappingsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/pack-template": { "get": { "operationId": "get-v3-pack-template", "summary": "selectPackTemplates", "description": "List pack templates", "tags": [ "Pack Template" ], "parameters": [ { "in": "query", "name": "pack_template_name", "required": false, "schema": { "type": "string", "description": "Usually the same as `user_id` but may be the id of a prep-center" }, "description": "Usually the same as `user_id` but may be the id of a prep-center", "example": "example" }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "pack_template_ids", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "with_items", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "skus", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "pack templates by the skus they contain" }, "description": "pack templates by the skus they contain", "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPackTemplatesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-pack-template", "summary": "insertPackTemplates", "description": "Create pack templates", "tags": [ "Pack Template" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertPackTemplatesParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertPackTemplatesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/pack-template/{pack_template_id}": { "get": { "operationId": "get-v3-pack-template-{pack_template_id}", "summary": "selectPackTemplate", "description": "Get a pack template by ID", "tags": [ "Pack Template" ], "parameters": [ { "name": "pack_template_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: pack_template_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPackTemplateResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-pack-template-{pack_template_id}", "summary": "updatePackTemplates", "description": "Update a pack template by ID", "tags": [ "Pack Template" ], "parameters": [ { "name": "pack_template_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: pack_template_id" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePackTemplateBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePackTemplateResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-pack-template-{pack_template_id}", "summary": "deletePackTemplates", "description": "Delete a pack template by ID", "tags": [ "Pack Template" ], "parameters": [ { "name": "pack_template_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: pack_template_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePackTemplatesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/pack-template/{pack_template_id}/items": { "get": { "operationId": "get-v3-pack-template-{pack_template_id}-items", "summary": "selectPackTemplateItems", "description": "Get pack template items by pack template ID", "tags": [ "Pack Template" ], "parameters": [ { "name": "pack_template_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: pack_template_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPackTemplateItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-pack-template-{pack_template_id}-items", "summary": "insertPackTemplateItems", "description": "Add items to a pack template", "tags": [ "Pack Template" ], "parameters": [ { "name": "pack_template_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: pack_template_id" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertPackTemplateItemBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertPackTemplateItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-pack-template-{pack_template_id}-items", "summary": "updatePackTemplateItems", "description": "Update items in a pack template", "tags": [ "Pack Template" ], "parameters": [ { "name": "pack_template_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: pack_template_id" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePackTemplateItemsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePackTemplateItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-pack-template-{pack_template_id}-items", "summary": "deletePackTemplateItems", "description": "Delete items from a pack template", "tags": [ "Pack Template" ], "parameters": [ { "in": "query", "name": "skus", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "name": "pack_template_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: pack_template_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePackTemplateItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/plan": { "get": { "operationId": "get-v3-plan", "summary": "selectPlans", "description": "List plans", "tags": [ "Plan" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "archived", "required": false, "schema": { "type": [ "boolean", "null" ], "description": "pass `&archived` to only search archived plans" }, "description": "pass `&archived` to only search archived plans", "example": true }, { "in": "query", "name": "plan_id", "required": false, "schema": { "type": "string", "description": "Select a specific plan by id" }, "description": "Select a specific plan by id", "example": "123" }, { "in": "query", "name": "plan_name", "required": false, "schema": { "type": "string", "description": "Search by plan name prefix" }, "description": "Search by plan name prefix", "example": "example" }, { "in": "query", "name": "creation_source", "required": false, "schema": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ], "description": "Limit to specific creation source" }, "description": "Limit to specific creation source", "example": "api" }, { "in": "query", "name": "statuses", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "add_tracking", "confirming_placement", "confirming_transportation", "created", "pack_error", "packed", "packing", "placement_confirmed", "placement_error", "plan_cancelled", "planned", "prepping", "received", "shipped", "transportation_confirmed", "transportation_error", "working" ] }, "description": "Limit to plans in any of the given statuses" }, "description": "Limit to plans in any of the given statuses", "example": "example" }, { "in": "query", "name": "with_shipments", "required": false, "schema": { "type": "boolean", "description": "pass `true` to only return plans that already have shipments, `false` excludes plans that already have shipments, omit to include all plans with or without shipments" }, "description": "pass `true` to only return plans that already have shipments, `false` excludes plans that already have shipments, omit to include all plans with or without shipments", "example": true }, { "in": "query", "name": "with_shipment_ids", "required": false, "schema": { "type": "boolean", "description": "pass `true` to include `wm_shipment_ids`/`az_shipment_ids` for each plan" }, "description": "pass `true` to include `wm_shipment_ids`/`az_shipment_ids` for each plan", "example": true }, { "in": "query", "name": "with_placement_options", "required": false, "schema": { "type": "boolean", "description": "pass `true` to include `az_shipments` with placement option fees and destination for each az shipment" }, "description": "pass `true` to include `az_shipments` with placement option fees and destination for each az shipment", "example": true }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number", "description": "Limit the number of results" }, "description": "Limit the number of results", "example": 1 }, { "in": "query", "name": "ship_from_id", "required": false, "schema": { "type": "string", "description": "Limit to a specific ship_from_id" }, "description": "Limit to a specific ship_from_id", "example": "123" }, { "in": "query", "name": "with_items", "required": false, "schema": { "type": "boolean", "description": "when selecting a single plan by `plan_id`, pass `true` to include plan items in the response" }, "description": "when selecting a single plan by `plan_id`, pass `true` to include plan items in the response", "example": true }, { "in": "query", "name": "with_ship_from", "required": false, "schema": { "type": "boolean", "description": "return a ship_from object" }, "description": "return a ship_from object", "example": true }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean", "description": "pass `true` to include `tags` for each plan" }, "description": "pass `true` to include `tags` for each plan", "example": true } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPlansResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-plan", "summary": "insertPlans", "description": "Create one or more plans", "tags": [ "Plan" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertPlansParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertPlansResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/plan/{plan_id}": { "get": { "operationId": "get-v3-plan-{plan_id}", "summary": "selectPlan", "description": "Get a plan by ID", "tags": [ "Plan" ], "parameters": [ { "in": "path", "name": "plan_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPlanResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-plan-{plan_id}", "summary": "generateMarketplacePlan", "description": "Generate a marketplace plan from the plan data", "tags": [ "Plan" ], "parameters": [ { "name": "plan_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: plan_id" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateMarketplacePlanBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateMarketplacePlanResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-plan-{plan_id}", "summary": "updatePlans", "description": "Update a plan by ID", "tags": [ "Plan" ], "parameters": [ { "in": "path", "name": "plan_id", "required": true, "schema": { "type": "string", "description": "A comma separated list of `plan_id`s, eg. `123,456`" }, "description": "A comma separated list of `plan_id`s, eg. `123,456`", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePlan" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePlansResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-plan-{plan_id}", "summary": "deletePlans", "description": "Delete a plan by ID", "tags": [ "Plan" ], "parameters": [ { "in": "query", "name": "put_back", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "path", "name": "plan_id", "required": true, "schema": { "type": "string", "description": "A comma separated list of `plan_id`s, eg. `123,456`" }, "description": "A comma separated list of `plan_id`s, eg. `123,456`", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePlansResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/plan/import": { "post": { "operationId": "post-v3-plan-import", "summary": "importIntoPlan", "description": "Import items into an existing plan", "tags": [ "Plan" ], "parameters": [ { "in": "query", "name": "plan_id", "required": false, "schema": { "type": "string", "description": "pass `plan_id` to add items to an existing plan" }, "description": "pass `plan_id` to add items to an existing plan", "example": "123" }, { "in": "query", "name": "plan_name", "required": false, "schema": { "type": "string", "description": "pass `plan_name`, `marketplace_id`, and `ship_from_id` to create a new plan" }, "description": "pass `plan_name`, `marketplace_id`, and `ship_from_id` to create a new plan", "example": "example" }, { "in": "query", "name": "ship_from_id", "required": false, "schema": { "type": "string", "description": "pass `plan_name`, `marketplace_id`, and `ship_from_id` to create a new plan" }, "description": "pass `plan_name`, `marketplace_id`, and `ship_from_id` to create a new plan", "example": "123" }, { "in": "query", "name": "location_id", "required": false, "schema": { "type": [ "string", "null" ], "description": "optionally pass this when creating a new plan" }, "description": "optionally pass this when creating a new plan", "example": "123" }, { "in": "query", "name": "delivery_date", "required": false, "schema": { "type": "string", "description": "required if generating plan for WM" }, "description": "required if generating plan for WM", "example": "example" }, { "in": "query", "name": "creation_source", "required": false, "schema": { "type": "string", "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "example": "api" }, { "in": "query", "name": "fulfillment_channel", "required": false, "schema": { "type": "string", "enum": [ "fba", "sf", "wfs" ] }, "example": "fba" }, { "in": "query", "name": "email", "required": false, "schema": { "type": "string", "description": "override sourceAddress.email when creating AZ inbound plans" }, "description": "override sourceAddress.email when creating AZ inbound plans", "example": "user@example.com" }, { "in": "query", "name": "name", "required": false, "schema": { "type": "string", "description": "override sourceAddress.name when creating AZ inbound plans" }, "description": "override sourceAddress.name when creating AZ inbound plans", "example": "name" }, { "in": "query", "name": "phoneNumber", "required": false, "schema": { "type": "string", "description": "override sourceAddress.phoneNumber when creating AZ inbound plans" }, "description": "override sourceAddress.phoneNumber when creating AZ inbound plans", "example": "example" }, { "in": "query", "name": "flow", "required": false, "schema": { "type": [ "string", "null" ], "enum": [ "pack_first", "pack_later" ], "description": "override sourceAddress.phoneNumber when creating AZ inbound plans" }, "description": "override sourceAddress.phoneNumber when creating AZ inbound plans", "example": "pack_first" }, { "in": "query", "name": "customPlacement", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "warehouseId": { "type": "string" }, "mskus": { "type": "array", "items": { "type": "string" } } }, "required": [ "warehouseId", "mskus" ] } }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "pass `plan_name`, `marketplace_id`, and `ship_from_id` to create a new plan" }, "description": "pass `plan_name`, `marketplace_id`, and `ship_from_id` to create a new plan", "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportIntoPlanBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportIntoPlanResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/plan/verify": { "post": { "operationId": "post-v3-plan-verify", "summary": "validateItems", "description": "Validate that items can be added to a plan", "tags": [ "Plan" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateItemsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/plan/{plan_id}/item": { "get": { "operationId": "get-v3-plan-{plan_id}-item", "summary": "selectPlanItems", "description": "List items belonging to a plan", "tags": [ "Plan" ], "parameters": [ { "in": "query", "name": "plan_item_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean", "description": "true to include tags for each plan item" }, "description": "true to include tags for each plan item", "example": true }, { "in": "query", "name": "with_prep_matrices", "required": false, "schema": { "type": "boolean", "description": "true to return `prep_matrices` for each plan item" }, "description": "true to return `prep_matrices` for each plan item", "example": true }, { "in": "query", "name": "with_bundles", "required": false, "schema": { "type": "boolean", "description": "true to return `bundles` whose output matches this item's sku/marketplace" }, "description": "true to return `bundles` whose output matches this item's sku/marketplace", "example": true }, { "in": "path", "name": "plan_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPlanItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-plan-{plan_id}-item", "summary": "insertPlanItems", "description": "Add one or more items to a plan", "tags": [ "Plan" ], "parameters": [ { "in": "query", "name": "creation_source", "required": false, "schema": { "type": [ "string", "null" ], "enum": [ "api", "import", "manual", "purchase_order", "spreadsheet" ] }, "example": "api" }, { "in": "path", "name": "plan_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertPlanItemsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertPlanItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-plan-{plan_id}-item", "summary": "updatePlanItems", "description": "Update items belonging to a plan", "tags": [ "Plan" ], "parameters": [ { "in": "path", "name": "plan_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePlanItemsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePlanItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/plan/{plan_id}/item/{plan_item_id}": { "get": { "operationId": "get-v3-plan-{plan_id}-item-{plan_item_id}", "summary": "selectPlanItem", "description": "Get a plan item by ID", "tags": [ "Plan" ], "parameters": [ { "in": "path", "name": "plan_id", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "path", "name": "plan_item_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPlanItemResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-plan-{plan_id}-item-{plan_item_id}", "summary": "updatePlanItem", "description": "Update a plan item by ID", "tags": [ "Plan" ], "parameters": [ { "in": "path", "name": "plan_id", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "path", "name": "plan_item_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePlanItemBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePlanItemResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-plan-{plan_id}-item-{plan_item_id}", "summary": "deletePlanItems", "description": "Delete a plan item by ID", "tags": [ "Plan" ], "parameters": [ { "in": "path", "name": "plan_id", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "path", "name": "plan_item_id", "required": true, "schema": { "type": "string", "description": "comma separated list of `plan_item_id`s, eg. `123,456`" }, "description": "comma separated list of `plan_item_id`s, eg. `123,456`", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePlanItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/purchase-order": { "get": { "operationId": "get-v3-purchase-order", "summary": "selectPurchaseOrders", "description": "List purchase orders", "tags": [ "Purchase Order" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "purchase_order_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "purchase_order_name", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "external_id", "required": false, "schema": { "type": [ "string", "null" ], "description": "A user-provided external identifier for the purchase order" }, "description": "A user-provided external identifier for the purchase order", "example": "123" }, { "in": "query", "name": "ship_from_id", "required": false, "schema": { "type": "string", "description": "The ID of the supplier." }, "description": "The ID of the supplier.", "example": "123" }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "with_summary", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "wfs", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPurchaseOrdersResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-purchase-order", "summary": "insertPurchaseOrders", "description": "Create one or more purchase orders", "tags": [ "Purchase Order" ], "parameters": [ { "in": "query", "name": "create_listings", "required": false, "schema": { "type": "boolean", "description": "for new marketplace SKUs, automatically initiate the process of creating listings" }, "description": "for new marketplace SKUs, automatically initiate the process of creating listings", "example": true }, { "in": "query", "name": "convert", "required": false, "schema": { "type": "boolean", "description": "for any seller fulfilled SKUs, convert them to be Walmart or Amazon fulfilled" }, "description": "for any seller fulfilled SKUs, convert them to be Walmart or Amazon fulfilled", "example": true } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertPurchaseOrdersBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertPurchaseOrdersResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/purchase-order/{purchase_order_id}": { "get": { "operationId": "get-v3-purchase-order-{purchase_order_id}", "summary": "selectPurchaseOrder", "description": "Get a purchase order by ID", "tags": [ "Purchase Order" ], "parameters": [ { "name": "purchase_order_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: purchase_order_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPurchaseOrderResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-purchase-order-{purchase_order_id}", "summary": "bulkUpdatePurchaseOrders", "description": "Update a purchase order by ID", "tags": [ "Purchase Order" ], "parameters": [ { "in": "path", "name": "purchase_order_id", "required": true, "schema": { "type": "string", "description": "comma separated list of `purchase_order_id`s" }, "description": "comma separated list of `purchase_order_id`s", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdatePurchaseOrdersBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdatePurchaseOrdersResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-purchase-order-{purchase_order_id}", "summary": "deletePurchaseOrders", "description": "Delete a purchase order by ID", "tags": [ "Purchase Order" ], "parameters": [ { "in": "path", "name": "purchase_order_id", "required": true, "schema": { "type": "string", "description": "comma separated list of `purchase_order_id`s" }, "description": "comma separated list of `purchase_order_id`s", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePurchaseOrdersResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/purchase-order/{purchase_order_id}/items": { "get": { "operationId": "get-v3-purchase-order-{purchase_order_id}-items", "summary": "selectPurchaseOrderItems", "description": "List items belonging to a purchase order", "tags": [ "Purchase Order" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "search", "required": false, "schema": { "type": "string", "description": "Search items for matching values keyed by `search_by`" }, "description": "Search items for matching values keyed by `search_by`", "example": "example" }, { "in": "query", "name": "search_by", "required": false, "schema": { "type": "string", "enum": [ "sku", "gtin" ], "description": "Search items for matching values keyed by `search_by`" }, "description": "Search items for matching values keyed by `search_by`", "example": "sku" }, { "name": "purchase_order_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: purchase_order_id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPurchaseOrderItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-purchase-order-{purchase_order_id}-items", "summary": "insertPurchaseOrderItems", "description": "Add items to a purchase order", "tags": [ "Purchase Order" ], "parameters": [ { "in": "query", "name": "purchased", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "example" }, { "name": "purchase_order_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: purchase_order_id" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertPurchaseOrderItemsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePurchaseOrderItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-purchase-order-{purchase_order_id}-items", "summary": "updatePurchaseOrderItems", "description": "Update items belonging to a purchase order", "tags": [ "Purchase Order" ], "parameters": [ { "in": "query", "name": "purchased", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "example" }, { "in": "query", "name": "ledger_entry_type", "required": false, "schema": { "type": "string", "enum": [ "PO_CREATED", "PO_RECEIPT_ADJUSTED", "PO_RECEIVED" ] }, "example": "PO_CREATED" }, { "name": "purchase_order_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: purchase_order_id" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePurchaseOrderItemsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePurchaseOrderItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-purchase-order-{purchase_order_id}-items", "summary": "deletePurchaseOrderItems", "description": "Delete items from a purchase order", "tags": [ "Purchase Order" ], "parameters": [ { "in": "query", "name": "purchase_order_item_ids", "required": true, "schema": { "type": "string", "description": "comma separated list of `purchase_order_item_id`s" }, "description": "comma separated list of `purchase_order_item_id`s", "example": "example" }, { "in": "path", "name": "purchase_order_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePurchaseOrderItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/report": { "get": { "operationId": "get-v3-report", "summary": "selectReports", "description": "List generated reports", "tags": [ "Report" ], "parameters": [ { "in": "query", "name": "marketplace_id", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "report_type", "required": false, "schema": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] }, "example": "example" }, { "in": "query", "name": "status", "required": false, "schema": { "oneOf": [ { "type": "string", "enum": [ "WAIT", "PREPARING", "QUEUEING", "SUBMITTED", "IN_PROGRESS", "CANCELLED", "DONE", "DONE_NO_DATA", "ERROR", "FATAL" ] }, { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ] } ] }, "example": "example" }, { "in": "query", "name": "created_after", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "example" }, { "in": "query", "name": "created_before", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "example" }, { "in": "query", "name": "id", "required": false, "schema": { "oneOf": [ { "type": "string" }, { "type": "string", "description": "System-generated ID that uniquely identifies the report request." } ] }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectReportsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-report", "summary": "createReport", "description": "Request a new report from Amazon or Walmart. Omit `mp` and `report_type` params to sync all inventory reports across marketplaces", "tags": [ "Report" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "report_type", "required": false, "schema": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "put": { "operationId": "put-v3-report", "summary": "uploadReportFile", "description": "Upload an existing report file. The body is actually raw CSV/TSV, not json like the generated docs imply.", "tags": [ "Report" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "reportType", "required": true, "schema": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] }, "example": "example" }, { "in": "query", "name": "reportId", "required": false, "schema": { "type": "string", "description": "required for AZ reports" }, "description": "required for AZ reports", "example": "123" }, { "in": "query", "name": "requestId", "required": false, "schema": { "type": "string", "description": "required for WM reports" }, "description": "required for WM reports", "example": "123" }, { "in": "query", "name": "bg", "required": false, "schema": { "type": "boolean", "description": "pass to return immediately without waiting for rows to actually save, useful for large files that may time out" }, "description": "pass to return immediately without waiting for rows to actually save, useful for large files that may time out", "example": true } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadReportBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadReportFileResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-report", "summary": "saveReport", "description": "When a report is finished, it gets PATCHed here and we then save the data", "tags": [ "Report" ], "parameters": [ { "in": "query", "name": "bg", "required": false, "schema": { "type": "boolean", "description": "if true, `saveReport` will return immediately without waiting for the rows to save (they will be saved in the background)" }, "description": "if true, `saveReport` will return immediately without waiting for the rows to save (they will be saved in the background)", "example": true }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveReportBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveReportResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/report/{requestId}": { "put": { "operationId": "put-v3-report-{requestId}", "summary": "reSaveReport", "description": "", "tags": [ "Report" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: requestId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/report/latest": { "get": { "operationId": "get-v3-report-latest", "summary": "latestReports", "description": "Get the time of the most recent report as well as when it can be requested again for each report type", "tags": [ "Report" ], "parameters": [ { "in": "query", "name": "since", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "example" }, { "in": "query", "name": "marketplace_id", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "report_type", "required": false, "schema": { "oneOf": [ { "type": "string", "enum": [ "GET_MERCHANT_LISTINGS_DATA", "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2", "GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA", "GET_STRANDED_INVENTORY_UI_DATA", "GET_FBA_INVENTORY_PLANNING_DATA" ] }, { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ] } ] }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LatestReportsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/seller": { "get": { "operationId": "get-v3-seller", "summary": "selectSeller", "description": "Get marketplace seller account", "tags": [ "Seller" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectSellerResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/settings": { "get": { "operationId": "get-v3-settings", "summary": "selectSettings", "description": "Get settings", "tags": [ "Settings" ], "parameters": [ { "in": "query", "name": "mine", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "key", "required": false, "schema": { "type": "string", "enum": [ "accept_first_packing_option", "box_label_include_ship_from", "box_label_orientation", "box_label_single_sku_box_include_fnsku_barcode", "box_label_single_sku_box_include_sku", "box_label_single_sku_box_include_sold_as_set", "box_label_type", "fnsku_label_template", "selected_marketplace_country", "selected_marketplace_id", "selected_ship_from_id", "sourceAddress_email", "sourceAddress_name", "sourceAddress_phoneNumber", "use_my_webhook", "zero_quantity" ] }, "example": "accept_first_packing_option" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settings" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-settings", "summary": "updateSettings", "description": "Update settings", "tags": [ "Settings" ], "parameters": [ { "in": "query", "name": "client_id", "required": false, "schema": { "type": "string", "description": "if provided, update the setting at the client-level" }, "description": "if provided, update the setting at the client-level", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settings" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settings" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-settings", "summary": "deleteSettings", "description": "Delete settings", "tags": [ "Settings" ], "parameters": [ { "in": "query", "name": "client_id", "required": false, "schema": { "type": "string", "description": "if provided, delete the setting at the client-level" }, "description": "if provided, delete the setting at the client-level", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settings" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/ship-from": { "get": { "operationId": "get-v3-ship-from", "summary": "selectShipFroms", "description": "List ship-from addresses", "tags": [ "Ship From" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "with_prep_center_name", "required": false, "schema": { "type": "boolean", "description": "If true, ship_from name becomes \":prepCenterName Attn: :clientName\", otherwise just \":clientName\" for prep centers and clients." }, "description": "If true, ship_from name becomes \":prepCenterName Attn: :clientName\", otherwise just \":clientName\" for prep centers and clients.", "example": true }, { "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean", "description": "If true, return only archived, if false, return non-archived, and if omitted, return all" }, "description": "If true, return only archived, if false, return non-archived, and if omitted, return all", "example": true }, { "in": "query", "name": "ship_from_id", "required": false, "schema": { "type": "string", "description": "If provided, returns only the matching row regardless of archived status" }, "description": "If provided, returns only the matching row regardless of archived status", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectShipFromsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-ship-from", "summary": "insertShipFrom", "description": "Create a new ship-from address", "tags": [ "Ship From" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertShipFromBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertShipFromRouteResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/ship-from/{ship_from_id}": { "get": { "operationId": "get-v3-ship-from-{ship_from_id}", "summary": "selectShipFrom", "description": "Get a ship-from address by ID", "tags": [ "Ship From" ], "parameters": [ { "in": "path", "name": "ship_from_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectShipFromResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-ship-from-{ship_from_id}", "summary": "updateShipFrom", "description": "Update a ship-from address by ID", "tags": [ "Ship From" ], "parameters": [ { "in": "path", "name": "ship_from_id", "required": true, "schema": { "type": "string" }, "example": "123" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShipFromBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShipFromRouteResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/ship-from/find": { "post": { "operationId": "post-v3-ship-from-find", "summary": "findShipFrom", "description": "Attempt to find an existing ship from record given an address object", "tags": [ "Ship From" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindShipFromParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindShipFromResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/shipment": { "get": { "operationId": "get-v3-shipment", "summary": "selectShipments", "description": "List shipments across marketplaces", "tags": [ "Shipment" ], "parameters": [ { "in": "query", "name": "inboundPlanId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "shipmentId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "shipmentConfirmationId", "required": false, "schema": { "type": [ "string", "null" ] }, "example": "123" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectShipmentsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/supplier": { "get": { "operationId": "get-v3-supplier", "summary": "selectSuppliers", "description": "List suppliers", "tags": [ "Supplier" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "supplier_ids", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "supplier_name", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectSuppliersResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-supplier", "summary": "insertSuppliers", "description": "Create one or more suppliers", "tags": [ "Supplier" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertSuppliersParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertSuppliersResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-supplier", "summary": "updateSuppliers", "description": "Update one or more suppliers", "tags": [ "Supplier" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSuppliersParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSuppliersResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-supplier", "summary": "archiveSuppliers", "description": "Archive one or more suppliers", "tags": [ "Supplier" ], "parameters": [ { "in": "query", "name": "supplier_ids", "required": true, "schema": { "type": "string", "description": "comma separated list of `supplier_id`s" }, "description": "comma separated list of `supplier_id`s", "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveSuppliersResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/tag": { "get": { "operationId": "get-v3-tag", "summary": "selectTags", "description": "List tags", "tags": [ "Tag" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "tag_ids", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "tag_name", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "tag_types", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "az_box", "az_pallet", "az_shipment", "inventory", "plan", "plan_item", "product", "purchase_order", "purchase_order_item", "wm_box", "wm_pallet", "wm_shipment" ] } }, "example": "example" }, { "in": "query", "name": "uri", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectTagsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-tag", "summary": "insertTags", "description": "Create one or more tags", "tags": [ "Tag" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertTagsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertTagsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-tag", "summary": "updateTags", "description": "Update one or more tags", "tags": [ "Tag" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTagsParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTagsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-tag", "summary": "deleteTags", "description": "Delete the specified tags", "tags": [ "Tag" ], "parameters": [ { "in": "query", "name": "tag_ids", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTagsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/health": { "get": { "operationId": "get-v3-health", "summary": "healthCheck", "description": "Check whether the API is healthy and responding", "tags": [ "V3" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/prep-matrix": { "get": { "operationId": "get-v3-prep-matrix", "summary": "selectPrepMatrices", "description": "List prep matrix entries", "tags": [ "V3" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-prep-matrix", "summary": "selectPrepMatricesPost", "description": "List prep matrix entries", "tags": [ "V3" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "put": { "operationId": "put-v3-prep-matrix", "summary": "insertPrepMatrices", "description": "Create or update prep matrix entries", "tags": [ "V3" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm_hook": { "get": { "operationId": "get-v3-wm_hook", "summary": "", "description": "", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-wm_hook", "summary": "", "description": "", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "put": { "operationId": "put-v3-wm_hook", "summary": "", "description": "", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-wm_hook", "summary": "", "description": "", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-wm_hook", "summary": "", "description": "", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/ws": { "get": { "operationId": "get-v3-ws", "summary": "", "description": "", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/attachment/{attachment_id}": { "get": { "operationId": "get-v3-attachment-{attachment_id}", "summary": "getAttachment", "description": "Get an attachment by ID", "tags": [ "V3" ], "parameters": [ { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: attachment_id" } ], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/quickbooks/invoices": { "get": { "operationId": "get-v3-quickbooks-invoices", "summary": "getQuickbooksInvoiceNumbers", "description": "Get the next available QuickBooks invoice number", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-quickbooks-invoices", "summary": "createQuickbooksInvoices", "description": "Create QuickBooks invoice drafts from billing rows", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/quickbooks/jobs": { "get": { "operationId": "get-v3-quickbooks-jobs", "summary": "listQuickbooksJobs", "description": "List QuickBooks billing jobs", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/quickbooks/oauth": { "get": { "operationId": "get-v3-quickbooks-oauth", "summary": "quickbooksOauth", "description": "Start or complete the QuickBooks OAuth connection flow", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/quickbooks/preview": { "post": { "operationId": "post-v3-quickbooks-preview", "summary": "previewQuickbooksBilling", "description": "Preview QuickBooks billing invoices before creation", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/quickbooks/status": { "get": { "operationId": "get-v3-quickbooks-status", "summary": "getQuickbooksStatus", "description": "Check whether QuickBooks is connected for the current user", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/user/role": { "get": { "operationId": "get-v3-user-role", "summary": "", "description": "", "tags": [ "V3" ], "parameters": [], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-user-role", "summary": "updateUserRoles", "description": "Grant or revoke sub-users' roles. Each entry in `user_roles` is a group of `role_ids` x `user_ids` to grant, or to revoke when `deleted` is true; a pair present in both a grant and a revoke group cancels out (no change)", "tags": [ "Manage Team" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRolesParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRolesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm-shipment/{shipment_id}/box": { "get": { "operationId": "get-v3-wm-shipment-{shipment_id}-box", "summary": "listWmShipmentBoxes", "description": "List boxes belonging to a Walmart shipment", "tags": [ "V3" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-wm-shipment-{shipment_id}-box", "summary": "createWmShipmentBoxes", "description": "Create boxes for a Walmart shipment", "tags": [ "V3" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-wm-shipment-{shipment_id}-box", "summary": "updateWmShipmentBoxes", "description": "Update boxes belonging to a Walmart shipment", "tags": [ "V3" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm-shipment/{shipment_id}/pallet": { "get": { "operationId": "get-v3-wm-shipment-{shipment_id}-pallet", "summary": "listWmShipmentPallets", "description": "List pallets belonging to a Walmart shipment", "tags": [ "V3" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-wm-shipment-{shipment_id}-pallet", "summary": "createWmShipmentPallets", "description": "Create pallets for a Walmart shipment", "tags": [ "Walmart Shipment" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertWmPalletsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertWmPalletsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-wm-shipment-{shipment_id}-pallet", "summary": "updateWmShipmentPallets", "description": "Update pallets belonging to a Walmart shipment", "tags": [ "Walmart Shipment" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWmPalletsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWmPalletsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm-shipment/{shipment_id}/box/{box_id}": { "get": { "operationId": "get-v3-wm-shipment-{shipment_id}-box-{box_id}", "summary": "getWmShipmentBox", "description": "Get a Walmart shipment box by ID", "tags": [ "V3" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" }, { "name": "box_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: box_id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-wm-shipment-{shipment_id}-box-{box_id}", "summary": "deleteWmShipmentBox", "description": "Delete a Walmart shipment box by ID", "tags": [ "V3" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" }, { "name": "box_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: box_id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm-shipment/{shipment_id}/pallet/{pallet_id}": { "get": { "operationId": "get-v3-wm-shipment-{shipment_id}-pallet-{pallet_id}", "summary": "getWmShipmentPallet", "description": "Get a Walmart shipment pallet by ID", "tags": [ "V3" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" }, { "name": "pallet_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: pallet_id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-wm-shipment-{shipment_id}-pallet-{pallet_id}", "summary": "deleteWmShipmentPallet", "description": "Delete a Walmart shipment pallet by ID", "tags": [ "V3" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" }, { "name": "pallet_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: pallet_id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm-shipment": { "get": { "operationId": "get-v3-wm-shipment", "summary": "selectWmShipments", "description": "List Walmart shipments", "tags": [ "Walmart Shipment" ], "parameters": [ { "in": "query", "name": "next", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "shipment_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "inbound_order_id", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "ship_from_id", "required": false, "schema": { "type": "number" }, "example": 123 }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number" }, "example": 1 }, { "in": "query", "name": "with_tags", "required": false, "schema": { "type": "boolean" }, "example": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectWmShipmentsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm-shipment/{shipment_id}": { "get": { "operationId": "get-v3-wm-shipment-{shipment_id}", "summary": "selectWmShipment", "description": "Get a Walmart shipment by ID", "tags": [ "Walmart Shipment" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectWmShipmentResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "patch": { "operationId": "patch-v3-wm-shipment-{shipment_id}", "summary": "updateWmShipment", "description": "Update a Walmart shipment by ID", "tags": [ "Walmart Shipment" ], "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: shipment_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWmShipment" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectWmShipmentResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/token": { "post": { "operationId": "post-v3-wm-v3-token", "summary": "tokenAPI", "description": "Thin wrapper around Walmart's [tokenAPI](https://developer.walmart.com/us-marketplace/reference/tokenapi)", "tags": [ "Walmart/Auth" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "description": "The marketplace id" }, "description": "The marketplace id", "example": "example" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenApiBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenApiResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/feeds": { "get": { "operationId": "get-v3-wm-v3-feeds", "summary": "getAllFeedStatuses", "description": "Thin wrapper around Walmart's [All feed statuses](https://developer.walmart.com/us-marketplace/reference/getallfeedstatuses) API", "tags": [ "Walmart/Feed" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "feedId", "required": true, "schema": { "type": "string", "description": "A unique ID returned from the Bulk Upload API, used for tracking the feed file. Special characters must be URL-escaped" }, "description": "A unique ID returned from the Bulk Upload API, used for tracking the feed file. Special characters must be URL-escaped", "example": "123" }, { "in": "query", "name": "offset", "required": true, "schema": { "type": "number", "description": "Zero-based index for pagination of detailed results." }, "description": "Zero-based index for pagination of detailed results.", "example": 1 }, { "in": "query", "name": "limit", "required": true, "schema": { "type": "number", "description": "Maximum number of entities to return per page. Defaults to 50. Cannot be greater than 50." }, "description": "Maximum number of entities to return per page. Defaults to 50. Cannot be greater than 50.", "example": 1 } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllFeedStatusesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-wm-v3-feeds", "summary": "submitFeeds", "description": "Thin wrapper around Walmart's [Feeds](https://developer.walmart.com/us-marketplace/reference/itembulkuploads) API with the ability to queue up multiple feeds for sequential processing.", "tags": [ "Walmart/Feed" ], "parameters": [ { "in": "query", "name": "zeroSfQuantity", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitFeedsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitFeedResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/json_schema/{feed_type}/{category}": { "get": { "operationId": "get-v3-wm-json_schema-{feed_type}-{category}", "summary": "selectSchemaData", "description": "Grab relevant portions of the WM schema", "tags": [ "Walmart/Feed" ], "parameters": [ { "in": "query", "name": "feed_type_version", "required": false, "schema": { "type": "string" }, "example": "example" }, { "name": "feed_type", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: feed_type" }, { "name": "category", "in": "path", "required": true, "schema": { "type": "string" }, "example": "example", "description": "Path parameter: category" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectSchemaDataResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/feeds/{feedId}": { "get": { "operationId": "get-v3-wm-v3-feeds-{feedId}", "summary": "getFeedItemStatus", "description": "Thin wrapper around Walmart's [Feed item status](https://developer.walmart.com/us-marketplace/reference/getfeeditemstatus) API", "tags": [ "Walmart/Feed" ], "parameters": [ { "in": "query", "name": "includeDetails", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "offset", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "feedType", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "price" ] }, { "type": "string", "enum": [ "inventory" ] }, { "type": "string", "enum": [ "MP_ITEM_MATCH" ] }, { "type": "string", "enum": [ "MP_ITEM" ] }, { "type": "string", "enum": [ "PRICE_AND_PROMOTION" ] }, { "type": "string", "enum": [ "OMNI_WFS" ] } ] }, "example": "example" }, { "in": "query", "name": "saveAllItems", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "feedId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: feedId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFeedItemStatusResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/inventory": { "get": { "operationId": "get-v3-wm-v3-inventory", "summary": "getInventory", "description": "Thin wrapper around Walmart's [Inventory](https://developer.walmart.com/us-marketplace/reference/getinventory) API", "tags": [ "Walmart/Inventory" ], "parameters": [ { "in": "query", "name": "sku", "required": true, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "shipNode", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInventoryResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "put": { "operationId": "put-v3-wm-v3-inventory", "summary": "updateInventory", "description": "Thin wrapper around Walmart's [Update inventory](https://developer.walmart.com/us-marketplace/reference/updateinventoryforanitem) API", "tags": [ "Walmart/Inventory" ], "parameters": [ { "in": "query", "name": "sku", "required": false, "schema": { "type": "string" }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInventoryBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInventoryResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/wfs/inventory": { "get": { "operationId": "get-v3-wm-v3-wfs-inventory", "summary": "getWfsInventoryDetails", "description": "Thin wrapper around Walmart's [WFS inventory](https://developer.walmart.com/us-marketplace/reference/getwfsinventorydetails) API", "tags": [ "Walmart/Inventory" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "number", "description": "Defaults to 0" }, "description": "Defaults to 0", "example": 1 }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number", "description": "Defaults to 10" }, "description": "Defaults to 10", "example": 1 }, { "in": "query", "name": "sku", "required": false, "schema": { "type": "string", "description": "Defaults to 10" }, "description": "Defaults to 10", "example": "example" }, { "in": "query", "name": "gtin", "required": false, "schema": { "type": "string" }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWfsInventoryDetailsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/items/{id}": { "get": { "operationId": "get-v3-wm-v3-items-{id}", "summary": "getAnItem", "description": "Thin wrapper around Walmart's [An item](https://developer.walmart.com/us-marketplace/reference/getanitem) API", "tags": [ "Walmart/Item" ], "parameters": [ { "in": "query", "name": "id", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "productIdType", "required": true, "schema": { "type": "string", "enum": [ "EAN", "GTIN", "ISBN", "SKU", "ITEM_ID" ] }, "example": "EAN" }, { "in": "query", "name": "condition", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "New" ] }, { "type": "string", "enum": [ "New with defects" ] }, { "type": "string", "enum": [ "New without box" ] }, { "type": "string", "enum": [ "New without tags" ] }, { "type": "string", "enum": [ "Open Box" ] }, { "type": "string", "enum": [ "Pre-Owned: Fair" ] }, { "type": "string", "enum": [ "Pre-Owned: Good" ] }, { "type": "string", "enum": [ "Pre-Owned: Like New" ] }, { "type": "string", "enum": [ "Remanufactured" ] }, { "type": "string", "enum": [ "Restored Premium" ] }, { "type": "string", "enum": [ "Restored" ] } ] }, "example": "example" }, { "in": "query", "name": "availability", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "In_stock" ] }, { "type": "string", "enum": [ "Out_of_stock" ] }, { "type": "string", "enum": [ "Preorder" ] } ] }, "example": "example" }, { "in": "query", "name": "showDuplicateItemDetails", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "example": "example" }, { "in": "query", "name": "includeCustomerFavoritesStatus", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "itemId", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "123" }, { "in": "query", "name": "save", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAnItemResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-wm-v3-items-{id}", "summary": "retireAnItem", "description": "Thin wrapper around Walmart's [Retire an item](https://developer.walmart.com/us-marketplace/reference/retireanitem) API", "tags": [ "Walmart/Item" ], "parameters": [ { "in": "query", "name": "fetch", "required": true, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "sku", "required": true, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "marketplace_id", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: id" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireAnItemResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/items/taxonomy": { "get": { "operationId": "get-v3-wm-v3-items-taxonomy", "summary": "getTaxonomy", "description": "Wrapper around Walmart's [Taxonomy](https://developer.walmart.com/us-marketplace/reference/gettaxonomyresponse) API with the added bonus of being able to filter by categories", "tags": [ "Walmart/Item" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "categories", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "example" }, { "in": "query", "name": "feedType", "required": true, "schema": { "type": "string", "enum": [ "MP_ITEM_MATCH", "MP_ITEM", "inventory", "PRICE_AND_PROMOTION", "OMNI_WFS", "price" ] }, "example": "MP_ITEM_MATCH" }, { "in": "query", "name": "version", "required": true, "schema": { "type": "string" }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTaxonomyResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/items/walmart/search": { "get": { "operationId": "get-v3-wm-v3-items-walmart-search", "summary": "getSearchResult", "description": "Thin wrapper around Walmart's [Item Search](https://developer.walmart.com/us-marketplace/reference/getsearchresult) API", "tags": [ "Walmart/Item" ], "parameters": [ { "in": "query", "name": "query", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "example" }, { "in": "query", "name": "upc", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "gtin", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "item_id", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": 123 }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSearchResultResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/webhooks/eventTypes": { "get": { "operationId": "get-v3-wm-v3-webhooks-eventTypes", "summary": "eventTypes", "description": "Thin wrapper around Walmart's [Event Types](https://developer.walmart.com/us-marketplace/reference/geteventtypes) API", "tags": [ "Walmart/Notification" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string" }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventTypesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/webhooks/subscriptions": { "get": { "operationId": "get-v3-wm-v3-webhooks-subscriptions", "summary": "getAllSubscriptions", "description": "Thin wrapper around Walmart's [All subscriptions](https://developer.walmart.com/us-marketplace/reference/getallsubscriptions) API", "tags": [ "Walmart/Notification" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "subscriptionId", "required": false, "schema": { "type": "string", "description": "Filter results to a specific subscription by its unique identifier." }, "description": "Filter results to a specific subscription by its unique identifier.", "example": "123" }, { "in": "query", "name": "eventType", "required": false, "schema": { "type": "string", "description": "Filter results to a specific event type. Refer to the events section for the list of available event types." }, "description": "Filter results to a specific event type. Refer to the events section for the list of available event types.", "example": "example" }, { "in": "query", "name": "resourceName", "required": false, "schema": { "type": "string", "description": "Filter results to a specific resource (functional category) that the event type maps to. Refer to the events section for the list of available resource names." }, "description": "Filter results to a specific resource (functional category) that the event type maps to. Refer to the events section for the list of available resource names.", "example": "example" }, { "in": "query", "name": "status", "required": false, "schema": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ], "description": "Filter results by subscription status." }, "description": "Filter results by subscription status.", "example": "ACTIVE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllSubscriptionsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-wm-v3-webhooks-subscriptions", "summary": "createSubscription", "description": "Thin wrapper around Walmart's [All subscriptions](https://developer.walmart.com/us-marketplace/reference/getallsubscriptions) API", "tags": [ "Walmart/Notification" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/webhooks/test": { "post": { "operationId": "post-v3-wm-v3-webhooks-test", "summary": "testNotification", "description": "Thin wrapper around Walmart's [Test Notification](https://developer.walmart.com/us-marketplace/reference/testnotification) API", "tags": [ "Walmart/Notification" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string" }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestNotificationBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestNotificationResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/webhooks/subscriptions/{subscriptionId}": { "patch": { "operationId": "patch-v3-wm-v3-webhooks-subscriptions-{subscriptionId}", "summary": "updateSubscription", "description": "Thin wrapper around Walmart's [Update Subscription](https://developer.walmart.com/us-marketplace/reference/updatesubscription) API", "tags": [ "Walmart/Notification" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: subscriptionId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-wm-v3-webhooks-subscriptions-{subscriptionId}", "summary": "deleteSubscription", "description": "Thin wrapper around Walmart's [Delete Subscription](https://developer.walmart.com/us-marketplace/reference/deletesubscription) API", "tags": [ "Walmart/Notification" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: subscriptionId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSubscriptionResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/price": { "put": { "operationId": "put-v3-wm-v3-price", "summary": "updatePrice", "description": "Thin wrapper around Walmart's [Update pricing for a single item](https://developer.walmart.com/us-marketplace/reference/updateprice) API with a `price` shorthand for doing simple base price updates", "tags": [ "Walmart/Price" ], "parameters": [ { "in": "query", "name": "price", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "currency", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "CAD" ] }, { "type": "string", "enum": [ "USD" ] } ] }, "example": "example" }, { "in": "query", "name": "sku", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePriceBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePriceResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/reports/downloadReport": { "get": { "operationId": "get-v3-wm-v3-reports-downloadReport", "summary": "downloadReport", "description": "Thin wrapper around Walmart's [Download Report URL](https://developer.walmart.com/us-marketplace/reference/downloadreport) API", "tags": [ "Walmart/Report" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "requestId", "required": true, "schema": { "type": "string", "description": "System-generated ID that uniquely identifies the report request." }, "description": "System-generated ID that uniquely identifies the report request.", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadReportResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/reports/reportRequests": { "get": { "operationId": "get-v3-wm-v3-reports-reportRequests", "summary": "getAllReportRequests", "description": "Thin wrapper around Walmart's [Get All Report Requests](https://developer.walmart.com/us-marketplace/reference/getrequestsstatus) API", "tags": [ "Walmart/Report" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "reportType", "required": true, "schema": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the report type to return. For example, use ITEM to retrieve Item reports." }, "description": "Specifies the report type to return. For example, use ITEM to retrieve Item reports.", "example": "ITEM" }, { "in": "query", "name": "reportVersion", "required": false, "schema": { "type": "string", "description": "Specifies the version of the report. For example, v1." }, "description": "Specifies the version of the report. For example, v1.", "example": "example" }, { "in": "query", "name": "requestStatus", "required": false, "schema": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ], "description": "Filters report requests by status." }, "description": "Filters report requests by status.", "example": "RECEIVED" }, { "in": "query", "name": "src", "required": false, "schema": { "type": "string", "enum": [ "SC", "API", "Scheduler" ], "description": "Filters report requests by their creation source. Valid values are SC (Seller Center), API, or Scheduler." }, "description": "Filters report requests by their creation source. Valid values are SC (Seller Center), API, or Scheduler.", "example": "SC" }, { "in": "query", "name": "requestSubmissionStartDate", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Returns report requests submitted on or after this timestamp. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." }, "description": "Returns report requests submitted on or after this timestamp. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).", "example": "example" }, { "in": "query", "name": "requestSubmissionEndDate", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Returns report requests submitted on or before this timestamp. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)." }, "description": "Returns report requests submitted on or before this timestamp. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).", "example": "example" }, { "in": "query", "name": "nextCursor", "required": false, "schema": { "type": "string" }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllReportRequestsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-wm-v3-reports-reportRequests", "summary": "generateReport", "description": "Thin wrapper around Walmart's [Create Report Request](https://developer.walmart.com/us-marketplace/reference/generatereport) API", "tags": [ "Walmart/Report" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateReportBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateReportResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/reports/schedules": { "get": { "operationId": "get-v3-wm-v3-reports-schedules", "summary": "getAllReportSchedules", "description": "Thin wrapper around Walmart's [Get All Report Schedules](https://developer.walmart.com/us-marketplace/reference/get_v3-reports-schedules) API", "tags": [ "Walmart/Report" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "reportType", "required": true, "schema": { "type": "string", "enum": [ "ITEM", "INVENTORY", "CANCELLATION", "DELIVERY_DEFECT", "ITEM_PERFORMANCE", "PROMO", "RETURN_OVERRIDES", "CPA", "SHIPPING_CONFIGURATION", "SHIPPING_PROGRAM", "FITMENT_MISSING_ATTR", "FITMENT_ACES_COVERAGE", "BUYBOX", "ASSORTMENT_RECOMMENDATIONS", "LAGTIME" ], "description": "Specifies the type of report to be generated." }, "description": "Specifies the type of report to be generated.", "example": "ITEM" }, { "in": "query", "name": "nextCursor", "required": true, "schema": { "type": "string", "description": "Specifies the type of report to be generated." }, "description": "Specifies the type of report to be generated.", "example": "example" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllReportSchedulesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-wm-v3-reports-schedules", "summary": "createReportSchedule", "description": "Thin wrapper around Walmart's [Create Report Schedule](https://developer.walmart.com/us-marketplace/reference/post_v3-reports-schedules) API", "tags": [ "Walmart/Report" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportScheduleBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportScheduleResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/reports/reportRequests/{requestId}": { "get": { "operationId": "get-v3-wm-v3-reports-reportRequests-{requestId}", "summary": "getSingleRequestStatus", "description": "Thin wrapper around Walmart's [Report Request Status](https://developer.walmart.com/us-marketplace/reference/getsinglerequeststatus) API", "tags": [ "Walmart/Report" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: requestId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSingleRequestStatusResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/reports/schedules/{scheduleId}": { "get": { "operationId": "get-v3-wm-v3-reports-schedules-{scheduleId}", "summary": "getSingleReportSchedule", "description": "Thin wrapper around Walmart's [Get Single Report Schedule](https://developer.walmart.com/us-marketplace/reference/get_v3-reports-schedules-scheduleid) API", "tags": [ "Walmart/Report" ], "parameters": [ { "in": "query", "name": "scheduleId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: scheduleId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSingleReportScheduleResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "put": { "operationId": "put-v3-wm-v3-reports-schedules-{scheduleId}", "summary": "updateReportSchedule", "description": "Thin wrapper around Walmart's [Update Report Schedule](https://developer.walmart.com/us-marketplace/reference/put_v3-reports-schedules-scheduleid) API", "tags": [ "Walmart/Report" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: scheduleId" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportScheduleBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReportScheduleResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-wm-v3-reports-schedules-{scheduleId}", "summary": "deleteReportSchedule", "description": "Thin wrapper around Walmart's [Delete Report Schedule](https://developer.walmart.com/us-marketplace/reference/delete_v3-reports-schedules-scheduleid) API", "tags": [ "Walmart/Report" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "scheduleId", "required": true, "schema": { "type": "string", "description": "A unique identifier assigned to the report schedule." }, "description": "A unique identifier assigned to the report schedule.", "example": "123" }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: scheduleId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteReportScheduleResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/download-label": { "get": { "operationId": "get-v3-wm-v3-fulfillment-download-label", "summary": "downloadLabel", "description": "Thin wrapper around Walmart's [Download Label](https://developer.walmart.com/us-marketplace/reference/downloadlabel) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "shipmentId", "required": false, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "labelType", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "labelSize", "required": false, "schema": { "type": "string" }, "example": "example" }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/generate-label": { "post": { "operationId": "post-v3-wm-v3-fulfillment-generate-label", "summary": "generateLabel", "description": "Thin wrapper around Walmart's [Generate Label](https://developer.walmart.com/us-marketplace/reference/generatelabel) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string" }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateLabelSearchBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateLabelResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/inbound-preview": { "post": { "operationId": "post-v3-wm-v3-fulfillment-inbound-preview", "summary": "inboundPreview", "description": "Thin wrapper around Walmart's [Fetch Inbound Preview](https://developer.walmart.com/us-marketplace/reference/inboundpreview) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string" }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundPreviewParams" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundPreviewResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/inbound-seller-schedule": { "get": { "operationId": "get-v3-wm-v3-fulfillment-inbound-seller-schedule", "summary": "getPickupSellerSchedule", "description": "Thin wrapper around Walmart's [Get Pickup Seller Schedule](https://developer.walmart.com/us-marketplace/reference/inboundsellerschedule) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "shipmentId", "required": true, "schema": { "type": "string", "description": "Unique identifier identifying each shipment." }, "description": "Unique identifier identifying each shipment.", "example": "123" }, { "in": "query", "name": "quoteType", "required": true, "schema": { "type": "string", "description": "Specifies the transportation quote." }, "description": "Specifies the transportation quote.", "example": "example" }, { "in": "query", "name": "quoteId", "required": true, "schema": { "type": "string", "description": "Unique identifier identifying each quote." }, "description": "Unique identifier identifying each quote.", "example": "123" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPickupSellerScheduleResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/inbound-shipment-errors": { "get": { "operationId": "get-v3-wm-v3-fulfillment-inbound-shipment-errors", "summary": "getInboundShipmentErrors", "description": "Thin wrapper around Walmart's [Get Inbound Shipment errors](https://developer.walmart.com/us-marketplace/reference/getinboundordererrors) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "offset", "required": false, "schema": { "type": "number", "description": "The number of records you wish to skip before selecting records. Defaults to 0" }, "description": "The number of records you wish to skip before selecting records. Defaults to 0", "example": 1 }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number", "description": "The number of Purchase Orders to be returned. Defaults to 10" }, "description": "The number of Purchase Orders to be returned. Defaults to 10", "example": 1 }, { "in": "query", "name": "inboundOrderId", "required": true, "schema": { "type": "string", "description": "Unique ID identifying inbound shipment request." }, "description": "Unique ID identifying inbound shipment request.", "example": "123" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "Unique ID identifying inbound shipment request." }, "description": "Unique ID identifying inbound shipment request.", "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInboundShipmentErrorsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/inbound-shipment-items": { "get": { "operationId": "get-v3-wm-v3-fulfillment-inbound-shipment-items", "summary": "getInboundShipmentItems", "description": "Thin wrapper around Walmart's [Get Inbound Shipment Items](https://developer.walmart.com/us-marketplace/reference/getinboundshipmentitems) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "shipmentId", "required": true, "schema": { "type": "string", "description": "Unique ID identifying each shipment." }, "description": "Unique ID identifying each shipment.", "example": "123" }, { "in": "query", "name": "limit", "required": true, "schema": { "type": "number", "description": "The number of items to be returned." }, "description": "The number of items to be returned.", "example": 1 }, { "in": "query", "name": "offset", "required": true, "schema": { "type": "number", "description": "offset is the number of records you wish to skip before selecting records." }, "description": "offset is the number of records you wish to skip before selecting records.", "example": 1 }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ], "description": "offset is the number of records you wish to skip before selecting records." }, "description": "offset is the number of records you wish to skip before selecting records.", "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInboundShipmentItemsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/inbound-shipments": { "get": { "operationId": "get-v3-wm-v3-fulfillment-inbound-shipments", "summary": "getInboundShipments", "description": "Thin wrapper around Walmart's [Get Shipments](https://developer.walmart.com/us-marketplace/reference/getinboundshipments) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "offset", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "number" } ] }, "example": "example" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "inboundOrderId", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string" } ] }, "example": "123" }, { "in": "query", "name": "shipmentId", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": 123 }, { "in": "query", "name": "status", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "enum": [ "CANCELLED" ] }, { "type": "string", "enum": [ "CLOSED" ] }, { "type": "string", "enum": [ "RECEIVED" ] }, { "type": "string", "enum": [ "PROCESSED" ] }, { "type": "string", "enum": [ "SUBMITTED" ] }, { "type": "string", "enum": [ "FAILED_GDM" ] }, { "type": "string", "enum": [ "ENRICHMENT_FAILED_GDM" ] }, { "type": "string", "enum": [ "AWAITING_DELIVERY" ] }, { "type": "string", "enum": [ "CANCELLED_GDM" ] }, { "type": "string", "enum": [ "MOVED" ] }, { "type": "string", "enum": [ "CANCELLED_INIT" ] }, { "type": "string", "enum": [ "FAILED" ] }, { "type": "string", "enum": [ "FINALIZED" ] }, { "type": "string", "enum": [ "FAILED_AND_CANCELED" ] }, { "type": "string", "enum": [ "PROCESSED_GDM" ] }, { "type": "string", "enum": [ "ALLOCATED" ] }, { "type": "string", "enum": [ "RECEIVING_IN_PROGRESS" ] }, { "type": "string", "enum": [ "CREATE_GDM_PUBLISH_FAILED" ] }, { "type": "string", "enum": [ "TRANSFER_IN_PROGRESS" ] }, { "type": "string", "enum": [ "CANCELED" ] } ] }, "example": "example" }, { "in": "query", "name": "fromCreateDate", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "string", "format": "date-time" } ] }, "example": "example" }, { "in": "query", "name": "toCreateDate", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "import", "required": false, "schema": { "oneOf": [ { "type": "object" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] } ] }, "example": "example" }, { "in": "query", "name": "sync", "required": false, "schema": { "type": "object" }, "style": "deepObject", "explode": true, "example": "example" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInboundShipmentsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-wm-v3-fulfillment-inbound-shipments", "summary": "createShipment", "description": "Thin wrapper around Walmart's [Create Inbound Shipment](https://developer.walmart.com/us-marketplace/reference/createshipment) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/inbound-shipments-bol": { "get": { "operationId": "get-v3-wm-v3-fulfillment-inbound-shipments-bol", "summary": "printBillOfLading", "description": "Thin wrapper around Walmart's [Update Shipment Tracking](https://developer.walmart.com/us-marketplace/reference/printBillOfLading) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "shipmentId", "required": false, "schema": { "type": "string", "description": "Unique identifier identifying each shipment." }, "description": "Unique identifier identifying each shipment.", "example": "123" }, { "in": "query", "name": "mode", "required": false, "schema": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ], "description": "The classification of the shipment based on the nature of the goods and the method of transportation." }, "description": "The classification of the shipment based on the nature of the goods and the method of transportation.", "example": "PARCEL" }, { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/inbound-shipments-booking": { "post": { "operationId": "post-v3-wm-v3-fulfillment-inbound-shipments-booking", "summary": "createBooking", "description": "Thin wrapper around Walmart's [Create Booking](https://developer.walmart.com/us-marketplace/reference/submitbookingquotes) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBookingBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBookingResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-wm-v3-fulfillment-inbound-shipments-booking", "summary": "cancelBooking", "description": "Thin wrapper around Walmart's [Cancel Booking](https://developer.walmart.com/us-marketplace/reference/voidcarrierratequotes) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "shipmentId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "mode", "required": true, "schema": { "type": "string", "enum": [ "PARCEL", "LTL", "FTL" ] }, "example": "PARCEL" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelBookingResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/inbound-shipments-quote": { "get": { "operationId": "get-v3-wm-v3-fulfillment-inbound-shipments-quote", "summary": "getCarrierRateQuote", "description": "Thin wrapper around Walmart's [Get Carrier Rate Quote](https://developer.walmart.com/us-marketplace/reference/createcarrierratequote) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "quoteType", "required": true, "schema": { "type": "string", "enum": [ "LTL", "FTL", "Parcel" ] }, "example": "LTL" }, { "in": "query", "name": "shipmentId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCarrierRateQuoteResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "post": { "operationId": "post-v3-wm-v3-fulfillment-inbound-shipments-quote", "summary": "createCarrierRateQuote", "description": "Thin wrapper around Walmart's [Create Carrier Rate Quote](https://developer.walmart.com/us-marketplace/reference/createcarrierratequote) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCarrierRateQuoteBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCarrierRateQuoteResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/shipment-label": { "post": { "operationId": "post-v3-wm-v3-fulfillment-shipment-label", "summary": "createInboundShipmentLabel", "description": "Thin wrapper around Walmart's [Create Inbound Shipment label](https://developer.walmart.com/us-marketplace/reference/createinboundshipmentlabelv2) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInboundShipmentLabelBody" } } } }, "responses": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/shipment-quantities": { "put": { "operationId": "put-v3-wm-v3-fulfillment-shipment-quantities", "summary": "updateShipmentQuantities", "description": "Thin wrapper around Walmart's [Update Shipment Quantities](https://developer.walmart.com/us-marketplace/reference/updateshipmentquantity) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string" }, "example": "example" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShipmentQuantitiesBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShipmentQuantitiesResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/shipment-tracking": { "post": { "operationId": "post-v3-wm-v3-fulfillment-shipment-tracking", "summary": "updateShipmentTrackingDetails", "description": "Thin wrapper around Walmart's [Update Shipment Tracking](https://developer.walmart.com/us-marketplace/reference/updateshipmenttrackingdetails) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "mp", "required": true, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShipmentTrackingDetailsBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShipmentTrackingDetailsResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/wm/v3/fulfillment/inbound-shipments/{inboundOrderId}": { "delete": { "operationId": "delete-v3-wm-v3-fulfillment-inbound-shipments-{inboundOrderId}", "summary": "cancelShipment", "description": "Thin wrapper around Walmart's [Cancel Inbound Shipment](https://developer.walmart.com/us-marketplace/reference/cancelshipment) API", "tags": [ "Walmart/Shipment" ], "parameters": [ { "in": "query", "name": "mp", "required": false, "schema": { "type": "string", "enum": [ "az-AE", "az-AU", "az-BE", "az-BR", "az-CA", "az-CN", "az-DE", "az-EG", "az-ES", "az-FR", "az-GB", "az-IE", "az-IN", "az-IT", "az-JP", "az-MX", "az-NL", "az-PL", "az-SA", "az-SE", "az-SG", "az-TR", "az-US", "az-ZA", "wm-CA", "wm-CL", "wm-MX", "wm-US" ] }, "example": "az-AE" }, { "in": "query", "name": "inboundOrderId", "required": true, "schema": { "type": "string" }, "example": "123" }, { "in": "query", "name": "put_back", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "inboundOrderId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "123", "description": "Path parameter: inboundOrderId" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelShipmentResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/webhook": { "get": { "operationId": "get-v3-webhook", "summary": "selectWebHooks", "description": "List my web hooks", "tags": [ "WebHook" ], "parameters": [], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectWebHooksResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/webhook/{name}": { "put": { "operationId": "put-v3-webhook-{name}", "summary": "insertWebHook", "description": "Create a listener for a specific web hook", "tags": [ "WebHook" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "example": "name", "description": "Path parameter: name" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertWebHookBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertWebHookResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } }, "delete": { "operationId": "delete-v3-webhook-{name}", "summary": "deleteWebHook", "description": "Delete the listener for a specific web hook", "tags": [ "WebHook" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "example": "name", "description": "Path parameter: name" } ], "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebHookResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/v3/webhook/{name}/test": { "put": { "operationId": "put-v3-webhook-{name}-test", "summary": "testWebHook", "description": "Test a listener for a specific web hook", "tags": [ "WebHook" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "example": "name", "description": "Path parameter: name" } ], "security": [ { "BearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestWebHookBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestWebHookResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } } } }