From 175bd9f29e103910fbfc5eaee217f692573247fc Mon Sep 17 00:00:00 2001 From: Abby Menting Date: Thu, 16 Sep 2021 17:11:36 -0700 Subject: [PATCH] Update sandbox extension and rate header descriptions --- .../merchantFulfillmentV0.json | 1866 +++++++++-------- 1 file changed, 978 insertions(+), 888 deletions(-) diff --git a/models/merchant-fulfillment-api-model/merchantFulfillmentV0.json b/models/merchant-fulfillment-api-model/merchantFulfillmentV0.json index 856f8af..546597d 100644 --- a/models/merchant-fulfillment-api-model/merchantFulfillmentV0.json +++ b/models/merchant-fulfillment-api-model/merchantFulfillmentV0.json @@ -37,7 +37,6 @@ "name": "body", "required": true, "schema": { - "description": "Request schema.", "$ref": "#/definitions/GetEligibleShipmentServicesRequest" } } @@ -45,17 +44,32 @@ "responses": { "200": { "description": "Success", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "body": { - "value": { - "ShipmentRequestDetails": { - "AmazonOrderId": "903-5563053-5647845", - "ItemList": [ - { - "OrderItemId": "52986411826454", + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/GetEligibleShipmentServicesResponse" + }, + "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": { + "body": { + "value": { + "ShipmentRequestDetails": { + "AmazonOrderId": "903-5563053-5647845", + "ItemList": [ + { + "OrderItemId": "52986411826454", "Quantity": 1 } ], @@ -187,35 +201,38 @@ ] } } - } - ], - "schema": { - "$ref": "#/definitions/GetEligibleShipmentServicesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + } + ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "body": { - "value": { - "ShipmentRequestDetails": { - "AmazonOrderId": "TEST_CASE_400", - "ItemList": [ - { - "OrderItemId": "52986411826454", + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/GetEligibleShipmentServicesResponse" + }, + "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": { + "body": { + "value": { + "ShipmentRequestDetails": { + "AmazonOrderId": "TEST_CASE_400", + "ItemList": [ + { + "OrderItemId": "52986411826454", "Quantity": 1 } ], @@ -249,29 +266,17 @@ } } }, - "response": { - "errors": [ - { - "code": "InvalidInput", - "message": "1 validation error detected: Value 'USA' at 'shipmentRequestDetails.shipFromAddress.countryCode' failed to satisfy constraint: Member must have length less than or equal to 2", - "details": "" - } - ] + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "1 validation error detected: Value 'USA' at 'shipmentRequestDetails.shipFromAddress.countryCode' failed to satisfy constraint: Member must have length less than or equal to 2", + "details": "" + } + ] + } } - } - ], - "schema": { - "$ref": "#/definitions/GetEligibleShipmentServicesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + ] } }, "401": { @@ -281,10 +286,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -296,7 +301,7 @@ "$ref": "#/definitions/GetEligibleShipmentServicesResponse" }, "headers": { - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -308,7 +313,11 @@ "$ref": "#/definitions/GetEligibleShipmentServicesResponse" }, "headers": { - "x-amzn-requestid": { + "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." } @@ -321,10 +330,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -337,10 +346,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -353,18 +362,17 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } - }, - "parameters": [] + } }, "/mfn/v0/eligibleShippingServices": { "post": { @@ -379,7 +387,6 @@ "name": "body", "required": true, "schema": { - "description": "Request schema.", "$ref": "#/definitions/GetEligibleShipmentServicesRequest" } } @@ -387,17 +394,32 @@ "responses": { "200": { "description": "Success", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "body": { - "value": { - "ShipmentRequestDetails": { - "AmazonOrderId": "903-5563053-5647845", - "ItemList": [ - { - "OrderItemId": "52986411826454", + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/GetEligibleShipmentServicesResponse" + }, + "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": { + "body": { + "value": { + "ShipmentRequestDetails": { + "AmazonOrderId": "903-5563053-5647845", + "ItemList": [ + { + "OrderItemId": "52986411826454", "Quantity": 1 } ], @@ -529,35 +551,38 @@ ] } } - } - ], - "schema": { - "$ref": "#/definitions/GetEligibleShipmentServicesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + } + ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "body": { - "value": { - "ShipmentRequestDetails": { - "AmazonOrderId": "TEST_CASE_400", - "ItemList": [ - { - "OrderItemId": "52986411826454", + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/GetEligibleShipmentServicesResponse" + }, + "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": { + "body": { + "value": { + "ShipmentRequestDetails": { + "AmazonOrderId": "TEST_CASE_400", + "ItemList": [ + { + "OrderItemId": "52986411826454", "Quantity": 1 } ], @@ -591,29 +616,17 @@ } } }, - "response": { - "errors": [ - { - "code": "InvalidInput", - "message": "1 validation error detected: Value 'USA' at 'shipmentRequestDetails.shipFromAddress.countryCode' failed to satisfy constraint: Member must have length less than or equal to 2", - "details": "" - } - ] + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "1 validation error detected: Value 'USA' at 'shipmentRequestDetails.shipFromAddress.countryCode' failed to satisfy constraint: Member must have length less than or equal to 2", + "details": "" + } + ] + } } - } - ], - "schema": { - "$ref": "#/definitions/GetEligibleShipmentServicesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + ] } }, "401": { @@ -623,10 +636,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -638,7 +651,7 @@ "$ref": "#/definitions/GetEligibleShipmentServicesResponse" }, "headers": { - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -650,7 +663,11 @@ "$ref": "#/definitions/GetEligibleShipmentServicesResponse" }, "headers": { - "x-amzn-requestid": { + "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." } @@ -663,10 +680,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -679,10 +696,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -695,18 +712,17 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } - }, - "parameters": [] + } }, "/mfn/v0/shipments/{shipmentId}": { "get": { @@ -728,17 +744,32 @@ "responses": { "200": { "description": "Success", - "x-amazon-spds-sandbox-behavior": [ - { - "request": { - "parameters": { - "shipmentId": { - "value": "abcddcba-00c3-4f6f-a63a-639f76ee9253" + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/GetShipmentResponse" + }, + "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": { + "shipmentId": { + "value": "abcddcba-00c3-4f6f-a63a-639f76ee9253" + } } - } - }, - "response": { - "payload": { + }, + "response": { + "payload": { "ShipmentId": "abcddcba-00c3-4f6f-a63a-639f76ee9253", "AmazonOrderId": "903-5563053-5647845", "SellerOrderId": "903-5563053-5647845", @@ -814,62 +845,52 @@ "Checksum": "9ALVyphCKfc3+Lb2ssyh8A==" } }, - "Status": "Purchased", - "TrackingId": "1Z17E2100206868939", - "CreatedDate": "2019-10-28T18:29:34Z", - "LastUpdatedDate": "2019-10-28T18:30:35Z" + "Status": "Purchased", + "TrackingId": "1Z17E2100206868939", + "CreatedDate": "2019-10-28T18:29:34Z", + "LastUpdatedDate": "2019-10-28T18:30:35Z" + } } } - } - ], - "schema": { - "$ref": "#/definitions/GetShipmentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", - "x-amazon-spds-sandbox-behavior": [ - { - "request": { - "parameters": { - "shipmentId": { - "value": "aabbccdd-1beb-4cda-8bf4-7366cfddbec1" - } - } - }, - "response": { - "errors": [ - { - "code": "InvalidInput", - "message": "1 validation error detected: Value 'TEST_CASE_400' at 'shipmentId' failed to satisfy constraint: Member must satisfy regular expression pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", - "details": "" - } - ] - } - } - ], "schema": { "$ref": "#/definitions/GetShipmentResponse" }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "description": "Your rate limit (requests per second) for this operation." }, - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "shipmentId": { + "value": "aabbccdd-1beb-4cda-8bf4-7366cfddbec1" + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "1 validation error detected: Value 'TEST_CASE_400' at 'shipmentId' failed to satisfy constraint: Member must satisfy regular expression pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", + "details": "" + } + ] + } + } + ] } }, "401": { @@ -879,10 +900,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -894,7 +915,7 @@ "$ref": "#/definitions/GetShipmentResponse" }, "headers": { - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -906,7 +927,11 @@ "$ref": "#/definitions/GetShipmentResponse" }, "headers": { - "x-amzn-requestid": { + "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." } @@ -919,10 +944,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -935,10 +960,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -951,10 +976,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -981,17 +1006,32 @@ "responses": { "200": { "description": "Success", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "shipmentId": { - "value": "be7a0a53-00c3-4f6f-a63a-639f76ee9253" + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/CancelShipmentResponse" + }, + "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": { + "shipmentId": { + "value": "be7a0a53-00c3-4f6f-a63a-639f76ee9253" + } } - } - }, - "response": { - "payload": { + }, + "response": { + "payload": { "ShipmentId": "be7a0a53-00c3-4f6f-a63a-639f76ee9253", "AmazonOrderId": "903-5563053-5647845", "SellerOrderId": "903-5563053-5647845", @@ -1063,62 +1103,53 @@ "Checksum": "" } }, - "Status": "RefundPending", - "TrackingId": "1Z17E2100206868939", - "CreatedDate": "2019-10-28T18:29:34Z", - "LastUpdatedDate": "2019-10-28T18:36:55Z" + "Status": "RefundPending", + "TrackingId": "1Z17E2100206868939", + "CreatedDate": "2019-10-28T18:29:34Z", + "LastUpdatedDate": "2019-10-28T18:36:55Z" + } } } - } - ], - "schema": { - "$ref": "#/definitions/CancelShipmentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "shipmentId": { - "value": "87d20cf7-1beb-4cda-8bf4-7366cfddbec1" - } - } - }, - "response": { - "errors": [ - { - "code": "InvalidInput", - "message": "1 validation error detected: Value 'TEST_CASE_400' at 'shipmentId' failed to satisfy constraint: Member must satisfy regular expression pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", - "details": "" - } - ] - } - } - ], "schema": { + "description": "Response schema.", "$ref": "#/definitions/CancelShipmentResponse" }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "description": "Your rate limit (requests per second) for this operation." }, - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "shipmentId": { + "value": "87d20cf7-1beb-4cda-8bf4-7366cfddbec1" + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "1 validation error detected: Value 'TEST_CASE_400' at 'shipmentId' failed to satisfy constraint: Member must satisfy regular expression pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", + "details": "" + } + ] + } + } + ] } }, "401": { @@ -1128,10 +1159,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1143,7 +1174,7 @@ "$ref": "#/definitions/CancelShipmentResponse" }, "headers": { - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1155,7 +1186,11 @@ "$ref": "#/definitions/CancelShipmentResponse" }, "headers": { - "x-amzn-requestid": { + "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." } @@ -1168,10 +1203,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1184,10 +1219,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1200,18 +1235,17 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } - }, - "parameters": [] + } }, "/mfn/v0/shipments/{shipmentId}/cancel": { "put": { @@ -1233,17 +1267,32 @@ "responses": { "200": { "description": "Success", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "shipmentId": { - "value": "be7a0a53-00c3-4f6f-a63a-639f76ee9253" + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/CancelShipmentResponse" + }, + "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": { + "shipmentId": { + "value": "be7a0a53-00c3-4f6f-a63a-639f76ee9253" + } } - } - }, - "response": { - "payload": { + }, + "response": { + "payload": { "ShipmentId": "be7a0a53-00c3-4f6f-a63a-639f76ee9253", "AmazonOrderId": "903-5563053-5647845", "SellerOrderId": "903-5563053-5647845", @@ -1315,62 +1364,53 @@ "Checksum": "" } }, - "Status": "RefundPending", - "TrackingId": "1Z17E2100206868939", - "CreatedDate": "2019-10-28T18:29:34Z", - "LastUpdatedDate": "2019-10-28T18:36:55Z" + "Status": "RefundPending", + "TrackingId": "1Z17E2100206868939", + "CreatedDate": "2019-10-28T18:29:34Z", + "LastUpdatedDate": "2019-10-28T18:36:55Z" + } } } - } - ], - "schema": { - "$ref": "#/definitions/CancelShipmentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "shipmentId": { - "value": "87d20cf7-1beb-4cda-8bf4-7366cfddbec1" - } - } - }, - "response": { - "errors": [ - { - "code": "InvalidInput", - "message": "1 validation error detected: Value 'TEST_CASE_400' at 'shipmentId' failed to satisfy constraint: Member must satisfy regular expression pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", - "details": "" - } - ] - } - } - ], "schema": { + "description": "Response schema.", "$ref": "#/definitions/CancelShipmentResponse" }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "description": "Your rate limit (requests per second) for this operation." }, - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "shipmentId": { + "value": "87d20cf7-1beb-4cda-8bf4-7366cfddbec1" + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "1 validation error detected: Value 'TEST_CASE_400' at 'shipmentId' failed to satisfy constraint: Member must satisfy regular expression pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", + "details": "" + } + ] + } + } + ] } }, "401": { @@ -1380,10 +1420,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1395,7 +1435,7 @@ "$ref": "#/definitions/CancelShipmentResponse" }, "headers": { - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1407,7 +1447,11 @@ "$ref": "#/definitions/CancelShipmentResponse" }, "headers": { - "x-amzn-requestid": { + "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." } @@ -1420,10 +1464,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1436,10 +1480,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1452,18 +1496,17 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } - }, - "parameters": [] + } }, "/mfn/v0/shipments": { "post": { @@ -1485,17 +1528,32 @@ "responses": { "200": { "description": "Success", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "body": { - "value": { - "ShipmentRequestDetails": { - "AmazonOrderId": "903-5563053-5647845", - "ItemList": [ - { - "OrderItemId": "52986411826454", + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/CreateShipmentResponse" + }, + "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": { + "body": { + "value": { + "ShipmentRequestDetails": { + "AmazonOrderId": "903-5563053-5647845", + "ItemList": [ + { + "OrderItemId": "52986411826454", "Quantity": 1 } ], @@ -1615,35 +1673,37 @@ "CreatedDate": "2019-10-28T16:37:43Z" } } - } - ], + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/CreateShipmentResponse" }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "description": "Your rate limit (requests per second) for this operation." }, - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "body": { - "value": { - "ShipmentRequestDetails": { - "AmazonOrderId": "TEST_CASE_400", - "ItemList": [ - { - "OrderItemId": "52986411826454", + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "body": { + "value": { + "ShipmentRequestDetails": { + "AmazonOrderId": "TEST_CASE_400", + "ItemList": [ + { + "OrderItemId": "52986411826454", "Quantity": 1 } ], @@ -1679,29 +1739,17 @@ } } }, - "response": { - "errors": [ - { - "code": "InvalidInput", - "message": "1 validation error detected: Value 'USA' at 'shipmentRequestDetails.shipFromAddress.countryCode' failed to satisfy constraint: Member must have length less than or equal to 2", - "details": "" - } - ] + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "1 validation error detected: Value 'USA' at 'shipmentRequestDetails.shipFromAddress.countryCode' failed to satisfy constraint: Member must have length less than or equal to 2", + "details": "" + } + ] + } } - } - ], - "schema": { - "$ref": "#/definitions/CreateShipmentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + ] } }, "401": { @@ -1711,10 +1759,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1726,7 +1774,7 @@ "$ref": "#/definitions/CreateShipmentResponse" }, "headers": { - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1738,7 +1786,11 @@ "$ref": "#/definitions/CreateShipmentResponse" }, "headers": { - "x-amzn-requestid": { + "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." } @@ -1751,10 +1803,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1767,10 +1819,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1783,18 +1835,17 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } - }, - "parameters": [] + } }, "/mfn/v0/sellerInputs": { "post": { @@ -1816,17 +1867,32 @@ "responses": { "200": { "description": "Success", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "body": { - "value": { - "ShippingServiceId": "UPS_PTP_GND", - "ShipFromAddress": { - "Name": "John Doe", - "AddressLine1": "300 Turnbull Ave", - "Email": "jdoeasdfllkj@yahoo.com", + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/GetAdditionalSellerInputsResponse" + }, + "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": { + "body": { + "value": { + "ShippingServiceId": "UPS_PTP_GND", + "ShipFromAddress": { + "Name": "John Doe", + "AddressLine1": "300 Turnbull Ave", + "Email": "jdoeasdfllkj@yahoo.com", "City": "Detroit", "StateOrProvinceCode": "MI", "PostalCode": "48123", @@ -1848,41 +1914,43 @@ "ItemLevelFieldsList": [ { "Asin": "ASIN_ID_200", - "AdditionalInputs": [ - ] + "AdditionalInputs": [] } ] } } - } - ], - "schema": { - "$ref": "#/definitions/GetAdditionalSellerInputsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + } + ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "body": { - "value": { - "ShippingServiceId": "UPS_PTP_GND", - "ShipFromAddress": { - "Name": "John Doe", - "AddressLine1": "300 Turnbull Ave", - "Email": "jdoeasdfllkj@yahoo.com", + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/GetAdditionalSellerInputsResponse" + }, + "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": { + "body": { + "value": { + "ShippingServiceId": "UPS_PTP_GND", + "ShipFromAddress": { + "Name": "John Doe", + "AddressLine1": "300 Turnbull Ave", + "Email": "jdoeasdfllkj@yahoo.com", "City": "Detroit", "StateOrProvinceCode": "MI", "PostalCode": "48123", @@ -1894,29 +1962,17 @@ } } }, - "response": { - "errors": [ - { - "code": "InvalidInput", - "message": "Invalid Ship From Address when calling GetAdditionalSellerInputs", - "details": "" - } - ] + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Invalid Ship From Address when calling GetAdditionalSellerInputs", + "details": "" + } + ] + } } - } - ], - "schema": { - "$ref": "#/definitions/GetAdditionalSellerInputsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + ] } }, "401": { @@ -1926,10 +1982,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1941,7 +1997,7 @@ "$ref": "#/definitions/GetAdditionalSellerInputsResponse" }, "headers": { - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1953,7 +2009,11 @@ "$ref": "#/definitions/GetAdditionalSellerInputsResponse" }, "headers": { - "x-amzn-requestid": { + "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." } @@ -1966,10 +2026,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1982,10 +2042,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -1998,18 +2058,17 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } - }, - "parameters": [] + } }, "/mfn/v0/additionalSellerInputs": { "post": { @@ -2031,17 +2090,32 @@ "responses": { "200": { "description": "Success", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "body": { - "value": { - "ShippingServiceId": "UPS_PTP_GND", - "ShipFromAddress": { - "Name": "John Doe", - "AddressLine1": "300 Turnbull Ave", - "Email": "jdoeasdfllkj@yahoo.com", + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/GetAdditionalSellerInputsResponse" + }, + "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": { + "body": { + "value": { + "ShippingServiceId": "UPS_PTP_GND", + "ShipFromAddress": { + "Name": "John Doe", + "AddressLine1": "300 Turnbull Ave", + "Email": "jdoeasdfllkj@yahoo.com", "City": "Detroit", "StateOrProvinceCode": "MI", "PostalCode": "48123", @@ -2063,41 +2137,43 @@ "ItemLevelFieldsList": [ { "Asin": "ASIN_ID_200", - "AdditionalInputs": [ - ] + "AdditionalInputs": [] } ] } } - } - ], - "schema": { - "$ref": "#/definitions/GetAdditionalSellerInputsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + } + ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "body": { - "value": { - "ShippingServiceId": "UPS_PTP_GND", - "ShipFromAddress": { - "Name": "John Doe", - "AddressLine1": "300 Turnbull Ave", - "Email": "jdoeasdfllkj@yahoo.com", + "schema": { + "description": "Response schema.", + "$ref": "#/definitions/GetAdditionalSellerInputsResponse" + }, + "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": { + "body": { + "value": { + "ShippingServiceId": "UPS_PTP_GND", + "ShipFromAddress": { + "Name": "John Doe", + "AddressLine1": "300 Turnbull Ave", + "Email": "jdoeasdfllkj@yahoo.com", "City": "Detroit", "StateOrProvinceCode": "MI", "PostalCode": "48123", @@ -2109,29 +2185,17 @@ } } }, - "response": { - "errors": [ - { - "code": "InvalidInput", - "message": "Invalid Ship From Address when calling GetAdditionalSellerInputs", - "details": "" - } - ] + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Invalid Ship From Address when calling GetAdditionalSellerInputs", + "details": "" + } + ] + } } - } - ], - "schema": { - "$ref": "#/definitions/GetAdditionalSellerInputsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-requestid": { - "type": "string", - "description": "Unique request reference identifier." - } + ] } }, "401": { @@ -2141,10 +2205,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -2156,7 +2220,7 @@ "$ref": "#/definitions/GetAdditionalSellerInputsResponse" }, "headers": { - "x-amzn-requestid": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -2168,7 +2232,11 @@ "$ref": "#/definitions/GetAdditionalSellerInputsResponse" }, "headers": { - "x-amzn-requestid": { + "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." } @@ -2181,10 +2249,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -2197,10 +2265,10 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } @@ -2213,18 +2281,17 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" + "type": "string", + "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": { + "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } - }, - "parameters": [] + } } }, "definitions": { @@ -2258,162 +2325,179 @@ } }, "LabelFormatOptionRequest": { - "description": "Whether to include a packing slip.", "type": "object", "properties": { "IncludePackingSlipWithLabel": { - "description": "When true, include a packing slip with the label.", - "type": "boolean" + "type": "boolean", + "description": "When true, include a packing slip with the label." } - } + }, + "description": "Whether to include a packing slip." }, - "LabelFormatOption" : { - "description": "The label format details and whether to include a packing slip.", - "type" : "object", - "properties" : { - "IncludePackingSlipWithLabel" : { - "description": "When true, include a packing slip with the label.", - "type" : "boolean" + "LabelFormatOption": { + "type": "object", + "properties": { + "IncludePackingSlipWithLabel": { + "type": "boolean", + "description": "When true, include a packing slip with the label." }, - "LabelFormat" : { - "$ref" : "#/definitions/LabelFormat" + "LabelFormat": { + "$ref": "#/definitions/LabelFormat" } - } + }, + "description": "The label format details and whether to include a packing slip." }, - "AvailableCarrierWillPickUpOption" : { - "description": "Indicates whether the carrier will pick up the package, and what fee is charged, if any.", - "type" : "object", - "required" : [ "CarrierWillPickUpOption", "Charge" ], - "properties" : { - "CarrierWillPickUpOption" : { - "$ref" : "#/definitions/CarrierWillPickUpOption" + "AvailableCarrierWillPickUpOption": { + "type": "object", + "required": [ + "CarrierWillPickUpOption", + "Charge" + ], + "properties": { + "CarrierWillPickUpOption": { + "$ref": "#/definitions/CarrierWillPickUpOption" }, - "Charge" : { + "Charge": { "description": "The fee charged.", - "$ref" : "#/definitions/CurrencyAmount" + "$ref": "#/definitions/CurrencyAmount" } - } + }, + "description": "Indicates whether the carrier will pick up the package, and what fee is charged, if any." }, - "AvailableCarrierWillPickUpOptionsList" : { + "AvailableCarrierWillPickUpOptionsList": { + "type": "array", "description": "List of available carrier pickup options.", - "type" : "array", - "items" : { - "$ref" : "#/definitions/AvailableCarrierWillPickUpOption" + "items": { + "$ref": "#/definitions/AvailableCarrierWillPickUpOption" } }, - "AvailableDeliveryExperienceOption" : { - "description": "The available delivery confirmation options, and the fee charged, if any.", - "type" : "object", - "required" : [ "DeliveryExperienceOption", "Charge" ], - "properties" : { - "DeliveryExperienceOption" : { - "$ref" : "#/definitions/DeliveryExperienceOption" + "AvailableDeliveryExperienceOption": { + "type": "object", + "required": [ + "Charge", + "DeliveryExperienceOption" + ], + "properties": { + "DeliveryExperienceOption": { + "$ref": "#/definitions/DeliveryExperienceOption" }, - "Charge" : { - "$ref" : "#/definitions/CurrencyAmount" + "Charge": { + "$ref": "#/definitions/CurrencyAmount" } - } + }, + "description": "The available delivery confirmation options, and the fee charged, if any." }, - "AvailableDeliveryExperienceOptionsList" : { + "AvailableDeliveryExperienceOptionsList": { + "type": "array", "description": "List of available delivery experience options.", - "type" : "array", - "items" : { - "$ref" : "#/definitions/AvailableDeliveryExperienceOption" + "items": { + "$ref": "#/definitions/AvailableDeliveryExperienceOption" } }, - "AvailableShippingServiceOptions" : { - "description": "The available shipping service options.", - "type" : "object", - "required" : [ "AvailableCarrierWillPickUpOptions", "AvailableDeliveryExperienceOptions" ], - "properties" : { - "AvailableCarrierWillPickUpOptions" : { - "$ref" : "#/definitions/AvailableCarrierWillPickUpOptionsList" + "AvailableShippingServiceOptions": { + "type": "object", + "required": [ + "AvailableCarrierWillPickUpOptions", + "AvailableDeliveryExperienceOptions" + ], + "properties": { + "AvailableCarrierWillPickUpOptions": { + "$ref": "#/definitions/AvailableCarrierWillPickUpOptionsList" }, - "AvailableDeliveryExperienceOptions" : { - "$ref" : "#/definitions/AvailableDeliveryExperienceOptionsList" + "AvailableDeliveryExperienceOptions": { + "$ref": "#/definitions/AvailableDeliveryExperienceOptionsList" } - } + }, + "description": "The available shipping service options." }, - "AvailableFormatOptionsForLabel" : { - "$ref" : "#/definitions/AvailableFormatOptionsForLabelList" + "AvailableFormatOptionsForLabel": { + "$ref": "#/definitions/AvailableFormatOptionsForLabelList" }, - "AvailableFormatOptionsForLabelList" : { + "AvailableFormatOptionsForLabelList": { + "type": "array", "description": "The available label formats.", - "type" : "array", - "items" : { - "$ref" : "#/definitions/LabelFormatOption" + "items": { + "$ref": "#/definitions/LabelFormatOption" } }, - "Constraint" : { - "description": "A validation constraint.", - "type" : "object", - "required" : [ "ValidationString" ], - "properties" : { - "ValidationRegEx" : { - "description": "A regular expression.", - "type" : "string" + "Constraint": { + "type": "object", + "required": [ + "ValidationString" + ], + "properties": { + "ValidationRegEx": { + "type": "string", + "description": "A regular expression." }, - "ValidationString" : { - "description": "A validation string.", - "type" : "string" + "ValidationString": { + "type": "string", + "description": "A validation string." } - } + }, + "description": "A validation constraint." }, - "Constraints" : { + "Constraints": { + "type": "array", "description": "List of constraints.", - "type" : "array", - "items" : { - "$ref" : "#/definitions/Constraint" + "items": { + "$ref": "#/definitions/Constraint" } }, - "AdditionalInputs" : { - "description": "Maps the additional seller input to the definition. The key to the map is the field name.", - "type" : "object", - "properties" : { - "AdditionalInputFieldName" : { - "description": "The field name.", - "type" : "string" + "AdditionalInputs": { + "type": "object", + "properties": { + "AdditionalInputFieldName": { + "type": "string", + "description": "The field name." }, - "SellerInputDefinition" : { - "$ref" : "#/definitions/SellerInputDefinition" + "SellerInputDefinition": { + "$ref": "#/definitions/SellerInputDefinition" } - } + }, + "description": "Maps the additional seller input to the definition. The key to the map is the field name." }, - "SellerInputDefinition" : { - "description": "Specifies characteristics that apply to a seller input.", - "type" : "object", - "required" : [ "IsRequired", "DataType", "Constraints", "InputDisplayText", "StoredValue" ], - "properties" : { - "IsRequired" : { - "description": "When true, the additional input field is required.", - "type" : "boolean" + "SellerInputDefinition": { + "type": "object", + "required": [ + "Constraints", + "DataType", + "InputDisplayText", + "IsRequired", + "StoredValue" + ], + "properties": { + "IsRequired": { + "type": "boolean", + "description": "When true, the additional input field is required." }, - "DataType" : { - "description": "The data type of the additional input field.", - "type" : "string" + "DataType": { + "type": "string", + "description": "The data type of the additional input field." }, - "Constraints" : { - "$ref" : "#/definitions/Constraints" + "Constraints": { + "$ref": "#/definitions/Constraints" }, - "InputDisplayText" : { - "description": "The display text for the additional input field.", - "type" : "string" + "InputDisplayText": { + "type": "string", + "description": "The display text for the additional input field." }, - "InputTarget" : { + "InputTarget": { "description": "Whether the seller input applies to the item or the shipment.", "$ref": "#/definitions/InputTargetType" }, - "StoredValue" : { - "$ref" : "#/definitions/AdditionalSellerInput" + "StoredValue": { + "$ref": "#/definitions/AdditionalSellerInput" }, - "RestrictedSetValues" : { - "$ref" : "#/definitions/RestrictedSetValues" + "RestrictedSetValues": { + "$ref": "#/definitions/RestrictedSetValues" } - } + }, + "description": "Specifies characteristics that apply to a seller input." }, "InputTargetType": { - "description": "Indicates whether the additional seller input is at the item or shipment level.", "type": "string", + "description": "Indicates whether the additional seller input is at the item or shipment level.", "enum": [ "SHIPMENT_LEVEL", "ITEM_LEVEL" @@ -2429,32 +2513,31 @@ } ] }, - "AdditionalInputsList" : { + "AdditionalInputsList": { + "type": "array", "description": "A list of additional inputs.", - "type" : "array", - "items" : { - "$ref" : "#/definitions/AdditionalInputs" + "items": { + "$ref": "#/definitions/AdditionalInputs" } }, "AdditionalSellerInput": { - "description": "Additional information required to purchase shipping.", "type": "object", "properties": { "DataType": { - "description": "The data type of the additional information.", - "type": "string" + "type": "string", + "description": "The data type of the additional information." }, "ValueAsString": { - "description": "The value when the data type is string.", - "type": "string" + "type": "string", + "description": "The value when the data type is string." }, "ValueAsBoolean": { - "description": "The value when the data type is boolean.", - "type": "boolean" + "type": "boolean", + "description": "The value when the data type is boolean." }, "ValueAsInteger": { - "description": "The value when the data type is integer.", - "type": "integer" + "type": "integer", + "description": "The value when the data type is integer." }, "ValueAsTimestamp": { "description": "The value when the data type is a date-time formatted string.", @@ -2472,10 +2555,10 @@ "ValueAsCurrency": { "$ref": "#/definitions/CurrencyAmount" } - } + }, + "description": "Additional information required to purchase shipping." }, "AdditionalSellerInputs": { - "description": "An additional set of seller inputs required to purchase shipping.", "type": "object", "required": [ "AdditionalInputFieldName", @@ -2483,23 +2566,23 @@ ], "properties": { "AdditionalInputFieldName": { - "description": "The name of the additional input field.", - "type": "string" + "type": "string", + "description": "The name of the additional input field." }, "AdditionalSellerInput": { "$ref": "#/definitions/AdditionalSellerInput" } - } + }, + "description": "An additional set of seller inputs required to purchase shipping." }, "AdditionalSellerInputsList": { - "description": "A list of additional seller input pairs required to purchase shipping.", "type": "array", + "description": "A list of additional seller input pairs required to purchase shipping.", "items": { "$ref": "#/definitions/AdditionalSellerInputs" } }, "Address": { - "description": "The postal address information.", "type": "object", "required": [ "AddressLine1", @@ -2544,34 +2627,34 @@ "Phone": { "$ref": "#/definitions/PhoneNumber" } - } + }, + "description": "The postal address information." }, "AddressLine1": { - "description": "The street address information.", "type": "string", - "maxLength": 180 + "description": "The street address information.", + "maxLength": 180 }, "AddressLine2": { - "description": "Additional street address information.", "type": "string", + "description": "Additional street address information.", "maxLength": 60 }, "AddressLine3": { - "description": "Additional street address information.", "type": "string", + "description": "Additional street address information.", "maxLength": 60 }, "AddressName": { - "description": "The name of the addressee, or business name.", "type": "string", + "description": "The name of the addressee, or business name.", "maxLength": 30 }, "AmazonOrderId": { - "description": "An Amazon-defined order identifier, in 3-7-7 format.
**Pattern** : `[0-9A-Z]{3}-[0-9]{7}-[0-9]{7}`.", - "type": "string" + "type": "string", + "description": "An Amazon-defined order identifier, in 3-7-7 format." }, "CancelShipmentResponse": { - "description": "Response schema.", "type": "object", "properties": { "payload": { @@ -2582,19 +2665,19 @@ "description": "One or more unexpected errors occurred during the cancelShipment operation.", "$ref": "#/definitions/ErrorList" } - } + }, + "description": "Response schema." }, "City": { - "description": "The city.", "type": "string", + "description": "The city.", "maxLength": 30 }, "CountryCode": { - "description": "The country code. A two-character country code, in ISO 3166-1 alpha-2 format.", - "type": "string" + "type": "string", + "description": "The country code. A two-character country code, in ISO 3166-1 alpha-2 format." }, "CreateShipmentRequest": { - "description": "Request schema.", "type": "object", "required": [ "ShipmentRequestDetails", @@ -2609,8 +2692,8 @@ "$ref": "#/definitions/ShippingServiceIdentifier" }, "ShippingServiceOfferId": { - "description": "Identifies a shipping service order made by a carrier.", - "type": "string" + "type": "string", + "description": "Identifies a shipping service order made by a carrier." }, "HazmatType": { "description": "Hazardous materials options for a package. Consult the terms and conditions for each carrier for more information about hazardous materials.", @@ -2623,10 +2706,10 @@ "description": "A list of additional seller inputs required to ship this shipment.", "$ref": "#/definitions/AdditionalSellerInputsList" } - } + }, + "description": "Request schema." }, "CreateShipmentResponse": { - "description": "Response schema.", "type": "object", "properties": { "payload": { @@ -2637,72 +2720,79 @@ "description": "One or more unexpected errors occurred during the createShipment operation.", "$ref": "#/definitions/ErrorList" } - } + }, + "description": "Response schema." }, - "ItemLevelFields" : { - "type" : "object", - "required" : [ "Asin", "AdditionalInputs" ], - "properties" : { - "Asin" : { - "description": "The Amazon Standard Identification Number (ASIN) of the item.", - "type" : "string" + "ItemLevelFields": { + "type": "object", + "required": [ + "AdditionalInputs", + "Asin" + ], + "properties": { + "Asin": { + "type": "string", + "description": "The Amazon Standard Identification Number (ASIN) of the item." }, - "AdditionalInputs" : { - "$ref" : "#/definitions/AdditionalInputsList" + "AdditionalInputs": { + "$ref": "#/definitions/AdditionalInputsList" } } }, - "ItemLevelFieldsList" : { + "ItemLevelFieldsList": { + "type": "array", "description": "A list of item level fields.", - "type" : "array", - "items" : { - "$ref" : "#/definitions/ItemLevelFields" + "items": { + "$ref": "#/definitions/ItemLevelFields" } }, - "GetAdditionalSellerInputsRequest" : { - "description": "Request schema.", - "type" : "object", - "required" : [ "ShippingServiceId", "ShipFromAddress", "OrderId" ], - "properties" : { - "ShippingServiceId" : { - "$ref" : "#/definitions/ShippingServiceIdentifier" + "GetAdditionalSellerInputsRequest": { + "type": "object", + "required": [ + "OrderId", + "ShipFromAddress", + "ShippingServiceId" + ], + "properties": { + "ShippingServiceId": { + "$ref": "#/definitions/ShippingServiceIdentifier" }, - "ShipFromAddress" : { + "ShipFromAddress": { "description": "The address from which to ship.", - "$ref" : "#/definitions/Address" + "$ref": "#/definitions/Address" }, "OrderId": { "description": "An Amazon defined order identifier", - "$ref" : "#/definitions/AmazonOrderId" + "$ref": "#/definitions/AmazonOrderId" } - } + }, + "description": "Request schema." }, "GetAdditionalSellerInputsResult": { - "description": "The payload for the getAdditionalSellerInputs operation.", "type": "object", "properties": { - "ShipmentLevelFields" : { - "$ref" : "#/definitions/AdditionalInputsList" + "ShipmentLevelFields": { + "$ref": "#/definitions/AdditionalInputsList" }, - "ItemLevelFieldsList" : { - "$ref" : "#/definitions/ItemLevelFieldsList" + "ItemLevelFieldsList": { + "$ref": "#/definitions/ItemLevelFieldsList" } - } + }, + "description": "The payload for the getAdditionalSellerInputs operation." }, - "GetAdditionalSellerInputsResponse" : { - "description": "Response schema.", - "type" : "object", - "properties" : { + "GetAdditionalSellerInputsResponse": { + "type": "object", + "properties": { "payload": { "$ref": "#/definitions/GetAdditionalSellerInputsResult" }, "errors": { "$ref": "#/definitions/ErrorList" } - } + }, + "description": "Response schema." }, "CurrencyAmount": { - "description": "Currency type and amount.", "type": "object", "required": [ "Amount", @@ -2710,26 +2800,26 @@ ], "properties": { "CurrencyCode": { - "description": "Three-digit currency code in ISO 4217 format.", "type": "string", + "description": "Three-digit currency code in ISO 4217 format.", "maxLength": 3 }, "Amount": { - "description": "The currency amount.", "type": "number", - "format": "double" + "format": "double", + "description": "The currency amount." } - } + }, + "description": "Currency type and amount." }, "CustomTextForLabel": { - "description": "Custom text to print on the label.\n\nNote: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel.", "type": "string", + "description": "Custom text to print on the label.\n\nNote: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel.", "maxLength": 14 - }, "DeliveryExperienceType": { - "description": "The delivery confirmation level.", "type": "string", + "description": "The delivery confirmation level.", "enum": [ "DeliveryConfirmationWithAdultSignature", "DeliveryConfirmationWithSignature", @@ -2756,15 +2846,14 @@ ] }, "DistrictOrCounty": { - "description": "The district or county.", - "type": "string" + "type": "string", + "description": "The district or county." }, "EmailAddress": { - "description": "The email address.", - "type": "string" + "type": "string", + "description": "The email address." }, "FileContents": { - "description": "The document data and checksum.", "type": "object", "required": [ "Checksum", @@ -2773,21 +2862,22 @@ ], "properties": { "Contents": { - "description": "Data for printing labels, in the form of a Base64-encoded, GZip-compressed string.", - "type": "string" + "type": "string", + "description": "Data for printing labels, in the form of a Base64-encoded, GZip-compressed string." }, "FileType": { "$ref": "#/definitions/FileType" }, "Checksum": { - "description": "An MD5 hash to validate the PDF document data, in the form of a Base64-encoded string.", - "type": "string" + "type": "string", + "description": "An MD5 hash to validate the PDF document data, in the form of a Base64-encoded string." } - } + }, + "description": "The document data and checksum." }, "FileType": { - "description": "The file type for a label.", "type": "string", + "description": "The file type for a label.", "enum": [ "application/pdf", "application/zpl", @@ -2809,7 +2899,6 @@ ] }, "GetEligibleShipmentServicesRequest": { - "description": "Request schema.", "type": "object", "required": [ "ShipmentRequestDetails" @@ -2822,10 +2911,10 @@ "ShippingOfferingFilter": { "$ref": "#/definitions/ShippingOfferingFilter" } - } + }, + "description": "Request schema." }, "GetEligibleShipmentServicesResponse": { - "description": "Response schema.", "type": "object", "properties": { "payload": { @@ -2835,10 +2924,10 @@ "description": "One or more unexpected errors occurred during this operation.", "$ref": "#/definitions/ErrorList" } - } + }, + "description": "Response schema." }, "GetEligibleShipmentServicesResult": { - "description": "The payload for the getEligibleShipmentServices operation.", "type": "object", "required": [ "ShippingServiceList" @@ -2857,10 +2946,10 @@ "TermsAndConditionsNotAcceptedCarrierList": { "$ref": "#/definitions/TermsAndConditionsNotAcceptedCarrierList" } - } + }, + "description": "The payload for the getEligibleShipmentServices operation." }, "GetShipmentResponse": { - "description": "Response schema.", "type": "object", "properties": { "payload": { @@ -2871,11 +2960,12 @@ "description": "One or more unexpected errors occurred during this operation.", "$ref": "#/definitions/ErrorList" } - } + }, + "description": "Response schema." }, "HazmatType": { - "description": "Hazardous materials options for a package. Consult the terms and conditions for each carrier for more information on hazardous materials.", "type": "string", + "description": "Hazardous materials options for a package. Consult the terms and conditions for each carrier for more information on hazardous materials.", "enum": [ "None", "LQHazmat" @@ -2892,7 +2982,6 @@ ] }, "Item": { - "description": "An Amazon order item identifier and a quantity.", "type": "object", "required": [ "OrderItemId", @@ -2918,26 +3007,26 @@ "description": "A list of additional seller inputs required to ship this item using the chosen shipping service.", "$ref": "#/definitions/AdditionalSellerInputsList" } - } + }, + "description": "An Amazon order item identifier and a quantity." }, "ItemList": { - "description": "The list of items to be included in a shipment.", "type": "array", + "description": "The list of items to be included in a shipment.", "items": { "$ref": "#/definitions/Item" } }, "ItemQuantity": { - "description": "The number of items.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The number of items." }, "ItemDescription": { - "description": "The description of the item.", - "type": "string" + "type": "string", + "description": "The description of the item." }, "Label": { - "description": "Data for creating a shipping label and dimensions for printing the label.", "type": "object", "required": [ "Dimensions", @@ -2959,10 +3048,10 @@ "StandardIdForLabel": { "$ref": "#/definitions/StandardIdForLabel" } - } + }, + "description": "Data for creating a shipping label and dimensions for printing the label." }, "LabelCustomization": { - "description": "Custom text for shipping labels.", "type": "object", "properties": { "CustomTextForLabel": { @@ -2971,14 +3060,14 @@ "StandardIdForLabel": { "$ref": "#/definitions/StandardIdForLabel" } - } + }, + "description": "Custom text for shipping labels." }, "LabelDimension": { - "description": "A label dimension.", - "type": "number" + "type": "number", + "description": "A label dimension." }, "LabelDimensions": { - "description": "Dimensions for printing a shipping label.", "type": "object", "required": [ "Length", @@ -2998,11 +3087,12 @@ "description": "The unit of measurement.", "$ref": "#/definitions/UnitOfLength" } - } + }, + "description": "Dimensions for printing a shipping label." }, "LabelFormat": { - "description": "The label format.", "type": "string", + "description": "The label format.", "enum": [ "PDF", "PNG", @@ -3034,35 +3124,34 @@ ] }, "LabelFormatList": { - "description": "List of label formats.", "type": "array", + "description": "List of label formats.", "items": { "$ref": "#/definitions/LabelFormat" } }, "Length": { - "description": "The length.", "type": "object", "properties": { "value": { - "description":"The value in units.", - "type": "number" + "type": "number", + "description": "The value in units." }, "unit": { "$ref": "#/definitions/UnitOfLength" } - } + }, + "description": "The length." }, "OrderItemId": { - "description": "An Amazon-defined identifier for an individual item in an order.", - "type": "string" + "type": "string", + "description": "An Amazon-defined identifier for an individual item in an order." }, "PackageDimension": { "type": "number", "format": "double" }, "PackageDimensions": { - "description": "The dimensions of a package contained in a shipment.", "type": "object", "properties": { "Length": { @@ -3084,21 +3173,22 @@ "PredefinedPackageDimensions": { "$ref": "#/definitions/PredefinedPackageDimensions" } - } + }, + "description": "The dimensions of a package contained in a shipment." }, "PhoneNumber": { - "description": "The phone number.", "type": "string", + "description": "The phone number.", "maxLength": 30 }, "PostalCode": { - "description": "The zip code or postal code.", "type": "string", + "description": "The zip code or postal code.", "maxLength": 30 }, "PredefinedPackageDimensions": { - "description": "An enumeration of predefined parcel tokens. If you specify a PredefinedPackageDimensions token, you are not obligated to use a branded package from a carrier. For example, if you specify the FedEx_Box_10kg token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token.\n\nNote: Please note that carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for all details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate Envelope or Box.", "type": "string", + "description": "An enumeration of predefined parcel tokens. If you specify a PredefinedPackageDimensions token, you are not obligated to use a branded package from a carrier. For example, if you specify the FedEx_Box_10kg token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token.\n\nNote: Please note that carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for all details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate Envelope or Box.", "enum": [ "FedEx_Box_10kg", "FedEx_Box_25kg", @@ -3355,20 +3445,19 @@ ] }, "RestrictedSetValues": { - "description": "The set of fixed values in an additional seller input.", "type": "array", + "description": "The set of fixed values in an additional seller input.", "items": { - "description": "A single fixed value.", - "type": "string" + "type": "string", + "description": "A single fixed value." } }, "SellerOrderId": { - "description": "A seller-defined order identifier.", "type": "string", + "description": "A seller-defined order identifier.", "maxLength": 64 }, "Shipment": { - "description": "The details of a shipment, including the shipment status.", "type": "object", "required": [ "AmazonOrderId", @@ -3438,14 +3527,14 @@ "description": "The date and time of the last update.", "$ref": "#/definitions/Timestamp" } - } + }, + "description": "The details of a shipment, including the shipment status." }, "ShipmentId": { - "description": "An Amazon-defined shipment identifier.", - "type": "string" + "type": "string", + "description": "An Amazon-defined shipment identifier." }, "ShipmentRequestDetails": { - "description": "Shipment information required for requesting shipping service offers or for creating a shipment.", "type": "object", "required": [ "AmazonOrderId", @@ -3495,11 +3584,12 @@ "description": "Label customization options.", "$ref": "#/definitions/LabelCustomization" } - } + }, + "description": "Shipment information required for requesting shipping service offers or for creating a shipment." }, "ShipmentStatus": { - "description": "The shipment status.", "type": "string", + "description": "The shipment status.", "enum": [ "Purchased", "RefundPending", @@ -3526,8 +3616,8 @@ ] }, "DeliveryExperienceOption": { - "description": "The delivery confirmation level.", "type": "string", + "description": "The delivery confirmation level.", "enum": [ "DeliveryConfirmationWithAdultSignature", "DeliveryConfirmationWithSignature", @@ -3559,16 +3649,15 @@ ] }, "ShippingOfferingFilter": { - "description":"Filter for use when requesting eligible shipping services.", "type": "object", "properties": { "IncludePackingSlipWithLabel": { - "description": "When true, include a packing slip with the label.", - "type": "boolean" + "type": "boolean", + "description": "When true, include a packing slip with the label." }, "IncludeComplexShippingOptions": { - "description": "When true, include complex shipping options.", - "type": "boolean" + "type": "boolean", + "description": "When true, include complex shipping options." }, "CarrierWillPickUp": { "$ref": "#/definitions/CarrierWillPickUpOption" @@ -3576,36 +3665,36 @@ "DeliveryExperience": { "$ref": "#/definitions/DeliveryExperienceOption" } - } + }, + "description": "Filter for use when requesting eligible shipping services." }, "ShippingService": { - "description": "A shipping service offer made by a carrier.", "type": "object", "required": [ "CarrierName", "Rate", + "RequiresAdditionalSellerInputs", "ShipDate", "ShippingServiceId", "ShippingServiceName", "ShippingServiceOfferId", - "ShippingServiceOptions", - "RequiresAdditionalSellerInputs" + "ShippingServiceOptions" ], "properties": { "ShippingServiceName": { - "description": "A plain text representation of a carrier's shipping service. For example, \"UPS Ground\" or \"FedEx Standard Overnight\". ", - "type": "string" + "type": "string", + "description": "A plain text representation of a carrier's shipping service. For example, \"UPS Ground\" or \"FedEx Standard Overnight\". " }, "CarrierName": { - "description": "The name of the carrier.", - "type": "string" + "type": "string", + "description": "The name of the carrier." }, "ShippingServiceId": { "$ref": "#/definitions/ShippingServiceIdentifier" }, "ShippingServiceOfferId": { - "description": "An Amazon-defined shipping service offer identifier.", - "type": "string" + "type": "string", + "description": "An Amazon-defined shipping service offer identifier." }, "ShipDate": { "description": "The date that the carrier will ship the package.", @@ -3627,38 +3716,38 @@ "description": "Extra services offered by the carrier.", "$ref": "#/definitions/ShippingServiceOptions" }, - "AvailableShippingServiceOptions" : { - "$ref" : "#/definitions/AvailableShippingServiceOptions" + "AvailableShippingServiceOptions": { + "$ref": "#/definitions/AvailableShippingServiceOptions" }, "AvailableLabelFormats": { "$ref": "#/definitions/LabelFormatList" }, - "AvailableFormatOptionsForLabel" : { - "$ref" : "#/definitions/AvailableFormatOptionsForLabelList" + "AvailableFormatOptionsForLabel": { + "$ref": "#/definitions/AvailableFormatOptionsForLabelList" }, - "RequiresAdditionalSellerInputs" : { - "description": "When true, additional seller inputs are required.", - "type" : "boolean" + "RequiresAdditionalSellerInputs": { + "type": "boolean", + "description": "When true, additional seller inputs are required." } - } + }, + "description": "A shipping service offer made by a carrier." }, "ShippingServiceIdentifier": { - "description": "An Amazon-defined shipping service identifier.", - "type": "string" + "type": "string", + "description": "An Amazon-defined shipping service identifier." }, "ShippingServiceList": { - "description": "A list of shipping services offers.", "type": "array", + "description": "A list of shipping services offers.", "items": { "$ref": "#/definitions/ShippingService" } }, "ShippingServiceOptions": { - "description": "Extra services provided by a carrier.", "type": "object", "required": [ - "DeliveryExperience", - "CarrierWillPickUp" + "CarrierWillPickUp", + "DeliveryExperience" ], "properties": { "DeliveryExperience": { @@ -3670,8 +3759,8 @@ "$ref": "#/definitions/CurrencyAmount" }, "CarrierWillPickUp": { - "description": "When true, the carrier will pick up the package.\n\nNote: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK).", - "type": "boolean" + "type": "boolean", + "description": "When true, the carrier will pick up the package.\n\nNote: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK)." }, "CarrierWillPickUpOption": { "$ref": "#/definitions/CarrierWillPickUpOption" @@ -3680,11 +3769,12 @@ "description": "The seller's preferred label format.", "$ref": "#/definitions/LabelFormat" } - } + }, + "description": "Extra services provided by a carrier." }, "CarrierWillPickUpOption": { - "description": "Carrier will pick up option.", "type": "string", + "description": "Carrier will pick up option.", "enum": [ "CarrierWillPickUp", "ShipperWillDropOff", @@ -3706,8 +3796,8 @@ ] }, "StandardIdForLabel": { - "description": "The type of standard identifier to print on the label.", "type": "string", + "description": "The type of standard identifier to print on the label.", "enum": [ "AmazonOrderId" ], @@ -3719,85 +3809,85 @@ ] }, "StateOrProvinceCode": { - "description": "The state or province code.", "type": "string", + "description": "The state or province code.", "maxLength": 30 }, "RejectedShippingService": { - "description": "Information about a rejected shipping service", "type": "object", "required": [ "CarrierName", - "ShippingServiceName", + "RejectionReasonCode", "ShippingServiceId", - "RejectionReasonCode" + "ShippingServiceName" ], "properties": { "CarrierName": { - "description": "The rejected shipping carrier name. e.g. USPS", - "type": "string" + "type": "string", + "description": "The rejected shipping carrier name. e.g. USPS" }, "ShippingServiceName": { - "description": "The rejected shipping service localized name. e.g. FedEx Standard Overnight", - "type": "string" + "type": "string", + "description": "The rejected shipping service localized name. e.g. FedEx Standard Overnight" }, "ShippingServiceId": { "description": "The rejected shipping service identifier. e.g. FEDEX_PTP_STANDARD_OVERNIGHT", "$ref": "#/definitions/ShippingServiceIdentifier" }, "RejectionReasonCode": { - "description": "A reason code meant to be consumed programatically. e.g. CARRIER_CANNOT_SHIP_TO_POBOX", - "type": "string" + "type": "string", + "description": "A reason code meant to be consumed programatically. e.g. CARRIER_CANNOT_SHIP_TO_POBOX" }, "RejectionReasonMessage": { - "description": "A localized human readable description of the rejected reason.", - "type": "string" + "type": "string", + "description": "A localized human readable description of the rejected reason." } - } + }, + "description": "Information about a rejected shipping service" }, "RejectedShippingServiceList": { - "description": "List of services that were for some reason unavailable for this request", "type": "array", + "description": "List of services that were for some reason unavailable for this request", "items": { "$ref": "#/definitions/RejectedShippingService" } }, "TemporarilyUnavailableCarrier": { - "description": "A carrier who is temporarily unavailable, most likely due to a service outage experienced by the carrier.", "type": "object", "required": [ "CarrierName" ], "properties": { "CarrierName": { - "description": "The name of the carrier.", - "type": "string" + "type": "string", + "description": "The name of the carrier." } - } + }, + "description": "A carrier who is temporarily unavailable, most likely due to a service outage experienced by the carrier." }, "TemporarilyUnavailableCarrierList": { - "description": "A list of temporarily unavailable carriers.", "type": "array", + "description": "A list of temporarily unavailable carriers.", "items": { "$ref": "#/definitions/TemporarilyUnavailableCarrier" } }, "TermsAndConditionsNotAcceptedCarrier": { - "description": "A carrier whose terms and conditions have not been accepted by the seller.", "type": "object", "required": [ "CarrierName" ], "properties": { "CarrierName": { - "description": "The name of the carrier.", - "type": "string" + "type": "string", + "description": "The name of the carrier." } - } + }, + "description": "A carrier whose terms and conditions have not been accepted by the seller." }, "TermsAndConditionsNotAcceptedCarrierList": { - "description": "List of carriers whose terms and conditions were not accepted by the seller.", "type": "array", + "description": "List of carriers whose terms and conditions were not accepted by the seller.", "items": { "$ref": "#/definitions/TermsAndConditionsNotAcceptedCarrier" } @@ -3807,23 +3897,23 @@ "format": "date-time" }, "TrackingId": { - "description": "The shipment tracking identifier provided by the carrier.", - "type": "string" + "type": "string", + "description": "The shipment tracking identifier provided by the carrier." }, "TransparencyCode": { - "description": "The Transparency code associated with the item.", - "type": "string" + "type": "string", + "description": "The Transparency code associated with the item." }, "TransparencyCodeList": { - "description": "A list of transparency codes.", "type": "array", + "description": "A list of transparency codes.", "items": { "$ref": "#/definitions/TransparencyCode" } }, "UnitOfLength": { - "description": "The unit of length.", "type": "string", + "description": "The unit of length.", "enum": [ "inches", "centimeters" @@ -3840,8 +3930,8 @@ ] }, "UnitOfWeight": { - "description": "The unit of weight.", "type": "string", + "description": "The unit of weight.", "enum": [ "oz", "g" @@ -3858,7 +3948,6 @@ ] }, "Weight": { - "description": "The weight.", "type": "object", "required": [ "Unit", @@ -3871,12 +3960,13 @@ "Unit": { "$ref": "#/definitions/UnitOfWeight" } - } + }, + "description": "The weight." }, "WeightValue": { - "description": "The weight value.", "type": "number", - "format": "double" + "format": "double", + "description": "The weight value." } } } \ No newline at end of file