Update Orders and add Catalog Items

models/orders-api-model/ordersV0.json

@@ -29,7 +29,7 @@
         "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 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 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 Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0167 | 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": "getOrders",
         "parameters": [
           {
@@ -203,6 +203,7 @@
                       "LatestShipDate": "2017-01-25T19:49:35Z",
                       "IsBusinessOrder": false,
                       "IsPrime": false,
+                      "IsAccessPointOrder": false,
                       "IsGlobalExpressEnabled": false,
                       "IsPremiumOrder": false,
                       "IsSoldByAB": false,
@@ -303,6 +304,7 @@
                           "FulfillmentSupplySourceId": "sampleSupplySourceId"
                         },
                         "IsISPU": false,
+                        "IsAccessPointOrder": false,
                         "AutomatedShippingSettings": {
                           "HasAutomatedShippingSettings": false
                         }
@@ -335,6 +337,7 @@
                         "LatestDeliveryDate": "1970-01-19T04:15:17Z",
                         "IsBusinessOrder": false,
                         "IsPrime": false,
+                        "IsAccessPointOrder": false,
                         "IsGlobalExpressEnabled": false,
                         "IsPremiumOrder": false,
                         "IsSoldByAB": false,
@@ -381,6 +384,7 @@
                         "LatestShipDate": "2017-01-25T19:49:35Z",
                         "IsBusinessOrder": false,
                         "IsPrime": false,
+                        "IsAccessPointOrder": false,
                         "IsGlobalExpressEnabled": false,
                         "IsPremiumOrder": false,
                         "IsSoldByAB": false,
@@ -429,6 +433,7 @@
                         "LatestShipDate": "2017-01-25T19:49:35Z",
                         "IsBusinessOrder": false,
                         "IsPrime": false,
+                        "IsAccessPointOrder": false,
                         "IsGlobalExpressEnabled": false,
                         "IsPremiumOrder": false,
                         "IsSoldByAB": false,
@@ -562,7 +567,7 @@
         "tags": [
           "ordersV0"
         ],
-        "description": "Returns 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 order indicated by the specified order ID.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0167 | 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": "getOrder",
         "parameters": [
           {
@@ -619,6 +624,7 @@
                     "FulfillmentSupplySourceId": "sampleSupplySourceId"
                   },
                   "IsISPU": false,
+                  "IsAccessPointOrder": false,
                   "ShippingAddress": {
                     "Name": "Michigan address",
                     "AddressLine1": "1 Cross St.",
@@ -708,6 +714,7 @@
                       "FulfillmentSupplySourceId": "sampleSupplySourceId"
                     },
                     "IsISPU": false,
+                    "IsAccessPointOrder": false,
                     "AutomatedShippingSettings": {
                       "HasAutomatedShippingSettings": false
                     }
@@ -769,6 +776,7 @@
                       "FulfillmentSupplySourceId": "sampleSupplySourceId"
                     },
                     "IsISPU": false,
+                    "IsAccessPointOrder": false,
                     "AutomatedShippingSettings": {
                       "HasAutomatedShippingSettings": false
                     }
@@ -899,7 +907,7 @@
         "tags": [
           "ordersV0"
         ],
-        "description": "Returns buyer information for the specified order.\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**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0167 | 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": [
           {
@@ -1081,7 +1089,7 @@
         "tags": [
           "ordersV0"
         ],
-        "description": "Returns the shipping address for the specified order.\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**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0167 | 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": [
           {
@@ -1273,7 +1281,7 @@
         "tags": [
           "ordersV0"
         ],
-        "description": "Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it's used to retrieve the next page of order items.\n\nNote: 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 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 detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it's used to retrieve the next page of order items.\n\nNote: 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 Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.5 | 30 |\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": "getOrderItems",
         "parameters": [
           {
@@ -1576,7 +1584,7 @@
         "tags": [
           "ordersV0"
         ],
-        "description": "Returns buyer information for the order items in the specified order.\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**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.5 | 30 |\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": [
           {
@@ -1779,7 +1787,7 @@
         "tags": [
           "shipment"
         ],
-        "description": "Update the shipment status.",
+        "description": "Update the shipment status.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 15 |\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": "updateShipmentStatus",
         "parameters": [
           {
@@ -1960,7 +1968,7 @@
         "tags": [
           "ordersV0"
         ],
-        "description": "Returns regulated 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 regulated 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.5 | 30 |\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": "getOrderRegulatedInfo",
         "parameters": [
           {
@@ -2216,10 +2224,6 @@
               "$ref": "#/definitions/GetOrderRegulatedInfoResponse"
             },
             "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 ID."
@@ -2232,10 +2236,6 @@
               "$ref": "#/definitions/GetOrderRegulatedInfoResponse"
             },
             "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 ID."
@@ -2248,10 +2248,6 @@
               "$ref": "#/definitions/GetOrderRegulatedInfoResponse"
             },
             "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 ID."
@@ -2264,7 +2260,7 @@
         "tags": [
           "ordersV0"
         ],
-        "description": "Updates (approves or rejects) the verification status of an order containing regulated products.\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": "Updates (approves or rejects) the verification status of an order containing regulated products.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.5 | 30 |\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": "updateVerificationStatus",
         "parameters": [
           {
@@ -2525,21 +2521,7 @@
       "properties": {
         "status": {
           "description": "The new verification status of the order.",
-          "type": "string",
+          "$ref": "#/definitions/VerificationStatus"
-          "enum": [
-            "Approved",
-            "Rejected"
-          ],
-          "x-docgen-enum-table-extension": [
-            {
-              "value": "Approved",
-              "description": "The order's regulated information has been reviewed and approved."
-            },
-            {
-              "value": "Rejected",
-              "description": "The order's regulated information has been reviewed and rejected."
-            }
-          ]
         },
         "externalReviewerId": {
           "description": "The identifier for the order's regulated information reviewer.",
@@ -3019,6 +3001,10 @@
           "type": "boolean",
           "description": "When true, this order is marked to be picked up from a store rather than delivered."
         },
+        "IsAccessPointOrder": {
+          "type": "boolean",
+          "description": "When true, this order is marked to be delivered to an Access Point. The access location is chosen by the customer. Access Points include Amazon Hub Lockers, Amazon Hub Counters, and pickup points operated by carriers."
+        },
         "MarketplaceTaxInfo": {
           "description": "Tax information about the marketplace.",
           "$ref": "#/definitions/MarketplaceTaxInfo"
@@ -3115,37 +3101,8 @@
       ],
       "properties": {
         "Status": {
-          "type": "string",
           "description": "The verification status of the order.",
-          "enum": [
+          "$ref": "#/definitions/VerificationStatus"
-            "Pending",
-            "Approved",
-            "Rejected",
-            "Expired",
-            "Cancelled"
-          ],
-          "x-docgen-enum-table-extension": [
-            {
-              "value": "Pending",
-              "description": "The order is pending approval. Note the approval might be needed from someone other than the merchant as determined by the RequiresMerchantAction field."
-            },
-            {
-              "value": "Approved",
-              "description": "The order's regulated information has been reviewed and approved."
-            },
-            {
-              "value": "Rejected",
-              "description": "The order's regulated information has been reviewed and rejected."
-            },
-            {
-              "value": "Expired",
-              "description": "The time to review the order's regulated information has expired."
-            },
-            {
-              "value": "Cancelled",
-              "description": "The order was cancelled by the purchaser."
-            }
-          ]
         },
         "RequiresMerchantAction": {
           "type": "boolean",
@@ -3190,6 +3147,39 @@
         }
       }
     },
+    "VerificationStatus": {
+      "type": "string",
+      "description": "The verification status of the order.",
+      "enum": [
+        "Pending",
+        "Approved",
+        "Rejected",
+        "Expired",
+        "Cancelled"
+      ],
+      "x-docgen-enum-table-extension": [
+        {
+          "value": "Pending",
+          "description": "The order is pending approval. Note the approval might be needed from someone other than the merchant as determined by the RequiresMerchantAction field."
+        },
+        {
+          "value": "Approved",
+          "description": "The order's regulated information has been reviewed and approved."
+        },
+        {
+          "value": "Rejected",
+          "description": "The order's regulated information has been reviewed and rejected."
+        },
+        {
+          "value": "Expired",
+          "description": "The time to review the order's regulated information has expired."
+        },
+        {
+          "value": "Cancelled",
+          "description": "The order was cancelled by the purchaser."
+        }
+      ]
+    },
     "RegulatedInformation": {
       "type": "object",
       "description": "The regulated information collected during purchase and used to verify the order.",
@@ -3864,7 +3854,7 @@
         },
         "BuyerCancelReason": {
           "type": "string",
-          "description": "Reason for buyer requesting cancel"
+          "description": "The reason that the buyer requested cancellation."
         }
       },
       "description": "Information about whether or not a buyer requested cancellation."