Improve support for RDT in bulk orders

Updated ordersV0.json to support an improved experience using RDT with
bulk orders. Also indicated that some error codes do not return rate
limit headers.

models/orders-api-model/ordersV0.json

@@ -205,7 +205,23 @@
                       "IsPrime": false,
                       "IsGlobalExpressEnabled": false,
                       "IsPremiumOrder": false,
-                      "IsSoldByAB": false
+                      "IsSoldByAB": false,
+                      "ShippingAddress": {
+                        "Name": "Michigan address",
+                        "AddressLine1": "1 Cross St.",
+                        "City": "Canton",
+                        "StateOrRegion": "MI",
+                        "PostalCode": "48817",
+                        "CountryCode": "US"
+                      },
+                      "BuyerInfo": {
+                        "BuyerEmail": "user@example.com",
+                        "BuyerName": "John Doe",
+                        "BuyerTaxInfo": {
+                          "CompanyLegalName": "A Company Name"
+                        },
+                        "PurchaseOrderNumber": "1234567890123"
+                      }
                     }
                   ]
                 }
@@ -486,7 +502,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -502,7 +518,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -518,7 +534,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -589,7 +605,23 @@
                   "FulfillmentInstruction": {
                     "FulfillmentSupplySourceId": "sampleSupplySourceId"
                   },
-                  "IsISPU": false
+                  "IsISPU": false,
+                  "ShippingAddress": {
+                    "Name": "Michigan address",
+                    "AddressLine1": "1 Cross St.",
+                    "City": "Canton",
+                    "StateOrRegion": "MI",
+                    "PostalCode": "48817",
+                    "CountryCode": "US"
+                  },
+                  "BuyerInfo": {
+                    "BuyerEmail": "user@example.com",
+                    "BuyerName": "John Doe",
+                    "BuyerTaxInfo": {
+                      "CompanyLegalName": "A Company Name"
+                    },
+                    "PurchaseOrderNumber": "1234567890123"
+                  }
                 }
               }
             },
@@ -791,7 +823,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -807,7 +839,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -823,7 +855,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -839,7 +871,7 @@
         "tags": [
           "ordersV0"
         ],
-        "description": "Returns buyer information for the order indicated by the specified order ID.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0055 | 20 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
+        "description": "Returns buyer information for the specified order.\n\n**Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md).\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0055 | 20 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
         "operationId": "getOrderBuyerInfo",
         "parameters": [
           {
@@ -860,12 +892,12 @@
               "application/json": {
                 "payload": {
                   "AmazonOrderId": "902-3159896-1390916",
-                  "BuyerEmail": "user@amz.com",
+                  "BuyerEmail": "user@example.com",
                   "BuyerName": "John Smith",
                   "BuyerTaxInfo": {
                     "CompanyLegalName": "Company Name"
                   },
-                  "PurchaseOrderNumber": "2234345435345"
+                  "PurchaseOrderNumber": "1234567890123"
                 }
               }
             },
@@ -891,7 +923,7 @@
                 "response": {
                   "payload": {
                     "AmazonOrderId": "902-1845936-5435065",
-                    "BuyerEmail": "fzyrv6gwkhbb15c@devo-marketplace.amazon.com",
+                    "BuyerEmail": "fzyrv6gwkhbb15c@example.com",
                     "BuyerName": "MFNIntegrationTestMerchant"
                   }
                 }
@@ -969,7 +1001,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -985,7 +1017,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -1001,7 +1033,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -1017,7 +1049,7 @@
         "tags": [
           "ordersV0"
         ],
-        "description": "Returns the shipping address for the order indicated by the specified order ID.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0055 | 20 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
+        "description": "Returns the shipping address for the specified order.\n\n**Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md).\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0055 | 20 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
         "operationId": "getOrderAddress",
         "parameters": [
           {
@@ -1157,7 +1189,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -1173,7 +1205,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -1189,7 +1221,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -1267,7 +1299,18 @@
                         "CurrencyCode": "JPY",
                         "Amount": "1.00"
                       },
-                      "priceDesignation": "BusinessPrice"
+                      "PriceDesignation": "BusinessPrice",
+                      "BuyerInfo": {
+                        "BuyerCustomizedInfo": {
+                          "CustomizedURL": "https://zme-caps.amazon.com/t/bR6qHkzSOxuB/J8nbWhze0Bd3DkajkOdY-XQbWkFralegp2sr_QZiKEE/1"
+                        },
+                        "GiftMessageText": "For you!",
+                        "GiftWrapPrice": {
+                          "CurrencyCode": "GBP",
+                          "Amount": "41.99"
+                        },
+                        "GiftWrapLevel": "Classic"
+                      }
                     },
                     {
                       "ASIN": "BCTU1104UEFB",
@@ -1285,7 +1328,18 @@
                       "ConditionId": "Used",
                       "ConditionSubtypeId": "Mint",
                       "ConditionNote": "Example ConditionNote",
-                      "PriceDesignation": "BusinessPrice"
+                      "PriceDesignation": "BusinessPrice",
+                      "BuyerInfo": {
+                        "BuyerCustomizedInfo": {
+                          "CustomizedURL": "https://zme-caps.amazon.com/t/bR6qHkzSOxuB/J8nbWhze0Bd3DkajkOdY-XQbWkFralegp2sr_QZiKEE/1"
+                        },
+                        "GiftMessageText": "For you!",
+                        "GiftWrapPrice": {
+                          "CurrencyCode": "JPY",
+                          "Amount": "1.99"
+                        },
+                        "GiftWrapLevel": "Classic"
+                      }
                     }
                   ]
                 }
@@ -1422,7 +1476,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -1438,7 +1492,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -1454,7 +1508,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -1470,7 +1524,7 @@
         "tags": [
           "ordersV0"
         ],
-        "description": "Returns buyer information in the order items of the order indicated by the specified order ID.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0055 | 20 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
+        "description": "Returns buyer information for the order items in the specified order.\n\n**Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md).\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0055 | 20 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
         "operationId": "getOrderItemsBuyerInfo",
         "parameters": [
           {
@@ -1621,7 +1675,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -1637,7 +1691,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -1653,7 +1707,7 @@
             "headers": {
               "x-amzn-RateLimit-Limit": {
                 "type": "string",
-                "description": "Your rate limit (requests per second) for this operation."
+                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
               },
               "x-amzn-RequestId": {
                 "type": "string",
@@ -2047,6 +2101,12 @@
         "SellerDisplayName": {
           "type": "string",
           "description": "The seller’s friendly name registered in the marketplace."
+        },
+        "ShippingAddress": {
+          "$ref": "#/definitions/Address"
+        },
+        "BuyerInfo": {
+          "$ref": "#/definitions/BuyerInfo"
         }
       },
       "description": "Order information."
@@ -2444,6 +2504,9 @@
               "description": "Union one stop shop. The item being purchased is held in the EU for shipment."
             }
           ]
+        },
+        "BuyerInfo": {
+          "$ref": "#/definitions/ItemBuyerInfo"
         }
       },
       "description": "A single order item."
@@ -2592,6 +2655,58 @@
       },
       "description": "Contains the instructions about the fulfillment like where should it be fulfilled from."
     },
+    "BuyerInfo": {
+      "type": "object",
+      "properties": {
+        "BuyerEmail": {
+          "type": "string",
+          "description": "The anonymized email address of the buyer."
+        },
+        "BuyerName": {
+          "type": "string",
+          "description": "The name of the buyer."
+        },
+        "BuyerCounty": {
+          "type": "string",
+          "description": "The county of the buyer."
+        },
+        "BuyerTaxInfo": {
+          "description": "Tax information about the buyer.",
+          "$ref": "#/definitions/BuyerTaxInfo"
+        },
+        "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": "Buyer information"
+    },
+    "ItemBuyerInfo": {
+      "type": "object",
+      "properties": {
+        "BuyerCustomizedInfo": {
+          "description": "Buyer information for custom orders from the Amazon Custom program.",
+          "$ref": "#/definitions/BuyerCustomizedInfoDetail"
+        },
+        "GiftWrapPrice": {
+          "description": "The gift wrap price of the item.",
+          "$ref": "#/definitions/Money"
+        },
+        "GiftWrapTax": {
+          "description": "The tax on the gift wrap price.",
+          "$ref": "#/definitions/Money"
+        },
+        "GiftMessageText": {
+          "type": "string",
+          "description": "A gift message provided by the buyer."
+        },
+        "GiftWrapLevel": {
+          "type": "string",
+          "description": "The gift wrap level specified by the buyer."
+        }
+      },
+      "description": "A single item's buyer information."
+    },
     "ErrorList": {
       "type": "array",
       "description": "A list of error responses returned when a request is unsuccessful.",