diff --git a/models/listings-items-api-model/listingsItems_2021-08-01.json b/models/listings-items-api-model/listingsItems_2021-08-01.json index 917f6dc..f751a46 100644 --- a/models/listings-items-api-model/listingsItems_2021-08-01.json +++ b/models/listings-items-api-model/listingsItems_2021-08-01.json @@ -58,6 +58,7 @@ "in": "query", "required": true, "type": "array", + "maxItems": 1, "items": { "type": "string" }, @@ -259,6 +260,7 @@ "in": "query", "required": true, "type": "array", + "maxItems": 1, "items": { "type": "string" }, @@ -366,6 +368,10 @@ "price": { "currencyCode": "USD", "amount": "100.00" + }, + "audience": { + "value": "ALL", + "displayName": "Sell on Amazon" } } ], @@ -488,6 +494,10 @@ "price": { "currencyCode": "USD", "amount": "100.00" + }, + "audience": { + "value": "ALL", + "displayName": "Sell on Amazon" } } ], @@ -737,6 +747,7 @@ "in": "query", "required": true, "type": "array", + "maxItems": 1, "items": { "type": "string" }, @@ -780,7 +791,7 @@ "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", - "description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog." + "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ], "required": false, @@ -1078,6 +1089,7 @@ "in": "query", "required": true, "type": "array", + "maxItems": 1, "items": { "type": "string" }, @@ -1121,7 +1133,7 @@ "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", - "description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog." + "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ], "required": false, @@ -1395,6 +1407,1147 @@ } } } + }, + "/listings/2021-08-01/items/{sellerId}": { + "get": { + "tags": [ + "listings" + ], + "description": "Search for and return list of listings items and respective details for a selling partner.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 5 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "searchListingsItems", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "sellerId", + "description": "A selling partner identifier, such as a merchant account or vendor code.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "marketplaceIds", + "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", + "in": "query", + "required": true, + "type": "array", + "maxItems": 1, + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "ATVPDKIKX0DER" + }, + { + "name": "identifiers", + "description": "A comma-delimited list of product identifiers to search for listings items by. \n\n**Note**: \n1. Required when `identifiersType` is provided.", + "in": "query", + "required": false, + "type": "array", + "maxItems": 20, + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "GM-ZDPI-9B4E" + }, + { + "name": "identifiersType", + "description": "Type of product identifiers to search for listings items by. \n\n**Note**: \n1. Required when `identifiers` is provided.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASIN", + "EAN", + "GTIN", + "ISBN", + "JAN", + "MINSAN", + "SKU", + "UPC" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ASIN", + "description": "Amazon Standard Identification Number." + }, + { + "value": "EAN", + "description": "European Article Number." + }, + { + "value": "GTIN", + "description": "Global Trade Item Number." + }, + { + "value": "ISBN", + "description": "International Standard Book Number." + }, + { + "value": "JAN", + "description": "Japanese Article Number." + }, + { + "value": "MINSAN", + "description": "Minsan Code." + }, + { + "value": "SKU", + "description": "Stock Keeping Unit, a seller-specified identifier for an Amazon listing." + }, + { + "value": "UPC", + "description": "Universal Product Code." + } + ], + "x-example": "SKU" + }, + { + "name": "pageSize", + "description": "Number of results to be returned per page.", + "in": "query", + "required": false, + "type": "integer", + "maximum": 20, + "default": 10, + "x-example": 9 + }, + { + "name": "pageToken", + "description": "A token to fetch a certain page when there are multiple pages worth of results.", + "in": "query", + "required": false, + "type": "string", + "x-example": "sdlkj234lkj234lksjdflkjwdflkjsfdlkj234234234234" + }, + { + "name": "includedData", + "description": "A comma-delimited list of data sets to include in the response. Default: summaries.", + "in": "query", + "required": false, + "type": "array", + "items": { + "enum": [ + "summaries", + "attributes", + "issues", + "offers", + "fulfillmentAvailability", + "procurement" + ], + "x-docgen-enum-table-extension": [ + { + "value": "summaries", + "description": "Summary details of the listing item." + }, + { + "value": "attributes", + "description": "JSON object containing structured listing item attribute data keyed by attribute name." + }, + { + "value": "issues", + "description": "Issues associated with the listing item." + }, + { + "value": "offers", + "description": "Current offers for the listing item." + }, + { + "value": "fulfillmentAvailability", + "description": "Fulfillment availability details for the listing item." + }, + { + "value": "procurement", + "description": "Vendor procurement details for the listing item. " + } + ], + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "summaries", + "default": ["summaries"] + }, + { + "name": "issueLocale", + "description": "A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale.", + "in": "query", + "required": false, + "type": "string", + "x-example": "en_US" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ItemSearchResults" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "examples": { + "application/json": { + "numberOfResults": 3, + "pagination": { + "nextToken": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234", + "previousToken": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d" + }, + "items": [ + { + "sku": "GM-ZDPI-9B4E", + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "asin": "B071VG5N9D", + "productType": "LUGGAGE", + "conditionType": "new_new", + "status": [ + "BUYABLE" + ], + "itemName": "Hardside Carry-On Spinner Suitcase Luggage", + "createdDate": "2021-02-01T00:00:00Z", + "lastUpdatedDate": "2021-03-01T00:00:00Z", + "mainImage": { + "link": "https://www.example.com/luggage.png", + "height": 500, + "width": 500 + } + } + ], + "attributes": { + "total_hdmi_ports": [ + { + "value": 4, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "resolution": [ + { + "language_tag": "en_US", + "value": "4K", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_weight": [ + { + "unit": "pounds", + "value": 107.6, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "product_subcategory": [ + { + "value": "50400120", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "bullet_point": [ + { + "language_tag": "en_US", + "value": "SMART TV WITH UNIVERSAL GUIDE: Simple on-screen Guide is an easy way to find streaming content and live TV shows", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "100% COLOR VOLUME WITH QUANTUM DOTS: Powered by Quantum dots, Samsung’s 4K QLED TV offers over a billion shades of brilliant color and 100% color volume for exceptional depth of detail that will draw you in to the picture for the best 4K TV experience", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "QUANTUM PROCESSOR 4K: Intelligently powered processor instantly upscales content to 4K for sharp detail and refined color", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "QUANTUM HDR 4X: 4K depth of detail with high dynamic range powered by HDR10+ delivers the lightest to darkest colors, scene by scene, for amazing picture realism", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "AMBIENT MODE: Customizes and complements your living space by turning a blank screen of this big screen TV into enticing visuals including décor, info, photos and artwork", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "SMART TV FEATURES: OneRemote to control all compatible devices, Bixby voice command, on-screen universal guide, SmartThings to control compatible home appliances and devices, smart speaker expandability with Alexa and Google Assistant compatibility, and more", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_dimensions": [ + { + "width": { + "unit": "inches", + "value": 72.4 + }, + "length": { + "unit": "inches", + "value": 2.4 + }, + "height": { + "unit": "inches", + "value": 41.4 + }, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "brand": [ + { + "language_tag": "en_US", + "value": "SAMSUNG", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "generic_keyword": [ + { + "language_tag": "en_US", + "value": "oled 65 inch smart tv qled 75 inch tv 85 inch 4k tv smart tv 4k tv 65 inch qled 82 inch tv 8k tv oled 65 smart tv qled 65 inch 80 inch tv 4k 4k tv shield tv 2018", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "q9fn qled 2018 oled 4k 4k oled toshiba antenna dvd player outdoor tv kitchen tv fire tv firetv hdtv hd tv android shield tv gaming deals tv ears dvr speakers digital tv antenna tv android tv frame mount", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "4k hdr tv 70 tv shield tv 90 inch tv gaming tv 75 tv 65 inch 4k tv tv 65 inch smart tv 4k 65 inch 4k tv 65 inch 4k tv 4k tv uhd tv uhd tv 4k", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "smart tv 4k tv tv tv oled tv 65 inch smart tv 4k tv 65 inch smart tv shield tv 2018 tv 4k oled tv 65 4k tv 4k smart tv 4k hdr tv shield tv gaming tv 65 inch 4k tv tv 65 inch smart tv 4k 65 inch 4k tv 65 inch 4k tv 4k tv uhd tv uhd tv 4k", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "control_method": [ + { + "value": "voice", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_package_dimensions": [ + { + "length": { + "unit": "centimeters", + "value": 26.67 + }, + "width": { + "unit": "centimeters", + "value": 121.92 + }, + "height": { + "unit": "centimeters", + "value": 203.2 + }, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "image_aspect_ratio": [ + { + "language_tag": "en_US", + "value": "16:9", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "part_number": [ + { + "value": "QN82Q60RAFXZA", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "includes_remote": [ + { + "value": true, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "style": [ + { + "language_tag": "en_US", + "value": "TV only", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_type_name": [ + { + "language_tag": "en_US", + "value": "TV", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "battery": [ + { + "cell_composition": [ + { + "value": "alkaline" + } + ], + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "image_contrast_ratio": [ + { + "language_tag": "en_US", + "value": "QLED 4K", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "manufacturer": [ + { + "language_tag": "en_US", + "value": "Samsung", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "number_of_boxes": [ + { + "value": 1, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "total_usb_ports": [ + { + "value": 2, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "model_number": [ + { + "value": "QN82Q60RAFXZA", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "supplier_declared_dg_hz_regulation": [ + { + "value": "not_applicable", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "num_batteries": [ + { + "quantity": 2, + "type": "aaa", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "california_proposition_65": [ + { + "compliance_type": "on_product_combined_cancer_reproductive", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "compliance_type": "chemical", + "chemical_names": [ + "di_2_ethylhexyl_phthalate_dehp" + ], + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "display": [ + { + "resolution_maximum": [ + { + "unit": "pixels", + "language_tag": "en_US", + "value": "3840 x 2160" + } + ], + "size": [ + { + "unit": "inches", + "value": 82 + } + ], + "type": [ + { + "language_tag": "en_US", + "value": "QLED" + } + ], + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_name": [ + { + "language_tag": "en_US", + "value": "Samsung QN82Q60RAFXZA Flat 82-Inch QLED 4K Q60 Series (2019) Ultra HD Smart TV with HDR and Alexa Compatibility", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "list_price": [ + { + "currency": "USD", + "value": 3799.99, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "batteries_required": [ + { + "value": false, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "includes_rechargable_battery": [ + { + "value": false, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "product_site_launch_date": [ + { + "value": "2019-03-11T08:00:01.000Z", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "product_category": [ + { + "value": "50400100", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "batteries_included": [ + { + "value": false, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "connectivity_technology": [ + { + "language_tag": "en_US", + "value": "Bluetooth", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "USB", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Wireless", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "HDMI", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "included_components": [ + { + "language_tag": "en_US", + "value": "QLED Standard Smart Remote", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Power Cable", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Stand", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Samsung Smart Control", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "specification_met": [ + { + "language_tag": "en_US", + "value": "", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "parental_control_technology": [ + { + "value": "V-Chip", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "power_consumption": [ + { + "unit": "watts", + "value": 120, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "cpsia_cautionary_statement": [ + { + "value": "no_warning_applicable", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_type_keyword": [ + { + "value": "qled-televisions", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "number_of_items": [ + { + "value": 1, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "warranty_description": [ + { + "language_tag": "en_US", + "value": "1 year manufacturer", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "max_resolution": [ + { + "unit": "pixels", + "value": 8.3, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "color": [ + { + "language_tag": "en_US", + "value": "Black", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "screen_surface_description": [ + { + "language_tag": "en_US", + "value": "Flat", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "item_package_weight": [ + { + "unit": "kilograms", + "value": 62.142, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "speaker_type": [ + { + "language_tag": "en_US", + "value": "2CH", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "supported_internet_services": [ + { + "language_tag": "en_US", + "value": "Amazon Instant Video", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "YouTube", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Netflix", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Hulu", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Browser", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "tuner_technology": [ + { + "language_tag": "en_US", + "value": "Analog Tuner", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "controller_type": [ + { + "language_tag": "en_US", + "value": "SmartThings", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Voice Control", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "special_feature": [ + { + "language_tag": "en_US", + "value": "100% Color Volume with Quantum Dot; Quantum Processor 4K; Ambient Mode; Quantum HDR 4X; Real Game Enhancer", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "wireless_communication_technology": [ + { + "language_tag": "en_US", + "value": "Wi-Fi::Wi-Fi Direct::Bluetooth", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "model_year": [ + { + "value": 2019, + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "power_source_type": [ + { + "language_tag": "en_US", + "value": "Corded Electric", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "street_date": [ + { + "value": "2019-03-21T00:00:01Z", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "mounting_type": [ + { + "language_tag": "en_US", + "value": "Table Mount", + "marketplace_id": "ATVPDKIKX0DER" + }, + { + "language_tag": "en_US", + "value": "Wall Mount", + "marketplace_id": "ATVPDKIKX0DER" + } + ], + "refresh_rate": [ + { + "unit": "hertz", + "language_tag": "en_US", + "value": "120", + "marketplace_id": "ATVPDKIKX0DER" + } + ] + }, + "offers": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "offerType": "B2C", + "price": { + "currencyCode": "USD", + "amount": "100.00" + } + } + ], + "fulfillmentAvailability": [ + { + "fulfillmentChannelCode": "DEFAULT", + "quantity": 100 + } + ], + "issues": [ + { + "code": "90220", + "message": "'size' is required but not supplied.", + "severity": "ERROR", + "attributeNames": [ + "size" + ], + "categories": [ + "MISSING_ATTRIBUTE" + ] + }, + { + "code": "18027", + "message": "We believe the main image has text, logo, graphic or watermark which is not permitted for this product type. Please submit a compliant image to lift the suppression. Also refer to Product image requirements.", + "severity": "ERROR", + "categories": [ + "INVALID_IMAGE" + ], + "enforcements": { + "actions": [ + { + "action": "SEARCH_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT_UNTIL_EXPIRY_DATE", + "expiryDate": "2025-05-28T00:36:48.914Z" + } + } + }, + { + "code": "99300", + "message": "Product Detail Page Rules Violation (Inaccurate information on product detail page)", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "ATTRIBUTE_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT" + } + } + }, + { + "code": "18155", + "message": "The 'minimum price' is greater than the selling price (excluding shipping) for the listing. Please review and update your price and/or minimum price.", + "severity": "ERROR", + "categories": [ + "INVALID_PRICE" + ], + "enforcements": { + "actions": [ + { + "action": "LISTING_SUPPRESSED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + }, + { + "code": "18742", + "message": "Restricted Products Policy Violation", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "CATALOG_ITEM_REMOVED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + } + ] + } + ] + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "identifiersType": { + "value": "SKU" + }, + "identifiers": { + "value": [ + "GM-ZDPI-9B4E", + "HW-ZDPI-9B4E", + "TC-ZDPI-9B4E" + ] + }, + "marketplaceIds": { + "value": [ + "ATVPDKIKX0DER" + ] + }, + "includedData": { + "value": [ + "summaries", + "offers", + "fulfillmentAvailability", + "issues" + ] + }, + "pageSize": { + "value": 1 + } + } + }, + "response": { + "numberOfResults": 3, + "pagination": { + "nextToken": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234", + "previousToken": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d" + }, + "items": [ + { + "sku": "GM-ZDPI-9B4E", + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "asin": "B071VG5N9D", + "productType": "LUGGAGE", + "conditionType": "new_new", + "status": [ + "BUYABLE" + ], + "itemName": "Hardside Carry-On Spinner Suitcase Luggage", + "createdDate": "2021-02-01T00:00:00Z", + "lastUpdatedDate": "2021-03-01T00:00:00Z", + "mainImage": { + "link": "https://www.example.com/luggage.png", + "height": 500, + "width": 500 + } + } + ], + "offers": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "offerType": "B2C", + "price": { + "currencyCode": "USD", + "amount": "100.00" + } + } + ], + "fulfillmentAvailability": [ + { + "fulfillmentChannelCode": "DEFAULT", + "quantity": 100 + } + ], + "issues": [ + { + "code": "90220", + "message": "'size' is required but not supplied.", + "severity": "ERROR", + "attributeNames": [ + "size" + ], + "categories": [ + "MISSING_ATTRIBUTE" + ] + }, + { + "code": "18027", + "message": "We believe the main image has text, logo, graphic or watermark which is not permitted for this product type. Please submit a compliant image to lift the suppression. Also refer to Product image requirements.", + "severity": "ERROR", + "categories": [ + "INVALID_IMAGE" + ], + "enforcements": { + "actions": [ + { + "action": "SEARCH_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT_UNTIL_EXPIRY_DATE", + "expiryDate": "2025-05-28T00:36:48.914Z" + } + } + }, + { + "code": "99300", + "message": "Product Detail Page Rules Violation (Inaccurate information on product detail page)", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "ATTRIBUTE_SUPPRESSED" + } + ], + "exemption": { + "status": "EXEMPT" + } + } + }, + { + "code": "18155", + "message": "The 'minimum price' is greater than the selling price (excluding shipping) for the listing. Please review and update your price and/or minimum price.", + "severity": "ERROR", + "categories": [ + "INVALID_PRICE" + ], + "enforcements": { + "actions": [ + { + "action": "LISTING_SUPPRESSED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + }, + { + "code": "18742", + "message": "Restricted Products Policy Violation", + "severity": "ERROR", + "categories": [], + "enforcements": { + "actions": [ + { + "action": "CATALOG_ITEM_REMOVED" + } + ], + "exemption": { + "status": "NOT_EXEMPT" + } + } + } + ] + } + ] + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "sellerId": { + "value": "SellerId" + }, + "marketplaceIds": { + "value": [ + "invalid" + ] + } + } + }, + "response": { + "errors": [ + { + "code": "BAD_REQUEST", + "message": "Invalid input", + "details": "Invalid input" + } + ] + } + } + ] + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + } + } + } } }, "definitions": { @@ -1435,6 +2588,31 @@ "errors" ] }, + "ItemSearchResults": { + "description": "Selling partner listings items and search related metadata.", + "properties": { + "numberOfResults": { + "description": "The total number of selling partner listings items found for the search criteria (only results up to the page count limit will be returned per request regardless of the number found).\n\nNote: The maximum number of items (SKUs) that can be returned and paged through is 1000.", + "type": "integer" + }, + "pagination": { + "description": "If available, the `nextToken` and/or `previousToken` values required to return paginated results.", + "$ref": "#/definitions/Pagination" + }, + "items": { + "description": "A list of listings items.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + } + }, + "required": [ + "numberOfResults", + "items" + ], + "type": "object" + }, "Item": { "description": "A listings item.", "properties": { @@ -1832,6 +3010,10 @@ }, "points": { "$ref": "#/definitions/Points" + }, + "audience": { + "description": "Buyer segment or program this offer is applicable to.", + "$ref": "#/definitions/Audience" } }, "required": [ @@ -1906,6 +3088,21 @@ "pointsNumber" ] }, + "Audience": { + "description": "Buyer segment or program this offer is applicable to.", + "type": "object", + "properties": { + "value": { + "description": "Name of the audience an offer is applicable to. \n\nCommon values: \n\n* 'ALL' - Standard offer audience for buyers on Amazon retail websites. \n\n* 'B2B' - Offer audience for Amazon Business website buyers.", + "type": "string", + "example": "ALL" + }, + "displayName": { + "description": "Localized display name for the audience.", + "type": "string" + } + } + }, "PatchOperation": { "description": "Individual JSON Patch operation for an HTTP PATCH request.", "properties": { @@ -2088,6 +3285,20 @@ } }, "type": "object" + }, + "Pagination": { + "description": "When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there will be no `nextToken` key in the pagination object.", + "properties": { + "nextToken": { + "description": "A token that can be used to fetch the next page.", + "type": "string" + }, + "previousToken": { + "description": "A token that can be used to fetch the previous page.", + "type": "string" + } + }, + "type": "object" } } -} \ No newline at end of file +} diff --git a/models/orders-api-model/ordersV0.json b/models/orders-api-model/ordersV0.json index ee15b59..aa9858c 100644 --- a/models/orders-api-model/ordersV0.json +++ b/models/orders-api-model/ordersV0.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "description": "The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools. The Orders API supports orders that are two years old or less. Orders more than two years old will not show in the API response.\n\n**Note:** The Orders API supports orders from 2016 and after for the JP, AU, and SG marketplaces.", + "description": "Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. \n\n_Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don't show up in the response).", "version": "v0", "title": "Selling Partner API for Orders", "contact": { @@ -29,34 +29,34 @@ "tags": [ "ordersV0" ], - "description": "Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. \n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.", "operationId": "getOrders", "parameters": [ { "name": "CreatedAfter", "in": "query", - "description": "A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in ISO 8601 format.\n\n**Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. You could specify `CreatedBefore` but not provide `LastUpdatedAfter` or `LastUpdatedBefore` when `CreatedAfter` is specified.", + "description": "Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.\n\n**Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.", "required": false, "type": "string" }, { "name": "CreatedBefore", "in": "query", - "description": "A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.\n\n**Note**: `CreatedBefore` is optional when `CreatedAfter` is specified. But if specified, `CreatedBefore` should be equal to or after the `CreatedAfter` date and at least 2 minutes before the current time.", + "description": "Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.\n\n**Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.", "required": false, "type": "string" }, { "name": "LastUpdatedAfter", "in": "query", - "description": "A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.\n\n**Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is specified. But if specified, `LastUpdatedBefore` should be equal to or after the `LastUpdatedAfter` date and at least 2 minutes before current time.", + "description": "Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.\n\n**Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set.", "required": false, "type": "string" }, { "name": "LastUpdatedBefore", "in": "query", - "description": "A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.\n\n**Note**: LastUpdatedBefore is optional when LastUpdatedAfter is set. But if specified, LastUpdatedBefore should be equal to or after the LastUpdatedAfter date and at least 2 minutes before current time.", + "description": "Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.\n\n**Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time.", "required": false, "type": "string" }, @@ -73,7 +73,7 @@ { "name": "MarketplaceIds", "in": "query", - "description": "A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces.\n\nRefer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `MarketplaceId` values.", + "description": "A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces.\n\nRefer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.", "required": true, "type": "array", "items": { @@ -84,7 +84,7 @@ { "name": "FulfillmentChannels", "in": "query", - "description": "A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. \n\n**Possible values**: `AFN` (Fulfillment by Amazon); `MFN` (Fulfilled by the seller).", + "description": "A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. \n\n**Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller).", "required": false, "type": "array", "items": { @@ -94,7 +94,7 @@ { "name": "PaymentMethods", "in": "query", - "description": "A list of payment method values. Used to select orders paid using the specified payment methods.\n\n**Possible values**: `COD` (Cash on delivery); `CVS` (Convenience store payment); `Other` (Any payment method other than `COD` or `CVS`).", + "description": "A list of payment method values. Use this field to select orders that were paid with the specified payment methods.\n\n**Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS).", "required": false, "type": "array", "items": { @@ -111,7 +111,7 @@ { "name": "SellerOrderId", "in": "query", - "description": "An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.", + "description": "An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified.", "required": false, "type": "string" }, @@ -152,7 +152,7 @@ { "name": "AmazonOrderIds", "in": "query", - "description": "A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.", + "description": "A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.", "required": false, "type": "array", "items": { @@ -163,7 +163,7 @@ { "name": "ActualFulfillmentSupplySourceId", "in": "query", - "description": "Denotes the recommended sourceId where the order should be fulfilled from.", + "description": "The `sourceId` of the location from where you want the order fulfilled.", "required": false, "type": "string" }, @@ -184,28 +184,28 @@ { "name": "EarliestDeliveryDateBefore", "in": "query", - "description": "A date used for selecting orders with a earliest delivery date before (or at) a specified time. The date must be in ISO 8601 format.", + "description": "Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "required": false, "type": "string" }, { "name": "EarliestDeliveryDateAfter", "in": "query", - "description": "A date used for selecting orders with a earliest delivery date after (or at) a specified time. The date must be in ISO 8601 format.", + "description": "Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "required": false, "type": "string" }, { "name": "LatestDeliveryDateBefore", "in": "query", - "description": "A date used for selecting orders with a latest delivery date before (or at) a specified time. The date must be in ISO 8601 format.", + "description": "Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "required": false, "type": "string" }, { "name": "LatestDeliveryDateAfter", "in": "query", - "description": "A date used for selecting orders with a latest delivery date after (or at) a specified time. The date must be in ISO 8601 format.", + "description": "Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "required": false, "type": "string" } @@ -601,7 +601,7 @@ "tags": [ "ordersV0" ], - "description": "Returns the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrder", "parameters": [ { @@ -933,7 +933,7 @@ "tags": [ "ordersV0" ], - "description": "Returns buyer information for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns buyer information for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrderBuyerInfo", "parameters": [ { @@ -1103,7 +1103,7 @@ "tags": [ "ordersV0" ], - "description": "Returns the shipping address for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns the shipping address for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrderAddress", "parameters": [ { @@ -1278,12 +1278,228 @@ } } }, + "/orders/v0/orders/{orderId}/fulfillmentInstructions": { + "get": { + "tags": [ + "ordersV0" + ], + "description": "Returns the fulfillment instructions for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getOrderFulfillmentInstructions", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "An Amazon-defined order identifier, in 3-7-7 format.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse" + }, + "examples": { + "application/json":{ + "payload": { + "AmazonOrderId": "902-3159896-1390916", + "FulfillmentPlans": [ + { + "CreationDate": "2023-10-25T12:00:00Z", + "FulfillmentPlanId" : "1", + "FulfillmentType" : "SHIP", + "FulfillmentPlanStatus": "ACTIVE", + "LastStatusUpdateDate" : "2023-10-25T12:00:00Z", + "FulfillmentPlanItems": [ + { + "OrderItemId": "6217867064725", + "Measurement" : { + "Unit" : "COUNT", + "Value" : 20 + } + } + ], + "ShippingInstructions": { + "CarrierCode": "UPS", + "ShippingMethod": "Ground", + "ShippingConstraints" : { + "PalletDelivery" : "MANDATORY" + } + }, + "FulfillmentLocation": { + "SupplySourceId": "bb3e1352-a3b4-4b99-aeb7-b1a923837ef2" + } + } + ] + } + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "orderId": { + "value": "TEST_CASE_200" + } + } + }, + "response": { + "payload": { + "AmazonOrderId": "TEST_CASE_200", + "FulfillmentPlans": [{ + "CreationDate": "2023-10-25T12:00:00Z", + "FulfillmentPlanId" : "1", + "FulfillmentType" : "SHIP", + "FulfillmentPlanStatus": "ACTIVE", + "LastStatusUpdateDate" : "2023-10-25T12:00:00Z", + "FulfillmentPlanItems": [ + { + "OrderItemId": "6217867064725", + "Measurement" : { + "Unit" : "COUNT", + "Value" : 20 + } + } + ], + "ShippingInstructions": { + "CarrierCode": "UPS", + "ShippingMethod": "Ground", + "ShippingConstraints" : { + "PalletDelivery" : "MANDATORY" + } + }, + "FulfillmentLocation": { + "SupplySourceId": "bb3e1352-a3b4-4b99-aeb7-b1a923837ef2" + } + }] + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "orderId": { + "value": "TEST_CASE_400" + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Invalid Input" + } + ] + } + } + ] + } + }, + "403": { + "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "schema": { + "$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/GetOrderFulfillmentInstructionsResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + } + } + }, "/orders/v0/orders/{orderId}/orderItems": { "get": { "tags": [ "ordersV0" ], - "description": "Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items.\n\n**Note**: When an order is in the Pending state (the order has been placed but payment has not been authorized), the `getOrderItems` operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the `Unshipped`, `Partially Shipped`, or `Shipped` state, the `getOrderItems` operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items.\n\n__Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrderItems", "parameters": [ { @@ -1575,7 +1791,7 @@ "tags": [ "ordersV0" ], - "description": "Returns buyer information for the order items in the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns buyer information for the order items in the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrderItemsBuyerInfo", "parameters": [ { @@ -1766,7 +1982,7 @@ "tags": [ "shipment" ], - "description": "Update the shipment status for an order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 15 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Update the shipment status for an order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 15 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "updateShipmentStatus", "parameters": [ { @@ -1829,7 +2045,7 @@ "errors": [ { "code": "InvalidInput", - "message": "Marketplace id is not defined", + "message": "Marketplace ID is not defined", "details": "1001" } ] @@ -1947,7 +2163,7 @@ "tags": [ "ordersV0" ], - "description": "Returns regulated information for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns regulated information for the order that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrderRegulatedInfo", "parameters": [ { @@ -2024,6 +2240,178 @@ } } } + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-2592119-3531015" + } + } + }, + "response": { + "payload": { + "AmazonOrderId": "902-2592119-3531015", + "RequiresDosageLabel": false, + "RegulatedInformation": { + "Fields": [ + { + "FieldId": "pets_rx_scName", + "FieldLabel": "Pet name", + "FieldType": "Text", + "FieldValue": "Woofer" + }, + { + "FieldId": "pets_rx_scType", + "FieldLabel": "Pet type", + "FieldType": "Text", + "FieldValue": "Dog" + }, + { + "FieldId": "pets_rx_scBreed", + "FieldLabel": "Pet breed", + "FieldType": "Text", + "FieldValue": "Husky" + }, + { + "FieldId": "pets_rx_scGender", + "FieldLabel": "Pet gender", + "FieldType": "Text", + "FieldValue": "Female" + }, + { + "FieldId": "pets_rx_scDateOfBirth", + "FieldLabel": "Pet Birth Date", + "FieldType": "Text", + "FieldValue": "2016-05-01" + }, + { + "FieldId": "pets_rx_scWeight", + "FieldLabel": "Weight", + "FieldType": "Text", + "FieldValue": "12" + }, + { + "FieldId": "pets_rx_scWeightUnit", + "FieldLabel": "Weight Unit", + "FieldType": "Text", + "FieldValue": "Pound" + }, + { + "FieldId": "pets_rx_scHasAllergies", + "FieldLabel": "Does your pet have allergies?", + "FieldType": "Text", + "FieldValue": "False" + }, + { + "FieldId": "pets_rx_scTakesAdditionalMedications", + "FieldLabel": "Is your pet on any other medication?", + "FieldType": "Text", + "FieldValue": "False" + }, + { + "FieldId": "pets_rx_scHasOtherProblems", + "FieldLabel": "Any pet health problems?", + "FieldType": "Text", + "FieldValue": "False" + }, + { + "FieldId": "pets_rx_scSourceClinicId", + "FieldLabel": "Source Clinic ID", + "FieldType": "Text", + "FieldValue": "Clinic-1234" + }, + { + "FieldId": "pets_rx_scVetClinicName", + "FieldLabel": "Vet Clinic Name", + "FieldType": "Text", + "FieldValue": "Test Clinic" + }, + { + "FieldId": "pets_rx_scVetClinicCity", + "FieldLabel": "Vet Clinic City", + "FieldType": "Text", + "FieldValue": "Seattle" + }, + { + "FieldId": "pets_rx_scVetClinicState", + "FieldLabel": "Vet Clinic State", + "FieldType": "Text", + "FieldValue": "WA" + }, + { + "FieldId": "pets_rx_scVetClinicZipCode", + "FieldLabel": "Vet Clinic Zip Code", + "FieldType": "Text", + "FieldValue": "98000" + }, + { + "FieldId": "pets_rx_scVetClinicPhoneNumber", + "FieldLabel": "Vet Clinic Phone Number", + "FieldType": "Text", + "FieldValue": "2060000000" + } + ] + }, + "RegulatedOrderVerificationStatus": { + "Status": "Pending", + "RequiresMerchantAction": true, + "ValidRejectionReasons": [ + { + "RejectionReasonId": "pets_rx_sc_incorrect_product", + "RejectionReasonDescription": "Canceled order due to veterinarian indicating wrong product ordered" + }, { + "RejectionReasonId": "pets_rx_sc_no_vcpr", + "RejectionReasonDescription": "Canceled order due to veterinarian indicating they do not have you as their client" + }, { + "RejectionReasonId": "pets_rx_sc_visit_required", + "RejectionReasonDescription": "Canceled order due to veterinarian indicating they need to see your pet for an appointment" + },{ + "RejectionReasonId": "pets_rx_sc_wrx_required", + "RejectionReasonDescription": "Canceled order due to veterinarian policy requiring you pick up a written prescription and mail to pharmacy" + }, { + "RejectionReasonId": "pets_rx_sc_other", + "RejectionReasonDescription": "Canceled order due to prescription denied - contact your vetinarian" + }, { + "RejectionReasonId": "pets_rx_sc_therapy_change", + "RejectionReasonDescription": "Canceled order due to a change in therapy, follow up with your veterinarian" + }, { + "RejectionReasonId": "pets_rx_sc_wrong_weight", + "RejectionReasonDescription": "Canceled order due to incorrect pet weight on file, update weight and replace order or order correct product" + }, { + "RejectionReasonId": "pets_rx_sc_early_refill", + "RejectionReasonDescription": "Canceled due to refilling prescription order too soon" + }, { + "RejectionReasonId": "pets_rx_sc_wrong_species", + "RejectionReasonDescription": "Canceled due to ordering for wrong pet species, replace order for correct product" + }, { + "RejectionReasonId": "pets_rx_sc_duplicate", + "RejectionReasonDescription": "Canceled due to duplicate order identified" + }, { + "RejectionReasonId": "pets_rx_sc_invalid_rx", + "RejectionReasonDescription": "Canceled due to not receiving a valid prescription" + }, { + "RejectionReasonId": "pets_rx_sc_address_validation_error", + "RejectionReasonDescription": "Canceled due to a non-verified address, correct address and replace order" + }, { + "RejectionReasonId": "pets_rx_sc_no_clinic_match", + "RejectionReasonDescription": "Canceled due to no valid clinic match, provide complete and accurate details for vet clinic and replace order" + }, { + "RejectionReasonId": "pets_rx_sc_pharmacist_canceled", + "RejectionReasonDescription": "Order canceled by pharmacy" + } + ], + "ValidVerificationDetails": [ + { + "VerificationDetailType": "prescriptionDetail", + "ValidVerificationStatuses": [ + "Approved" + ] + } + ] + } + } + } } ] }, @@ -2239,7 +2627,7 @@ "tags": [ "ordersV0" ], - "description": "Updates (approves or rejects) the verification status of an order containing regulated products.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Updates (approves or rejects) the verification status of an order containing regulated products.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "updateVerificationStatus", "parameters": [ { @@ -2282,6 +2670,35 @@ } }, "response": {} + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "externalReviewerId": "reviewer1234", + "verificationDetails": { + "prescriptionDetail": + { + "prescriptionId": "Rx-1234", + "expirationDate": "2024-01-01T00:00:00Z", + "writtenQuantity": 3, + "totalRefillsAuthorized": 10, + "usageInstructions": "Take one per day by mouth with food", + "refillsRemaining": 10, + "clinicId": "ABC-1234" + } + } + } + } + } + } + }, + "response": {} } ] }, @@ -2352,6 +2769,82 @@ } ] } + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "status": "Rejected", + "rejectionReasonId": "shield_pom_vps_reject_incorrect_weight", + "verificationDetails": { + "prescriptionDetail": + { + "prescriptionId": "Rx-1234", + "expirationDate": "2024-01-01T00:00:00Z", + "writtenQuantity": 3, + "totalRefillsAuthorized": 10, + "usageInstructions": "Take one per day by mouth with food", + "refillsRemaining": 10, + "clinicId": "ABC-1234" + } + } + } + } + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Verification Detail `prescriptionDetail` is not supported when order is in Rejected status." + }, + { + "code": "InvalidInput", + "message": "Missing request parameter: externalReviewerId." + } + ] + } + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "externalReviewerId": "reviewer1234", + "verificationDetails": { + "prescriptionDetail": + { + "prescriptionId": "Rx-1234", + "expirationDate": "2024-01-01T00:00:00Z", + "writtenQuantity": 3, + "totalRefillsAuthorized": 10, + "usageInstructions": "Take one per day by mouth with food", + "refillsRemaining": 10 + } + } + } + } + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Missing required parameter(s) from prescriptionDetail value: clinicId" + } + ] + } } ] }, @@ -2465,7 +2958,7 @@ "tags": [ "ordersV0" ], - "description": "Updates the shipment confirmation status for a specified order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Updates the shipment confirmation status for a specified order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "confirmShipment", "parameters": [ { @@ -2478,7 +2971,7 @@ { "name": "payload", "in": "body", - "description": "The request body of the `confirmShipment` operation.", + "description": "Request body of `confirmShipment`.", "required": true, "schema": { "$ref": "#/definitions/ConfirmShipmentRequest" @@ -2719,16 +3212,19 @@ "$ref": "#/definitions/VerificationStatus" }, "externalReviewerId": { - "description": "The identifier for the order's regulated information reviewer.", + "description": "The identifier of the order's regulated information reviewer.", "type": "string" }, "rejectionReasonId": { - "description": "The unique identifier for the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected.", + "description": "The unique identifier of the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected.", "type": "string" + }, + "verificationDetails": { + "description": "Additional information regarding the verification of the order.", + "$ref": "#/definitions/VerificationDetails" } }, "required": [ - "status", "externalReviewerId" ] }, @@ -2766,7 +3262,7 @@ "type": "object", "properties": { "orderItemId": { - "description": "The unique identifier of the order item.", + "description": "The order item's unique identifier.", "type": "string" }, "quantity": { @@ -2894,6 +3390,20 @@ }, "description": "The response schema for the `getOrderItemsBuyerInfo` operation." }, + "GetOrderFulfillmentInstructionsResponse": { + "type": "object", + "properties": { + "payload" : { + "description": "The payload for the `getOrderFulfillmentInstructions` operation.", + "$ref": "#/definitions/FulfillmentInstructions" + }, + "errors": { + "description": "One or more unexpected errors occurred during the `getOrderFulfillmentInstructions` operation.", + "$ref": "#/definitions/ErrorList" + } + }, + "description": "The response schema for the `getOrderFulfillmentInstructions` operation." + }, "OrdersList": { "type": "object", "required": [ @@ -2909,11 +3419,11 @@ }, "LastUpdatedBefore": { "type": "string", - "description": "A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. All dates must be in ISO 8601 format." + "description": "Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. All dates must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." }, "CreatedBefore": { "type": "string", - "description": "A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format." + "description": "Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." } }, "description": "A list of orders along with additional information to make subsequent API calls." @@ -2948,7 +3458,7 @@ }, "LastUpdateDate": { "type": "string", - "description": "The date when the order was last updated.\n\n**Note**: `LastUpdateDate` is returned with an incorrect date for orders that were last updated before 2009-04-01." + "description": "The date when the order was last updated.\n\n__Note__: `LastUpdateDate` is returned with an incorrect date for orders that were last updated before 2009-04-01." }, "OrderStatus": { "type": "string", @@ -2966,7 +3476,7 @@ "x-docgen-enum-table-extension": [ { "value": "Pending", - "description": "The order has been placed but payment has not been authorized. The order is not ready for shipment. Note that for orders with OrderType = Standard, the initial order status is Pending. For orders with OrderType = Preorder, the initial order status is PendingAvailability, and the order passes into the Pending status when the payment authorization process begins." + "description": "The order has been placed but payment has not been authorized. The order is not ready for shipment. Note that for orders with `OrderType = Standard`, the initial order status is Pending. For orders with `OrderType = Preorder`, the initial order status is `PendingAvailability`, and the order passes into the Pending status when the payment authorization process begins." }, { "value": "Unshipped", @@ -2994,13 +3504,13 @@ }, { "value": "PendingAvailability", - "description": "This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future. The order is not ready for shipment." + "description": "This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date for the item is in the future. The order is not ready for shipment." } ] }, "FulfillmentChannel": { "type": "string", - "description": "Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN).", + "description": "Whether the order was fulfilled by Amazon (`AFN`) or by the seller (`MFN`).", "enum": [ "MFN", "AFN" @@ -3018,15 +3528,15 @@ }, "SalesChannel": { "type": "string", - "description": "The sales channel of the first item in the order." + "description": "The sales channel for the first item in the order." }, "OrderChannel": { "type": "string", - "description": "The order channel of the first item in the order." + "description": "The order channel for the first item in the order." }, "ShipServiceLevel": { "type": "string", - "description": "The shipment service level of the order." + "description": "The order's shipment service level." }, "OrderTotal": { "description": "The total charge for this order.", @@ -3041,12 +3551,12 @@ "description": "The number of items unshipped." }, "PaymentExecutionDetail": { - "description": "Information about sub-payment methods for a Cash On Delivery (COD) order.\n\n**Note**: For a COD order that is paid for using one sub-payment method, one `PaymentExecutionDetailItem` object is returned, with `PaymentExecutionDetailItem`/`PaymentMethod` = COD. For a COD order that is paid for using multiple sub-payment methods, two or more `PaymentExecutionDetailItem` objects are returned.", + "description": "Information about sub-payment methods for a cash-on-delivery (COD) order.\n\n__Note__: For a COD order that is paid for using one sub-payment method, one `PaymentExecutionDetailItem` object is returned, with `PaymentExecutionDetailItem`/`PaymentMethod = COD`. For a COD order that is paid for using multiple sub-payment methods, two or more `PaymentExecutionDetailItem` objects are returned.", "$ref": "#/definitions/PaymentExecutionDetailItemList" }, "PaymentMethod": { "type": "string", - "description": "The payment method for the order. This property is limited to Cash On Delivery (COD) and Convenience Store (CVS) payment methods. Unless you need the specific COD payment information provided by the `PaymentExecutionDetailItem` object, we recommend using the `PaymentMethodDetails` property to get payment method information.", + "description": "The payment method for the order. This property is limited to COD and CVS payment methods. Unless you need the specific COD payment information provided by the `PaymentExecutionDetailItem` object, we recommend using the `PaymentMethodDetails` property to get payment method information.", "enum": [ "COD", "CVS", @@ -3077,10 +3587,10 @@ }, "ShipmentServiceLevelCategory": { "type": "string", - "description": "The shipment service level category of the order.\n\n**Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, `Standard`." + "description": "The shipment service level category for the order.\n\n**Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, and `Standard`." }, "EasyShipShipmentStatus": { - "description": "The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.", + "description": "The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.", "$ref": "#/definitions/EasyShipShipmentStatus" }, "CbaDisplayableShippingLabel": { @@ -3089,7 +3599,7 @@ }, "OrderType": { "type": "string", - "description": "The type of the order.", + "description": "The order's type.", "enum": [ "StandardOrder", "LongLeadTimeOrder", @@ -3122,19 +3632,19 @@ }, "EarliestShipDate": { "type": "string", - "description": "The start of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.\n\n**Note**: `EarliestShipDate` might not be returned for orders placed before February 1, 2013." + "description": "The start of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders.\n\n__Note__: `EarliestShipDate` might not be returned for orders placed before February 1, 2013." }, "LatestShipDate": { "type": "string", - "description": "The end of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.\n\n**Note**: `LatestShipDate` might not be returned for orders placed before February 1, 2013." + "description": "The end of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders.\n\n__Note__: `LatestShipDate` might not be returned for orders placed before February 1, 2013." }, "EarliestDeliveryDate": { "type": "string", - "description": "The start of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders." + "description": "The start of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders." }, "LatestDeliveryDate": { "type": "string", - "description": "The end of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders that do not have a `PendingAvailability`, Pending, or Canceled status." + "description": "The end of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders that do not have a `PendingAvailability`, `Pending`, or `Canceled` status." }, "IsBusinessOrder": { "type": "boolean", @@ -3146,15 +3656,15 @@ }, "IsPremiumOrder": { "type": "boolean", - "description": "When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, see \"Premium Shipping Options\" in the Seller Central Help for your marketplace." + "description": "When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, refer to \"Premium Shipping Options\" in the Seller Central Help for your marketplace." }, "IsGlobalExpressEnabled": { "type": "boolean", - "description": "When true, the order is a GlobalExpress order." + "description": "When true, the order is a `GlobalExpress` order." }, "ReplacedOrderId": { "type": "string", - "description": "The order ID value for the order that is being replaced. Returned only if `IsReplacementOrder` = true." + "description": "The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true." }, "IsReplacementOrder": { "type": "boolean", @@ -3162,11 +3672,11 @@ }, "PromiseResponseDueDate": { "type": "string", - "description": "Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders." + "description": "Indicates the date by which the seller must respond to the buyer with an estimated ship date. Only returned for Sourcing on Demand orders." }, "IsEstimatedShipDateSet": { "type": "boolean", - "description": "When true, the estimated ship date is specified for the order. Returned only for Sourcing on Demand orders." + "description": "When true, the estimated ship date is set for the order. Only returned for Sourcing on Demand orders." }, "IsSoldByAB": { "type": "boolean", @@ -3189,21 +3699,21 @@ "x-docgen-enum-table-extension": [ { "value": "INDIVIDUAL", - "description": "Buyer should be issued an individual invoice." + "description": "Issues an individual invoice to the buyer." }, { "value": "BUSINESS", - "description": "Buyer should be issued a business invoice. Tax information is available in `BuyerTaxInformation` structure." + "description": "Issues a business invoice to the buyer. Tax information is available in `BuyerTaxInformation`." } ], "description": "The buyer's invoicing preference. Sellers can use this data to issue electronic invoices for orders in Turkey.\n\n**Note**: This attribute is only available in the Turkey marketplace." }, "BuyerTaxInformation": { - "description": "Contains the business invoice tax information. Sellers can use this data to issue electronic invoices for business orders in Turkey.\n\n**Note**:\n1. This attribute is only available in the Turkey marketplace for the orders that `BuyerInvoicePreference` is BUSINESS.\n2. The `BuyerTaxInformation` is a restricted data. Use a Restricted Data Token (RDT) and restricted Selling Partner API roles to access this restricted data.", + "description": "Contains the business invoice tax information. Sellers could use this data to issue electronic invoices for business orders in Turkey.\n\n**Note**:\n1. This attribute is only available in the Turkey marketplace for the orders that `BuyerInvoicePreference` is BUSINESS.\n2. The `BuyerTaxInformation` is a restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access this restricted data.", "$ref": "#/definitions/BuyerTaxInformation" }, "FulfillmentInstruction": { - "description": "Contains the instructions about the fulfillment like where should it be fulfilled from.", + "description": "Contains the instructions about the fulfillment, such as the location from where you want the order filled.", "$ref": "#/definitions/FulfillmentInstruction" }, "IsISPU": { @@ -3223,11 +3733,11 @@ "description": "The seller’s friendly name registered in the marketplace where the sale took place. Sellers can use this data to issue electronic invoices for orders in Brazil.\n\n**Note**: This attribute is only available in the Brazil marketplace for the orders with `Pending` or `Unshipped` status." }, "ShippingAddress": { - "description": "The shipping address for the order.\n\n**Note**:\n1. `ShippingAddress` is only available for orders with the following status values: `Unshipped`, `PartiallyShipped`, `Shipped` and `InvoiceUnconfirmed`.\n2. The `ShippingAddress` contains restricted data. Use a Restricted Data Token (RDT) and restricted Selling Partner API roles to access the restricted data in `ShippingAddress`, for example, `Name`, `AddressLine1`, `AddressLine2`, `AddressLine3`, `Phone`, `AddressType` and `ExtendedFields`.", + "description": "The shipping address for the order.\n\n**Note**:\n1. `ShippingAddress` is only available for orders with the following status values: Unshipped, `PartiallyShipped`, Shipped and `InvoiceUnconfirmed`.\n2. The `ShippingAddress` contains restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access the restricted data in `ShippingAddress`. For example, `Name`, `AddressLine1`, `AddressLine2`, `AddressLine3`, `Phone`, `AddressType`, and `ExtendedFields`.", "$ref": "#/definitions/Address" }, "BuyerInfo": { - "description": "Buyer information.\n\n**Note**: The `BuyerInfo` contains restricted data. Use a Restricted Data Token (RDT) and restricted Selling Partner API roles to access the restricted data in `BuyerInfo`, for example, `BuyerName`, `BuyerTaxInfo`, `PurchaseOrderNumber`.", + "description": "Buyer information.\n\n**Note**: The `BuyerInfo` contains restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access the restricted data in `BuyerInfo`. For example, `BuyerName`, `BuyerTaxInfo`, and `PurchaseOrderNumber`.", "$ref": "#/definitions/BuyerInfo" }, "AutomatedShippingSettings": { @@ -3273,7 +3783,7 @@ }, "PurchaseOrderNumber": { "type": "string", - "description": "The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout." + "description": "The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } }, "description": "Buyer information for an order." @@ -3308,7 +3818,7 @@ }, "RegulatedOrderVerificationStatus": { "type": "object", - "description": "The verification status of the order along with associated approval or rejection metadata.", + "description": "The verification status of the order, along with associated approval or rejection metadata.", "required": [ "Status", "RequiresMerchantAction", @@ -3336,17 +3846,24 @@ }, "ReviewDate": { "type": "string", - "description": "The date the order was reviewed. In ISO 8601 date time format." + "description": "The date the order was reviewed. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format." }, "ExternalReviewerId": { "type": "string", "description": "The identifier for the order's regulated information reviewer." + }, + "ValidVerificationDetails": { + "type": "array", + "description": "A list of valid verification details that may be provided and the criteria required for when the verification detail can be provided.", + "items": { + "$ref": "#/definitions/ValidVerificationDetail" + } } } }, "RejectionReason": { "type": "object", - "description": "The reason for rejecting the order's regulated information. Not present if the order isn't rejected.", + "description": "The reason for rejecting the order's regulated information. This is only present if the order is rejected.", "required": [ "RejectionReasonId", "RejectionReasonDescription" @@ -3362,6 +3879,84 @@ } } }, + "PrescriptionDetail": { + "type": "object", + "required": [ + "prescriptionId", + "expirationDate", + "writtenQuantity", + "totalRefillsAuthorized", + "refillsRemaining", + "clinicId", + "usageInstructions" + ], + "properties": { + "prescriptionId": { + "type": "string", + "description": "The identifier for the prescription used to verify the regulated product." + }, + "expirationDate": { + "type": "string", + "description": "The expiration date of the prescription used to verify the regulated product, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.", + "format": "date-time" + }, + "writtenQuantity": { + "type": "integer", + "description": "The number of units in each fill as provided in the prescription.", + "minimum": 1 + }, + "totalRefillsAuthorized": { + "type": "integer", + "description": "The total number of refills written in the original prescription used to verify the regulated product. If a prescription originally had no refills, this value must be 0.", + "minimum": 0 + }, + "refillsRemaining": { + "type": "integer", + "description": "The number of refills remaining for the prescription used to verify the regulated product. If a prescription originally had 10 total refills, this value must be `10` for the first order, `9` for the second order, and `0` for the eleventh order. If a prescription originally had no refills, this value must be 0.", + "minimum": 0 + }, + "clinicId": { + "type": "string", + "description": "The identifier for the clinic which provided the prescription used to verify the regulated product." + }, + "usageInstructions": { + "type": "string", + "description": "The instructions for the prescription as provided by the approver of the regulated product." + } + }, + "description": "Information about the prescription that is used to verify a regulated product. This must be provided once per order and reflect the seller’s own records. Only approved orders can have prescriptions." + }, + "ValidVerificationDetail": { + "type": "object", + "required": [ + "VerificationDetailType", + "ValidVerificationStatuses" + ], + "properties": { + "VerificationDetailType": { + "type": "string", + "description": "A supported type of verification detail. The type indicates which verification detail could be shared while updating the regulated order. Valid value: `prescriptionDetail`." + }, + "ValidVerificationStatuses": { + "type": "array", + "description": "A list of valid verification statuses where the associated verification detail type may be provided. For example, if the value of this field is [\"Approved\"], calls to provide the associated verification detail will fail for orders with a `VerificationStatus` of `Pending`, `Rejected`, `Expired`, or `Cancelled`.", + "items": { + "$ref": "#/definitions/VerificationStatus" + } + } + }, + "description": "The types of verification details that may be provided for the order and the criteria required for when the type of verification detail can be provided. The types of verification details allowed depend on the type of regulated product and will not change order to order." + }, + "VerificationDetails": { + "type": "object", + "properties": { + "prescriptionDetail": { + "$ref": "#/definitions/PrescriptionDetail", + "description": "Information regarding the prescription tied to the order." + } + }, + "description": "Additional information related to the verification of a regulated order." + }, "VerificationStatus": { "type": "string", "description": "The verification status of the order.", @@ -3423,11 +4018,11 @@ "properties": { "FieldId": { "type": "string", - "description": "The unique identifier for the field." + "description": "The unique identifier of the field." }, "FieldLabel": { "type": "string", - "description": "The name for the field." + "description": "The name of the field." }, "FieldType": { "type": "string", @@ -3439,17 +4034,17 @@ "x-docgen-enum-table-extension": [ { "value": "Text", - "description": "This field is a text representation of a response collected from the regulatory form." + "description": "This field is a text representation of the response collected from the regulatory form." }, { "value": "FileAttachment", - "description": "This field contains the link to an attachment collected from the regulatory form." + "description": "This field contains a link to an attachment collected from the regulatory form." } ] }, "FieldValue": { "type": "string", - "description": "The content of the field as collected in regulatory form. Note that `FileAttachment` type fields will contain a URL to download the attachment here." + "description": "The content of the field as collected in regulatory form. Note that `FileAttachment` type fields contain a URL where you can download the attachment." } } }, @@ -3465,10 +4060,10 @@ }, "BuyerCompanyName": { "type": "string", - "description": "The company name of the contact buyer. For Invoice By Amazon (IBA) orders, the buyer company should be Amazon entities." + "description": "The company name of the contact buyer. For IBA orders, the buyer company must be Amazon entities." }, "ShippingAddress": { - "description": "The shipping address for the order.\n\n**Note**: `ShippingAddress` is only available for orders with the following status values: `Unshipped`, `PartiallyShipped`, `Shipped` and `InvoiceUnconfirmed`.", + "description": "The shipping address for the order.\n\n**Note**: `ShippingAddress` is only available for orders with the following status values: `Unshipped`, `PartiallyShipped`, `Shipped`, and `InvoiceUnconfirmed`.", "$ref": "#/definitions/Address" }, "DeliveryPreferences": { @@ -3533,10 +4128,10 @@ }, "Phone": { "type": "string", - "description": "The phone number of the buyer.\n\n**Note**: \n1. This attribute is only available for shipping address.\n2. The buyer `Phone` number is suppressed in some cases, including but not limited to \na. `Phone` is suppressed for all Fulfillment by Amazon (FBA) orders.\nb. `Phone` is suppressed for the shipped MFN(Fulfilled by the seller) order when current date is past Latest Delivery Date." + "description": "The phone number of the buyer.\n\n**Note**: \n1. This attribute is only available for shipping address.\n2. In some cases, the buyer phone number is suppressed: \na. Phone is suppressed for all `AFN` (fulfilled by Amazon) orders.\nb. Phone is suppressed for the shipped `MFN` (fulfilled by seller) order when the current date is past the Latest Delivery Date." }, "ExtendedFields": { - "description": "The container for address extended fields. For example, street name or street number.\n\nNote: Only available for Brazil shipping addresses.", + "description": "The container for address extended fields. For example, street name or street number. \n\n**Note**: This attribute is currently only available with Brazil shipping addresses.", "$ref": "#/definitions/AddressExtendedFields" }, "AddressType": { @@ -3569,7 +4164,7 @@ }, "StreetNumber": { "type": "string", - "description": "The house number/building number/property number in the street." + "description": "The house, building, or property number associated with the location's street address." }, "Complement": { "type": "string", @@ -3577,10 +4172,10 @@ }, "Neighborhood": { "type": "string", - "description": "The neighborhood. It's smaller than a region and an integral part of an address. It is used in some countries like Brazil." + "description": "The neighborhood. This value is only used in some countries (such as Brazil)." } }, - "description": "The container of extended address fields. For example, street name, street number. Only available with Brazil shipping addresses as of now." + "description": "The container for address extended fields (such as `street name` and `street number`). Currently only available with Brazil shipping addresses." }, "DeliveryPreferences": { "type": "object", @@ -3623,7 +4218,7 @@ "items": { "$ref": "#/definitions/ExceptionDates" }, - "description": "Dates when the business is closed in the next 30 days." + "description": "Dates when the business is closed during the next 30 days." } } }, @@ -3795,7 +4390,7 @@ }, "PaymentMethod": { "type": "string", - "description": "A sub-payment method for a COD order.\n\n**Possible values**:\n* `COD`: Cash On Delivery.\n* `GC`: Gift Card.\n* `PointsAccount`: Amazon Points.\n* `Invoice`: Invoice." + "description": "A sub-payment method for a COD order.\n\n**Possible values**:\n* `COD`: Cash on delivery \n* `GC`: Gift card \n* `PointsAccount`: Amazon Points\n* `Invoice`: Invoice" } }, "description": "Information about a sub-payment method used to pay for a COD order." @@ -3846,7 +4441,7 @@ "description": "The buyer's tax identifier." } }, - "description": "The tax classification for the order." + "description": "The tax classification of the order." }, "OrderItemsList": { "type": "object", @@ -3886,11 +4481,11 @@ "properties": { "ASIN": { "type": "string", - "description": "The Amazon Standard Identification Number (ASIN) of the item." + "description": "The item's Amazon Standard Identification Number (ASIN)." }, "SellerSKU": { "type": "string", - "description": "The seller stock keeping unit (SKU) of the item." + "description": "The item's seller stock keeping unit (SKU)." }, "OrderItemId": { "type": "string", @@ -3905,7 +4500,7 @@ }, "Title": { "type": "string", - "description": "The name of the item." + "description": "The item's name." }, "QuantityOrdered": { "type": "integer", @@ -3916,7 +4511,7 @@ "description": "The number of items shipped." }, "ProductInfo": { - "description": "Product information for the item.", + "description": "The item's product information.", "$ref": "#/definitions/ProductInfoDetail" }, "PointsGranted": { @@ -3924,11 +4519,11 @@ "$ref": "#/definitions/PointsGrantedDetail" }, "ItemPrice": { - "description": "The selling price of the order item. An order item is an item and a quantity. This means that the value of `ItemPrice` is equal to the selling price of the item multiplied by the quantity ordered. Note that `ItemPrice` excludes `ShippingPrice` and `GiftWrapPrice`.", + "description": "The selling price of the order item. Note that an order item is an item and a quantity. This means that the value of `ItemPrice` is equal to the selling price of the item multiplied by the quantity ordered. `ItemPrice` excludes `ShippingPrice` and GiftWrapPrice.", "$ref": "#/definitions/Money" }, "ShippingPrice": { - "description": "The shipping price of the item.", + "description": "The item's shipping price.", "$ref": "#/definitions/Money" }, "ItemTax": { @@ -3968,31 +4563,31 @@ }, "IsGift": { "type": "string", - "description": "Indicates whether the item is a gift.\n\n**Possible values**: `true`, `false`." + "description": "Indicates whether the item is a gift.\n\n**Possible values**: `true` and `false`." }, "ConditionNote": { "type": "string", - "description": "The condition of the item as described by the seller." + "description": "The condition of the item, as described by the seller." }, "ConditionId": { "type": "string", - "description": "The condition of the item.\n\n**Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, `Club`." + "description": "The condition of the item.\n\n**Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, and `Club`." }, "ConditionSubtypeId": { "type": "string", - "description": "The subcondition of the item.\n\n**Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, `Other`." + "description": "The subcondition of the item.\n\n**Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, and `Other`." }, "ScheduledDeliveryStartDate": { "type": "string", - "description": "The start date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format." + "description": "The start date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format." }, "ScheduledDeliveryEndDate": { "type": "string", - "description": "The end date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format." + "description": "The end date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format." }, "PriceDesignation": { "type": "string", - "description": "Indicates that the selling price is a special price that is available only for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to [Amazon Business](https://business.amazon.com). \n\n**Possible values**: `BusinessPrice` - A special price that is available only for Amazon Business orders." + "description": "Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). \n\n**Possible values**: `BusinessPrice`" }, "TaxCollection": { "description": "Information about withheld taxes.", @@ -4000,15 +4595,15 @@ }, "SerialNumberRequired": { "type": "boolean", - "description": "When true, the product type for this item has a serial number.\n\nReturned only for Amazon Easy Ship orders." + "description": "When true, the product type for this item has a serial number.\n\n Only returned for Amazon Easy Ship orders." }, "IsTransparency": { "type": "boolean", - "description": "When true, the ASIN is enrolled in Transparency and the Transparency serial number that needs to be submitted can be determined by the following:\n\n**1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN).\n**2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number will be applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.\n**QR code SN:** Submit the URL that the QR code generates." + "description": "When true, the ASIN is enrolled in Transparency. The Transparency serial number that you must submit is determined by:\n\n**1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN).\n**2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.\n**QR code SN:** Submit the URL that the QR code generates." }, "IossNumber": { "type": "string", - "description": "The IOSS number for the marketplace. Sellers shipping to the European Union (EU) from outside of the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale." + "description": "The IOSS number of the marketplace. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale." }, "StoreChainStoreId": { "type": "string", @@ -4033,7 +4628,7 @@ ] }, "BuyerInfo": { - "description": "A single item's buyer information.\n\n**Note**: The `BuyerInfo` contains restricted data. Use a Restricted Data Token (RDT) and restricted Selling Partner API roles to access the restricted data in `BuyerInfo`, for example, `BuyerCustomizedInfo` and `GiftMessageText`.", + "description": "A single item's buyer information.\n\n**Note**: The `BuyerInfo` contains restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access the restricted data in `BuyerInfo`. For example, `BuyerCustomizedInfo` and `GiftMessageText`.", "$ref": "#/definitions/ItemBuyerInfo" }, "BuyerRequestedCancel": { @@ -4048,7 +4643,7 @@ } }, "SubstitutionPreferences": { - "description": "Substitution preferences for the order item. This is an optional field and will only be present if seller supports substitutions like in case of some grocery sellers.", + "description": "Substitution preferences for the order item. This is an optional field that is only present if a seller supports substitutions, as is the case with some grocery sellers.", "$ref": "#/definitions/SubstitutionPreferences" }, "Measurement": { @@ -4088,7 +4683,7 @@ }, { "value": "DO_NOT_SUBSTITUTE", - "description": "Do not provide substitute if item is not found." + "description": "Do not provide a substitute if item is not found." } ] }, @@ -4111,7 +4706,7 @@ "properties": { "ASIN": { "type": "string", - "description": "The Amazon Standard Identification Number (ASIN) of the item." + "description": "The item's Amazon Standard Identification Number (ASIN)." }, "QuantityOrdered": { "type": "integer", @@ -4119,11 +4714,11 @@ }, "SellerSKU": { "type": "string", - "description": "The seller stock keeping unit (SKU) of the item." + "description": "The item's seller stock keeping unit (SKU)." }, "Title": { "type": "string", - "description": "The title of the item." + "description": "The item's title." }, "Measurement": { "description": "Measurement information for the substitution option.", @@ -4141,7 +4736,7 @@ "properties": { "Unit": { "type": "string", - "description": "The unit of measure for this measurement.", + "description": "The unit of measure.", "enum": [ "OUNCES", "POUNDS", @@ -4171,110 +4766,110 @@ "x-docgen-enum-table-extension": [ { "value": "OUNCES", - "description": "Indicates the item's measurement is measured in ounces." + "description": "The item is measured in ounces." }, { "value": "POUNDS", - "description": "Indicates the item's measurement is measured in pounds." + "description": "The item is measured in pounds." }, { "value": "KILOGRAMS", - "description": "Indicates the item's measurement is measured in kilograms." + "description": "The item is measured in kilograms." }, { "value": "GRAMS", - "description": "Indicates the item's measurement is measured in grams." + "description": "The item is measured in grams." }, { "value": "MILLIGRAMS", - "description": "Indicates the item's measurement is measured in milligrams." + "description": "The item is measured in milligrams." }, { "value": "INCHES", - "description": "Indicates the item's measurement is measured in inches." + "description": "The item is measured in inches." }, { "value": "FEET", - "description": "Indicates the item's measurement is measured in feet." + "description": "The item is measured in feet." }, { "value": "METERS", - "description": "Indicates the item's measurement is measured in meters." + "description": "The item is measured in meters." }, { "value": "CENTIMETERS", - "description": "Indicates the item's measurement is measured in centimeters." + "description": "The item is measured in centimeters." }, { "value": "MILLIMETERS", - "description": "Indicates the item's measurement is measured in millimeters." + "description": "The item is measured in millimeters." }, { "value": "SQUARE_METERS", - "description": "Indicates the item's measurement is measured in square meters." + "description": "The item is measured in square meters." }, { "value": "SQUARE_CENTIMETERS", - "description": "Indicates the item's measurement is measured in square centimeters." + "description": "The item is measured in square centimeters." }, { "value": "SQUARE_FEET", - "description": "Indicates the item's measurement is measured in square feet." + "description": "The item is measured in square feet." }, { "value": "SQUARE_INCHES", - "description": "Indicates the item's measurement is measured in square inches." + "description": "The item is measured in square inches." }, { "value": "GALLONS", - "description": "Indicates the item's measurement is measured in gallons." + "description": "The item is measured in gallons." }, { "value": "PINTS", - "description": "Indicates the item's measurement is measured in pints." + "description": "The item is measured in pints." }, { "value": "QUARTS", - "description": "Indicates the item's measurement is measured in quarts." + "description": "The item is measured in quarts." }, { "value": "FLUID_OUNCES", - "description": "Indicates the item's measurement is measured in fluid ounces." + "description": "The item is measured in fluid ounces." }, { "value": "LITERS", - "description": "Indicates the item's measurement is measured in liters." + "description": "The item is measured in liters." }, { "value": "CUBIC_METERS", - "description": "Indicates the item's measurement is measured in cubic meters." + "description": "The item is measured in cubic meters." }, { "value": "CUBIC_FEET", - "description": "Indicates the item's measurement is measured in cubic feet." + "description": "The item is measured in cubic feet." }, { "value": "CUBIC_INCHES", - "description": "Indicates the item's measurement is measured in cubic inches." + "description": "The item is measured in cubic inches." }, { "value": "CUBIC_CENTIMETERS", - "description": "Indicates the item's measurement is measured in cubic centimeters." + "description": "The item is measured in cubic centimeters." }, { "value": "COUNT", - "description": "Indicates the item's measurement is measured by count." + "description": "The item is measured by count." } ] }, "Value": { "type": "number", - "description": "The value of the measurement." + "description": "The measurement value." } } }, "AssociatedItem": { - "description": "An item associated with an order item. For example, a tire installation service purchased with tires.", + "description": "An item that is associated with an order item. For example, a tire installation service that is purchased with tires.", "type": "object", "properties": { "OrderId": { @@ -4342,7 +4937,7 @@ "description": "An Amazon-defined order item identifier." }, "BuyerCustomizedInfo": { - "description": "Buyer information for custom orders from the Amazon Custom program.\n\n**Note**: This attribute is only available for MFN (Fulfilled by the seller) orders.", + "description": "Buyer information for custom orders from the Amazon Custom program.\n\n**Note**: This attribute is only available for MFN (fulfilled by seller) orders.", "$ref": "#/definitions/BuyerCustomizedInfoDetail" }, "GiftWrapPrice": { @@ -4355,7 +4950,7 @@ }, "GiftMessageText": { "type": "string", - "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (Fulfilled by the seller) orders." + "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (fulfilled by seller) orders." }, "GiftWrapLevel": { "type": "string", @@ -4400,7 +4995,7 @@ "properties": { "CustomizedURL": { "type": "string", - "description": "The location of a zip file containing Amazon Custom data." + "description": "The location of a ZIP file containing Amazon Custom data." } }, "description": "Buyer information for custom orders from the Amazon Custom program." @@ -4463,18 +5058,170 @@ "type": "object", "properties": { "FulfillmentSupplySourceId": { - "description": "Denotes the recommended `sourceId` where the order should be fulfilled from.", + "description": "The `sourceId` of the location from where you want the order fulfilled.", "type": "string" } }, - "description": "Contains the instructions about the fulfillment like where should it be fulfilled from." + "description": "Contains the instructions about the fulfillment, such as the location from where you want the order filled." + }, + "FulfillmentInstructions": { + "type": "object", + "description": "Contains all fulfillment plans for the order", + "required": [ + "AmazonOrderId" + ], + "properties": { + "FulfillmentPlans": { + "type": "array", + "description": "List of all fulfillment plans for the given order id", + "items": { + "$ref": "#/definitions/FulfillmentPlan" + } + }, + "AmazonOrderId": { + "type": "string", + "description": "An Amazon-defined order identifier, in 3-7-7 format." + } + } + }, + "FulfillmentPlan": { + "type": "object", + "description": "A collection of order items that are to be fulfilled from the same location with the same shipping, pickup, and service instructions.", + "required": [ + "FulfillmentPlanId", + "CreationDate", + "FulfillmentType", + "FulfillmentPlanStatus", + "LastStatusUpdateDate", + "FulfillmentPlanItems" + ], + "properties": { + "FulfillmentPlanId": { + "type": "string", + "description": "Unique identifier for a fulfillment plan." + }, + "CreationDate": { + "type": "string", + "description": "Time when the fulfillment plan was created in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." + }, + "FulfillmentType": { + "type": "string", + "description": "Type of fulfillment", + "enum": [ + "INSTORE_PICKUP", + "SERVICE", + "SHIP" + ], + "x-docgen-enum-table-extension": [ + { + "value": "INSTORE_PICKUP", + "description": "Buyer picks up items in plan from store." + }, + { + "value": "SERVICE", + "description": "Services that are performed for the buyer, such as assembly." + }, + { + "value": "SHIP", + "description": "Shipped by seller through detailed ship method." + } + ] + }, + "FulfillmentPlanStatus": { + "type": "string", + "description": "The fulfillment plan status.", + "enum": [ + "ACTIVE", + "ABORTED", + "COMPLETED", + "PARTIALLY_FULFILLED" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ACTIVE", + "description": "The plan is ready to be fulfilled." + }, + { + "value": "ABORTED", + "description": "Plan was canceled, either through order canceling or replanning of shipment." + }, + { + "value": "COMPLETED", + "description": "Plan has been fulfilled and completed." + }, + { + "value": "PARTIALLY_FULFILLED", + "description": "Plan has been partially fulfilled." + } + ] + }, + "LastStatusUpdateDate": { + "type": "string", + "description": "The time when the fulfillment plan's status was last updated in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format." + }, + "FulfillmentLocation": { + "description": "Represents the location where the plan is fulfilled.", + "$ref": "#/definitions/FulfillmentLocation" + }, + "ShippingInstructions": { + "description": "The shipping-related information for a delivery.", + "$ref": "#/definitions/ShippingInstructions" + }, + "FulfillmentPlanItems": { + "description": "The details of the order items that are included in the fulfillment plan.", + "type": "array", + "items": { + "$ref": "#/definitions/FulfillmentPlanItem" + } + } + } + }, + "FulfillmentLocation": { + "type": "object", + "description": "Represents a location from which the plan is to be fulfilled.", + "properties": { + "SupplySourceId": { + "type": "string", + "description": "The fulfillment location identifier." + } + } + }, + "ShippingInstructions": { + "type": "object", + "description": "The shipping-related information of a delivery.", + "properties": { + "CarrierCode": { + "description": "The name of the carrier that delivers the package.", + "type": "string" + }, + "ShippingMethod": { + "description": "The ship method that is used for the order.", + "type": "string" + }, + "ShippingConstraints": { + "description": "Models constraints around shipping", + "$ref": "#/definitions/FulfillmentPlanShippingConstraints" + } + } }, "ShippingConstraints": { "type": "object", "description": "Delivery constraints applicable to this order.", "properties": { "PalletDelivery": { - "description": "Indicates if the line item needs to be delivered by pallet", + "description": "Indicates if the line item needs to be delivered by pallet.", + "$ref": "#/definitions/ConstraintType" + }, + "SignatureConfirmation": { + "description": "Indicates that the recipient of the line item must sign to confirm its delivery.", + "$ref": "#/definitions/ConstraintType" + }, + "RecipientIdentityVerification": { + "description": "Indicates that the person receiving the line item must be the same as the intended recipient of the order.", + "$ref": "#/definitions/ConstraintType" + }, + "RecipientAgeVerification": { + "description": "Indicates that the carrier must confirm the recipient is of the legal age to receive the line item upon delivery.", "$ref": "#/definitions/ConstraintType" } } @@ -4492,6 +5239,56 @@ } ] }, + "FulfillmentPlanShippingConstraints": { + "type": "object", + "description" :"Delivery constraints applicable to this order.", + "properties" : { + "PalletDelivery": { + "description": "Indicates if the line item needs to be delivered by pallet.", + "$ref": "#/definitions/FulfillmentPlanConstraintType" + }, + "SignatureConfirmation": { + "description": "Indicates that the recipient of the line item needs to sign to confirm its delivery.", + "$ref": "#/definitions/FulfillmentPlanConstraintType" + } + } + }, + "FulfillmentPlanConstraintType": { + "type": "string", + "description" :"Details the importance of the constraint present on the item.", + "enum": [ + "MANDATORY", + "RECOMMENDED" + ], + "x-docgen-enum-table-extension": [ + { + "value": "MANDATORY", + "description": "Item must follow the constraint to ensure order is met with buyer's delivery requirements." + }, + { + "value": "RECOMMENDED", + "description": "Item is recommended to follow the constraint to ensure order is met with buyer's delivery requirements." + } + ] + }, + "FulfillmentPlanItem": { + "type": "object", + "description": "The order items associated with this fulfillment plan.", + "required": [ + "OrderItemId", + "Measurement" + ], + "properties": { + "OrderItemId": { + "type": "string", + "description": "An Amazon-defined associated order item's order item identifier." + }, + "Measurement": { + "description": "Measurement information for the order item.", + "$ref": "#/definitions/Measurement" + } + } + }, "BuyerInfo": { "type": "object", "properties": { @@ -4513,7 +5310,7 @@ }, "PurchaseOrderNumber": { "type": "string", - "description": "The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout." + "description": "The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout." } }, "description": "Buyer information." @@ -4522,7 +5319,7 @@ "type": "object", "properties": { "BuyerCustomizedInfo": { - "description": "Buyer information for custom orders from the Amazon Custom program.\n\n**Note**: This attribute is only available for MFN (Fulfilled by the seller) orders.", + "description": "Buyer information for custom orders from the Amazon Custom program.\n\n**Note**: This attribute is only available for MFN (fulfilled by seller) orders.", "$ref": "#/definitions/BuyerCustomizedInfoDetail" }, "GiftWrapPrice": { @@ -4535,7 +5332,7 @@ }, "GiftMessageText": { "type": "string", - "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (Fulfilled by the seller) orders." + "description": "A gift message provided by the buyer.\n\n**Note**: This attribute is only available for MFN (fulfilled by seller) orders." }, "GiftWrapLevel": { "type": "string", @@ -4577,7 +5374,7 @@ "description": "Information about whether or not a buyer requested cancellation." }, "EasyShipShipmentStatus": { - "description": "The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.", + "description": "The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.", "type": "string", "enum": [ "PendingSchedule", @@ -4709,7 +5506,7 @@ }, "codCollectionMethod": { "type": "string", - "description": "The cod collection method, support in JP only. ", + "description": "The COD collection method (only supported in the JP marketplace).", "enum":["DirectPayment"] }, "marketplaceId": { @@ -4744,11 +5541,11 @@ }, "carrierCode": { "type": "string", - "description": "Identifies the carrier that will deliver the package. This field is required for all marketplaces. For the acceptable `CarrierCode` value, refer to the list of CarrierCode." + "description": "Identifies the carrier that will deliver the package. This field is required for all marketplaces. For more information, refer to the [`CarrierCode` announcement](https://developer-docs.amazon.com/sp-api/changelog/carriercode-value-required-in-shipment-confirmations-for-br-mx-ca-sg-au-in-jp-marketplaces)." }, "carrierName": { "type": "string", - "description": "Carrier Name that will deliver the package. Required when carrierCode is \"Others\" " + "description": "Carrier Name that will deliver the package. Required when `carrierCode` is \"Others\" " }, "shippingMethod": { "type": "string", @@ -4765,7 +5562,7 @@ }, "shipFromSupplySourceId": { "type": "string", - "description": "The unique identifier of the supply source." + "description": "The unique identifier for the supply source." }, "orderItems": { "description": "The list of order items and quantities to be updated.", @@ -4790,11 +5587,11 @@ "properties": { "orderItemId": { "type": "string", - "description": "The unique identifier of the order item." + "description": "The order item's unique identifier." }, "quantity": { "type": "integer", - "description": "The quantity of the item." + "description": "The item's quantity." }, "transparencyCodes": { "description": "The list of transparency codes.", @@ -4811,7 +5608,7 @@ }, "TransparencyCode": { "type": "string", - "description": "The Transparency code associated with the item." + "description": "The transparency code associated with the item." }, "PackageReferenceId": { "type": "string", diff --git a/models/product-pricing-api-model/productPricing_2022-05-01.json b/models/product-pricing-api-model/productPricing_2022-05-01.json index a0e6f46..2351146 100644 --- a/models/product-pricing-api-model/productPricing_2022-05-01.json +++ b/models/product-pricing-api-model/productPricing_2022-05-01.json @@ -1756,9 +1756,6 @@ "FeaturedOfferExpectedPriceResponseBody": { "description": "The featured offer expected price response data for a requested SKU.", "type": "object", - "required": [ - "offerIdentifier" - ], "properties": { "offerIdentifier": { "description": "Metadata that identifies the target offer for which the featured offer expected price result data was computed.",