diff --git a/clients/sellingpartner-api-aa-csharp/src/Amazon.SellingPartnerAPIAA/AWSSigV4Signer.cs b/clients/sellingpartner-api-aa-csharp/src/Amazon.SellingPartnerAPIAA/AWSSigV4Signer.cs index 9f7e3db..3937efa 100644 --- a/clients/sellingpartner-api-aa-csharp/src/Amazon.SellingPartnerAPIAA/AWSSigV4Signer.cs +++ b/clients/sellingpartner-api-aa-csharp/src/Amazon.SellingPartnerAPIAA/AWSSigV4Signer.cs @@ -59,7 +59,7 @@ namespace Amazon.SellingPartnerAPIAA canonicalizedRequest.AppendFormat("{0}\n", restRequest.Method); //CanonicalURI - canonicalizedRequest.AppendFormat("{0}\n", AwsSignerHelper.ExtractCanonicalURIParameters(restRequest.Resource)); + canonicalizedRequest.AppendFormat("{0}\n", AwsSignerHelper.ExtractCanonicalURIParameters(restRequest)); //CanonicalQueryString canonicalizedRequest.AppendFormat("{0}\n", AwsSignerHelper.ExtractCanonicalQueryString(restRequest)); diff --git a/clients/sellingpartner-api-aa-csharp/src/Amazon.SellingPartnerAPIAA/AWSSignerHelper.cs b/clients/sellingpartner-api-aa-csharp/src/Amazon.SellingPartnerAPIAA/AWSSignerHelper.cs index 5a2f7ef..6cd10d4 100644 --- a/clients/sellingpartner-api-aa-csharp/src/Amazon.SellingPartnerAPIAA/AWSSignerHelper.cs +++ b/clients/sellingpartner-api-aa-csharp/src/Amazon.SellingPartnerAPIAA/AWSSignerHelper.cs @@ -38,10 +38,11 @@ namespace Amazon.SellingPartnerAPIAA /// /// Returns URI encoded version of absolute path /// - /// Resource path(absolute path) from the request + /// RestRequest /// URI encoded version of absolute path - public virtual string ExtractCanonicalURIParameters(string resource) + public virtual string ExtractCanonicalURIParameters(IRestRequest request) { + string resource = request.Resource; string canonicalUri = string.Empty; if (string.IsNullOrEmpty(resource)) @@ -54,6 +55,17 @@ namespace Amazon.SellingPartnerAPIAA { canonicalUri = Slash; } + IDictionary pathParameters = request.Parameters + .Where(parameter => ParameterType.UrlSegment.Equals(parameter.Type)) + .ToDictionary(parameter => parameter.Name.Trim().ToString(), parameter => parameter.Value.ToString()); + + // Replace path parameter with actual value. + // Ex: /products/pricing/v0/items/{Asin}/offers -> /products/pricing/v0/items/AB12CD3E4Z/offers + foreach (string parameter in pathParameters.Keys) + { + resource = resource.Replace("{" + parameter + "}", pathParameters[parameter]); + } + //Split path at / into segments IEnumerable encodedSegments = resource.Split(new char[] { '/' }, StringSplitOptions.None); @@ -76,12 +88,12 @@ namespace Amazon.SellingPartnerAPIAA { IDictionary queryParameters = request.Parameters .Where(parameter => ParameterType.QueryString.Equals(parameter.Type)) - .ToDictionary(header => header.Name.Trim().ToString(), header => header.Value.ToString()); + .ToDictionary(parameter => parameter.Name.Trim().ToString(), parameter => parameter.Value.ToString()); - SortedDictionary sortedqueryParameters = new SortedDictionary(queryParameters); + SortedDictionary sortedQueryParameters = new SortedDictionary(queryParameters); StringBuilder canonicalQueryString = new StringBuilder(); - foreach (var key in sortedqueryParameters.Keys) + foreach (var key in sortedQueryParameters.Keys) { if (canonicalQueryString.Length > 0) { @@ -89,7 +101,7 @@ namespace Amazon.SellingPartnerAPIAA } canonicalQueryString.AppendFormat("{0}={1}", Utils.UrlEncode(key), - Utils.UrlEncode(sortedqueryParameters[key])); + Utils.UrlEncode(sortedQueryParameters[key])); } return canonicalQueryString.ToString(); diff --git a/clients/sellingpartner-api-aa-csharp/test/Amazon.SellingPartnerAPIAATests/AWSSigV4SignerTest.cs b/clients/sellingpartner-api-aa-csharp/test/Amazon.SellingPartnerAPIAATests/AWSSigV4SignerTest.cs index d0487a0..20d6a3f 100644 --- a/clients/sellingpartner-api-aa-csharp/test/Amazon.SellingPartnerAPIAATests/AWSSigV4SignerTest.cs +++ b/clients/sellingpartner-api-aa-csharp/test/Amazon.SellingPartnerAPIAATests/AWSSigV4SignerTest.cs @@ -43,7 +43,7 @@ namespace Amazon.SellingPartnerAPIAATests string expectedStringToSign = "testStringToSign"; mockAWSSignerHelper.Setup(signerHelper => signerHelper.InitializeHeaders(request, TestHost)) .Returns(signingDate); - mockAWSSignerHelper.Setup(signerHelper => signerHelper.ExtractCanonicalURIParameters(request.Resource)) + mockAWSSignerHelper.Setup(signerHelper => signerHelper.ExtractCanonicalURIParameters(request)) .Returns("testURIParameters"); mockAWSSignerHelper.Setup(signerHelper => signerHelper.ExtractCanonicalQueryString(request)) .Returns("testCanonicalQueryString"); @@ -63,7 +63,7 @@ namespace Amazon.SellingPartnerAPIAATests IRestRequest actualRestRequest = sigV4SignerUnderTest.Sign(request, TestHost); mockAWSSignerHelper.Verify(signerHelper => signerHelper.InitializeHeaders(request, TestHost)); - mockAWSSignerHelper.Verify(signerHelper => signerHelper.ExtractCanonicalURIParameters(request.Resource)); + mockAWSSignerHelper.Verify(signerHelper => signerHelper.ExtractCanonicalURIParameters(request)); mockAWSSignerHelper.Verify(signerHelper => signerHelper.ExtractCanonicalQueryString(request)); mockAWSSignerHelper.Verify(signerHelper => signerHelper.ExtractCanonicalHeaders(request)); mockAWSSignerHelper.Verify(signerHelper => signerHelper.ExtractSignedHeaders(request)); diff --git a/clients/sellingpartner-api-aa-csharp/test/Amazon.SellingPartnerAPIAATests/AWSSignerHelperTest.cs b/clients/sellingpartner-api-aa-csharp/test/Amazon.SellingPartnerAPIAATests/AWSSignerHelperTest.cs index 4a10c8c..665eb3d 100644 --- a/clients/sellingpartner-api-aa-csharp/test/Amazon.SellingPartnerAPIAATests/AWSSignerHelperTest.cs +++ b/clients/sellingpartner-api-aa-csharp/test/Amazon.SellingPartnerAPIAATests/AWSSignerHelperTest.cs @@ -34,35 +34,57 @@ namespace Amazon.SellingPartnerAPIAATests public void TestExtractCanonicalURIParameters() { IRestRequest request = new RestRequest(TestResourcePath, Method.GET); - string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters(request.Resource); - Assert.Equal("/iam/user", result); + string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters(request); + Assert.Equal(Slash + TestResourcePath, result); + } + + [Fact] + public void TestExtractCanonicalURIParameters_UrlSegments() + { + IRestRequest request = new RestRequest("products/pricing/v0/items/{Asin}/offers/{SellerSKU}", Method.GET); + request.AddUrlSegment("Asin", "AB12CD3E4Z"); + request.AddUrlSegment("SellerSKU", "1234567890"); + string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters(request); + Assert.Equal("/products/pricing/v0/items/AB12CD3E4Z/offers/1234567890", result); + } + + [Fact] + public void TestExtractCanonicalURIParameters_IncorrectUrlSegment() + { + IRestRequest request = new RestRequest("products/pricing/v0/items/{Asin}/offers", Method.GET); + request.AddUrlSegment("asin", "AB12CD3E4Z"); + string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters(request); + Assert.Equal("/products/pricing/v0/items/%257BAsin%257D/offers", result); } [Fact] public void TestExtractCanonicalURIParameters_ResourcePathWithSpace() { - string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters("iam/ user"); + IRestRequest request = new RestRequest("iam/ user", Method.GET); + string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters(request); Assert.Equal("/iam/%2520user", result); } [Fact] public void TestExtractCanonicalURIParameters_EmptyResourcePath() { - string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters(string.Empty); + IRestRequest request = new RestRequest(string.Empty, Method.GET); + string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters(request); Assert.Equal(Slash, result); } [Fact] public void TestExtractCanonicalURIParameters_NullResourcePath() { - string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters(null); + string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters(new RestRequest()); Assert.Equal(Slash, result); } [Fact] public void TestExtractCanonicalURIParameters_SlashPath() { - string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters(Slash); + IRestRequest request = new RestRequest(Slash, Method.GET); + string result = awsSignerHelperUnderTest.ExtractCanonicalURIParameters(request); Assert.Equal(Slash, result); } diff --git a/models/catalog-items-api-model/catalogItems_2020-12-01.json b/models/catalog-items-api-model/catalogItems_2020-12-01.json index 47ab566..d61e7ef 100644 --- a/models/catalog-items-api-model/catalogItems_2020-12-01.json +++ b/models/catalog-items-api-model/catalogItems_2020-12-01.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "description": "The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.\n\nFor more information, see the [Catalog Items API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/catalog-items-api-use-case-guide/catalog-items-api-use-case-guide_2020-12-01.md).", + "description": "The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.\n\nFor more information, see the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2020-12-01-use-case-guide).", "version": "2020-12-01", "title": "Selling Partner API for Catalog Items", "contact": { @@ -29,7 +29,7 @@ "tags": [ "catalog" ], - "description": "Search for and return a list of Amazon catalog items and associated information.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 5 |\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](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Search for and return a list of Amazon catalog items and associated information.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 5 |\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](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "searchCatalogItems", "consumes": [ "application/json" @@ -570,7 +570,7 @@ "tags": [ "catalog" ], - "description": "Retrieves details for an item in the Amazon catalog.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 5 |\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](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Retrieves details for an item in the Amazon catalog.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 5 |\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](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getCatalogItem", "consumes": [ "application/json" diff --git a/models/fba-inbound-eligibility-api-model/fbaInbound.json b/models/fba-inbound-eligibility-api-model/fbaInbound.json index 3e8becf..fa3155b 100644 --- a/models/fba-inbound-eligibility-api-model/fbaInbound.json +++ b/models/fba-inbound-eligibility-api-model/fbaInbound.json @@ -466,6 +466,7 @@ "FBA_INB_0100", "FBA_INB_0103", "FBA_INB_0104", + "FBA_INB_0197", "UNKNOWN_INB_ERROR_CODE" ], "x-docgen-enum-table-extension": [ @@ -617,6 +618,10 @@ "value": "FBA_INB_0104", "description": "Item Requires Manufacturer Barcode. Only NEW products can be stored in our fulfillment centers without product labels." }, + { + "value": "FBA_INB_0197", + "description": "Item requires safety and compliance documentation. Orders for this product cannot be fulfilled by FBA without required safety and compliance documentation." + }, { "value": "UNKNOWN_INB_ERROR_CODE", "description": "Unknown Ineligibility Reason." diff --git a/models/fba-inventory-api-model/fbaInventory.json b/models/fba-inventory-api-model/fbaInventory.json index d7f073d..c0672a5 100644 --- a/models/fba-inventory-api-model/fbaInventory.json +++ b/models/fba-inventory-api-model/fbaInventory.json @@ -671,4 +671,4 @@ } } } -} \ No newline at end of file +} diff --git a/models/feeds-api-model/feeds_2020-09-04.json b/models/feeds-api-model/feeds_2020-09-04.json index f8535e3..7b7995c 100644 --- a/models/feeds-api-model/feeds_2020-09-04.json +++ b/models/feeds-api-model/feeds_2020-09-04.json @@ -1623,7 +1623,7 @@ }, "FeedOptions": { "type": "object", - "description": "Additional options to control the feed. For feeds that use the feedOptions parameter, you can find the parameter values in the feed description in [feedType values](https://github.com/amzn/selling-partner-api-docs/blob/main/references/feeds-api/feedtype-values.md).", + "description": "Additional options to control the feed. For feeds that use the feedOptions parameter, you can find the parameter values in the feed description in [feedType values](doc:feed-type-values).", "additionalProperties": { "type": "string" } diff --git a/models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json b/models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json index 79d2f03..09ef294 100644 --- a/models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json +++ b/models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json @@ -4941,7 +4941,17 @@ "UNDELIVERABLE", "DELAYED", "AVAILABLE_FOR_PICKUP", - "CUSTOMER_ACTION" + "CUSTOMER_ACTION", + "UNKNOWN", + "OUT_FOR_DELIVERY", + "DELIVERY_ATTEMPTED", + "PICKUP_SUCCESSFUL", + "PICKUP_CANCELLED", + "PICKUP_ATTEMPTED", + "PICKUP_SCHEDULED", + "RETURN_REQUEST_ACCEPTED", + "REFUND_ISSUED", + "RETURN_RECEIVED_IN_FC" ], "x-docgen-enum-table-extension": [ { @@ -4975,6 +4985,46 @@ { "value": "CUSTOMER_ACTION", "description": "Requires customer action." + }, + { + "value": "UNKNOWN", + "description": "Unknown Status Code was returned." + }, + { + "value": "OUT_FOR_DELIVERY", + "description": "Out for Delivery." + }, + { + "value": "DELIVERY_ATTEMPTED", + "description": "Delivery Attempted." + }, + { + "value": "PICKUP_SUCCESSFUL", + "description": "Pickup Successful." + }, + { + "value": "PICKUP_CANCELLED", + "description": "Pickup Cancelled." + }, + { + "value": "PICKUP_ATTEMPTED", + "description": "Pickup Attempted." + }, + { + "value": "PICKUP_SCHEDULED", + "description": "Pickup Scheduled." + }, + { + "value": "RETURN_REQUEST_ACCEPTED", + "description": "Return Request Accepted." + }, + { + "value": "REFUND_ISSUED", + "description": "Refund Issued." + }, + { + "value": "RETURN_RECEIVED_IN_FC", + "description": "Return Received In FC." } ] }, diff --git a/models/listings-items-api-model/listingsItems_2020-09-01.json b/models/listings-items-api-model/listingsItems_2020-09-01.json index 189feef..64a0d9e 100644 --- a/models/listings-items-api-model/listingsItems_2020-09-01.json +++ b/models/listings-items-api-model/listingsItems_2020-09-01.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "description": "The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API.\n\nFor more information, see the [Listing Items API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/listings-items-api-use-case-guide/listings-items-api-use-case-guide_2020-09-01.md).", + "description": "The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API.\n\nFor more information, see the [Listing Items API Use Case Guide](doc:listings-items-api-v2020-09-01-use-case-guide).", "version": "2020-09-01", "title": "Selling Partner API for Listings Items", "contact": { @@ -29,7 +29,7 @@ "tags": [ "listings" ], - "description": "Delete a listings item for a selling partner.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\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](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Delete a listings item for a selling partner.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\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](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "deleteListingsItem", "consumes": [ "application/json" @@ -250,7 +250,7 @@ "tags": [ "listings" ], - "description": "Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\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](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\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](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "patchListingsItem", "consumes": [ "application/json" @@ -482,7 +482,7 @@ "tags": [ "listings" ], - "description": "Creates a new or fully-updates an existing listings item for a selling partner.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\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](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Creates a new or fully-updates an existing listings item for a selling partner.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\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](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "putListingsItem", "consumes": [ "application/json" diff --git a/models/listings-items-api-model/listingsItems_2021-08-01.json b/models/listings-items-api-model/listingsItems_2021-08-01.json index 8c20168..6d59fd8 100644 --- a/models/listings-items-api-model/listingsItems_2021-08-01.json +++ b/models/listings-items-api-model/listingsItems_2021-08-01.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "description": "The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API.\n\nFor more information, see the [Listings Items API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/listings-items-api-use-case-guide/listings-items-api-use-case-guide_2021-08-01.md).", + "description": "The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API.\n\nFor more information, see the [Listings Items API Use Case Guide](doc:listings-items-api-v2021-08-01-use-case-guide).", "version": "2021-08-01", "title": "Selling Partner API for Listings Items", "contact": { @@ -29,7 +29,7 @@ "tags": [ "listings" ], - "description": "Delete a listings item for a selling partner.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Delete a listings item for a selling partner.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "deleteListingsItem", "consumes": [ "application/json" @@ -230,7 +230,7 @@ "tags": [ "listings" ], - "description": "Returns details about a listings item for a selling partner.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Returns details about a listings item for a selling partner.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getListingsItem", "consumes": [ "application/json" @@ -562,7 +562,7 @@ "tags": [ "listings" ], - "description": "Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "patchListingsItem", "consumes": [ "application/json" @@ -774,7 +774,7 @@ "tags": [ "listings" ], - "description": "Creates a new or fully-updates an existing listings item for a selling partner.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Creates a new or fully-updates an existing listings item for a selling partner.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "putListingsItem", "consumes": [ "application/json" diff --git a/models/listings-restrictions-api-model/listingsRestrictions_2021-08-01.json b/models/listings-restrictions-api-model/listingsRestrictions_2021-08-01.json index 8ae2798..3bd8581 100644 --- a/models/listings-restrictions-api-model/listingsRestrictions_2021-08-01.json +++ b/models/listings-restrictions-api-model/listingsRestrictions_2021-08-01.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Selling Partner API for Listings Restrictions", - "description": "The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog listings.\n\nFor more information, see the [Listings Restrictions API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/listings-restrictions-api-use-case-guide/listings-restrictions-api-use-case-guide_2021-08-01.md).", + "description": "The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog listings.\n\nFor more information, see the [Listings Restrictions API Use Case Guide](doc:listings-restrictions-api-v2021-08-01-use-case-guide).", "version": "2021-08-01", "contact": { "name": "Selling Partner API Developer Support", @@ -247,7 +247,7 @@ "tags": [ "listings" ], - "description": "Returns listing restrictions for an item in the Amazon Catalog. \n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Returns listing restrictions for an item in the Amazon Catalog. \n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getListingsRestrictions", "consumes": [ "application/json" diff --git a/models/notifications-api-model/notifications.json b/models/notifications-api-model/notifications.json index 6db2642..a5d99b1 100644 --- a/models/notifications-api-model/notifications.json +++ b/models/notifications-api-model/notifications.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "description": "The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner's business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more.\n\nFor more information, see the [Notifications Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/notifications-api-use-case-guide/notifications-use-case-guide-v1.md)", + "description": "The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner's business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more.\n\nFor more information, see the [Notifications Use Case Guide](doc:notifications-api-v1-use-case-guide)", "version": "v1", "title": "Selling Partner API for Notifications", "contact": { @@ -1922,83 +1922,9 @@ "NotificationType": { "name": "notificationType", "in": "path", - "description": "The type of notification.\n\n For more information about notification types, see [the Notifications API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/notifications-api-use-case-guide/notifications-use-case-guide-v1.md).", + "description": "The type of notification.\n\n For more information about notification types, see [the Notifications API Use Case Guide](doc:notifications-api-v1-use-case-guide).", "required": true, - "type": "string", - "enum": [ - "ANY_OFFER_CHANGED", - "FEED_PROCESSING_FINISHED", - "FBA_OUTBOUND_SHIPMENT_STATUS", - "FEE_PROMOTION", - "FULFILLMENT_ORDER_STATUS", - "REPORT_PROCESSING_FINISHED", - "BRANDED_ITEM_CONTENT_CHANGE", - "ITEM_PRODUCT_TYPE_CHANGE", - "LISTINGS_ITEM_STATUS_CHANGE", - "LISTINGS_ITEM_ISSUES_CHANGE", - "MFN_ORDER_STATUS_CHANGE", - "B2B_ANY_OFFER_CHANGED", - "ACCOUNT_STATUS_CHANGED", - "PRODUCT_TYPE_DEFINITIONS_CHANGE" - ], - "x-docgen-enum-table-extension": [ - { - "value": "ANY_OFFER_CHANGED", - "description": "Sent whenever there is a listing change for any of the top 20 offers, by condition (new or used), or if the external price (the price from other retailers) changes for an item listed by the seller. The top 20 offers are determined by the landed price, which is the price plus shipping minus Amazon Points. If multiple sellers are charging the same landed price, the results will be returned in random order.\n\n These notifications are only sent for items for which the seller has active offers. You cannot subscribe to notifications for items for which the seller does not have active offers." - }, - { - "value": "FEED_PROCESSING_FINISHED", - "description": "Sent whenever any feed submitted using the Selling Partner API for Feeds reaches a feed processing status of DONE or CANCELLED." - }, - { - "value": "FBA_OUTBOUND_SHIPMENT_STATUS", - "description": "Sent whenever Amazon creates or cancels a Fulfillment by Amazon shipment for a seller. This notification is only for FBA Onsite shipments. This notification is available only in the Brazil marketplace." - }, - { - "value": "FEE_PROMOTION", - "description": "Sent when a promotion becomes active. Sellers can benefit from time-limited fee promotions. To receive notifications of these fee promotions on behalf of the seller, subscribe to the FEE_PROMOTION notification. All currently active promotions are sent at first, with each promotion sent as a single message. Subsequent notifications are sent when the promotion becomes active." - }, - { - "value": "FULFILLMENT_ORDER_STATUS", - "description": "Sent whenever there is a change in the status of a Multi-Channel Fulfillment order.\n\n Multi-Channel Fulfillment is a program where sellers use their FBA inventory to fulfill orders not sold on the retail site." - }, - { - "value": "REPORT_PROCESSING_FINISHED", - "description": "Sent whenever any report that you have requested using the Selling Partner API for Reports reaches a report processing status of DONE, CANCELLED, or FATAL." - }, - { - "value": "BRANDED_ITEM_CONTENT_CHANGE", - "description": "Sent whenever there is a change to the title, description, or bullet points for any ASIN that the selling partner has a brand relationship with." - }, - { - "value": "ITEM_PRODUCT_TYPE_CHANGE", - "description": "Sent whenever there is a change to the product type name of any ASIN that the selling partner has a brand relationship with." - }, - { - "value": "LISTINGS_ITEM_STATUS_CHANGE", - "description": "Sent whenever there is a listing status change including buyable transition, discoverable transition, listing create or delete for any SKU that the selling partner has." - }, - { - "value": "LISTINGS_ITEM_ISSUES_CHANGE", - "description": "Sent whenever there are issues change for any SKU that the selling partner has." - }, - { - "value": "PRODUCT_TYPE_DEFINITIONS_CHANGE", - "description": "Sent whenever there is a new Product Type or a Product Type Version in a marketplace." - }, - { - "value": "MFN_ORDER_STATUS_CHANGE", - "description": "Sent whenever there is a change in the status of an MFN order availability." - }, - { - "value": "B2B_ANY_OFFER_CHANGED", - "description": "Sent whenever there is a listing change for any of the top 20 B2B offers, by condition (new or used). The top 20 offers are determined by the landed price, which is the price plus shipping minus Amazon Points(applicable only JP). If multiple sellers are charging the same landed price, the results will be returned in random order.\n\n These notifications are only sent for items for which the seller has active offers. Seller cannot receive notifications for items for which the seller does not have active offers." - }, - { - "value": "ACCOUNT_STATUS_CHANGED", - "description": "Sent whenever the Account Status changes for the developers subscribed merchant/marketplace pairs. A notification is published whenever the merchant's account status changes between NORMAL, AT_RISK, and DEACTIVATED.\n\n The notification will have a payload with 2 fields: previousAccountStatus and currentAccountStatus to indicate the direction of the change." - } - ] + "type": "string" } } -} +} \ No newline at end of file diff --git a/models/orders-api-model/ordersV0.json b/models/orders-api-model/ordersV0.json index d7792a8..58951a4 100644 --- a/models/orders-api-model/ordersV0.json +++ b/models/orders-api-model/ordersV0.json @@ -73,7 +73,7 @@ { "name": "MarketplaceIds", "in": "query", - "description": "A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.\n\nSee the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#marketplaceid-values) for a complete list of marketplaceId values.", + "description": "A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.\n\nSee the [Selling Partner API Developer Guide](doc:marketplace-ids) for a complete list of marketplaceId values.", "required": true, "type": "array", "items": { @@ -84,7 +84,7 @@ { "name": "FulfillmentChannels", "in": "query", - "description": "A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller).", + "description": "A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller).", "required": false, "type": "array", "items": { @@ -206,6 +206,7 @@ "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, + "IsIBA": false, "ShippingAddress": { "Name": "Michigan address", "AddressLine1": "1 Cross St.", @@ -287,6 +288,7 @@ "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, + "IsIBA": false, "DefaultShipFromLocationAddress": { "Name": "MFNIntegrationTestMerchant", "AddressLine1": "2201 WESTLAKE AVE", @@ -335,7 +337,8 @@ "IsPrime": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, - "IsSoldByAB": false + "IsSoldByAB": false, + "IsIBA": false } ] } @@ -380,7 +383,8 @@ "IsPrime": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, - "IsSoldByAB": false + "IsSoldByAB": false, + "IsIBA": false } ] } @@ -427,7 +431,8 @@ "IsPrime": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, - "IsSoldByAB": false + "IsSoldByAB": false, + "IsIBA": false } ] } @@ -599,6 +604,7 @@ "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, + "IsIBA": false, "DefaultShipFromLocationAddress": { "Name": "MFNIntegrationTestMerchant", "AddressLine1": "2201 WESTLAKE AVE", @@ -687,6 +693,7 @@ "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, + "IsIBA": false, "DefaultShipFromLocationAddress": { "Name": "MFNIntegrationTestMerchant", "AddressLine1": "2201 WESTLAKE AVE", @@ -747,6 +754,7 @@ "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": true, + "IsIBA": true, "DefaultShipFromLocationAddress": { "Name": "MFNIntegrationTestMerchant", "AddressLine1": "2201 WESTLAKE AVE", @@ -891,7 +899,7 @@ "tags": [ "ordersV0" ], - "description": "Returns buyer information for the specified order.\n\n**Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md).\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0055 | 20 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "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.", "operationId": "getOrderBuyerInfo", "parameters": [ { @@ -1073,7 +1081,7 @@ "tags": [ "ordersV0" ], - "description": "Returns the shipping address for the specified order.\n\n**Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md).\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0055 | 20 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "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.", "operationId": "getOrderAddress", "parameters": [ { @@ -1338,6 +1346,10 @@ "Amount": "41.99" }, "GiftWrapLevel": "Classic" + }, + "BuyerRequestedCancel": { + "IsBuyerRequestedCancel": true, + "BuyerCancelReason": "Found cheaper somewhere else." } }, { @@ -1367,6 +1379,10 @@ "Amount": "1.99" }, "GiftWrapLevel": "Classic" + }, + "BuyerRequestedCancel": { + "IsBuyerRequestedCancel": true, + "BuyerCancelReason": "Found cheaper somewhere else." } } ] @@ -1426,7 +1442,11 @@ "SerialNumberRequired": false, "IossNumber": "", "DeemedResellerCategory": "IOSS", - "StoreChainStoreId": "ISPU_StoreId" + "StoreChainStoreId": "ISPU_StoreId", + "BuyerRequestedCancel": { + "IsBuyerRequestedCancel": true, + "BuyerCancelReason": "Found cheaper somewhere else." + } } ] } @@ -1556,7 +1576,7 @@ "tags": [ "ordersV0" ], - "description": "Returns buyer information for the order items in the specified order.\n\n**Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md).\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 0.0055 | 20 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "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.", "operationId": "getOrderItemsBuyerInfo", "parameters": [ { @@ -1934,6 +1954,536 @@ } } } + }, + "/orders/v0/orders/{orderId}/regulatedInfo": { + "get": { + "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.", + "operationId": "getOrderRegulatedInfo", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "An orderId is an Amazon-defined order identifier, in 3-7-7 format.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$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." + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + } + } + }, + "response": { + "payload": { + "AmazonOrderId": "902-3159896-1390916", + "RequiresDosageLabel": false, + "RegulatedInformation": { + "Fields": [ + { + "FieldId": "pet_prescription_name", + "FieldLabel": "Name", + "FieldType": "Text", + "FieldValue": "Ruffus" + }, + { + "FieldId": "pet_prescription_species", + "FieldLabel": "Species", + "FieldType": "Text", + "FieldValue": "Dog" + } + ] + }, + "RegulatedOrderVerificationStatus": { + "Status": "Pending", + "RequiresMerchantAction": true, + "ValidRejectionReasons": [ + { + "RejectionReasonId": "shield_pom_vps_reject_product", + "RejectionReasonDescription": "This medicine is not suitable for your pet." + }, + { + "RejectionReasonId": "shield_pom_vps_reject_age", + "RejectionReasonDescription": "Your pet is too young for this medicine." + }, + { + "RejectionReasonId": "shield_pom_vps_reject_incorrect_weight", + "RejectionReasonDescription": "Your pet's weight does not match ordered size." + } + ] + } + } + } + } + ] + }, + "examples": { + "PendingOrder": { + "payload": { + "AmazonOrderId": "902-3159896-1390916", + "RequiresDosageLabel": false, + "RegulatedInformation": { + "Fields": [ + { + "FieldId": "pet_prescription_name", + "FieldLabel": "Name", + "FieldType": "Text", + "FieldValue": "Ruffus" + }, + { + "FieldId": "pet_prescription_species", + "FieldLabel": "Species", + "FieldType": "Text", + "FieldValue": "Dog" + } + ] + }, + "RegulatedOrderVerificationStatus": { + "Status": "Pending", + "RequiresMerchantAction": true, + "ValidRejectionReasons": [ + { + "RejectionReasonId": "shield_pom_vps_reject_product", + "RejectionReasonDescription": "This medicine is not suitable for your pet." + }, + { + "RejectionReasonId": "shield_pom_vps_reject_age", + "RejectionReasonDescription": "Your pet is too young for this medicine." + }, + { + "RejectionReasonId": "shield_pom_vps_reject_incorrect_weight", + "RejectionReasonDescription": "Your pet's weight does not match ordered size." + } + ] + } + } + }, + "ApprovedOrder": { + "payload": { + "AmazonOrderId": "902-3159896-1390916", + "RequiresDosageLabel": false, + "RegulatedInformation": { + "Fields": [ + { + "FieldId": "pet_prescription_name", + "FieldLabel": "Name", + "FieldType": "Text", + "FieldValue": "Ruffus" + }, + { + "FieldId": "pet_prescription_species", + "FieldLabel": "Species", + "FieldType": "Text", + "FieldValue": "Dog" + } + ] + }, + "RegulatedOrderVerificationStatus": { + "Status": "Approved", + "RequiresMerchantAction": false, + "ValidRejectionReasons": [], + "ExternalReviewerId": "externalId", + "ReviewDate": "1970-01-19T03:59:27Z" + } + } + }, + "RejectedOrder": { + "payload": { + "AmazonOrderId": "902-3159896-1390916", + "RequiresDosageLabel": false, + "RegulatedInformation": { + "Fields": [ + { + "FieldId": "pet_prescription_name", + "FieldLabel": "Name", + "FieldType": "Text", + "FieldValue": "Ruffus" + }, + { + "FieldId": "pet_prescription_species", + "FieldLabel": "Species", + "FieldType": "Text", + "FieldValue": "Dog" + } + ] + }, + "RegulatedOrderVerificationStatus": { + "Status": "Rejected", + "RequiresMerchantAction": false, + "RejectionReason": { + "RejectionReasonId": "shield_pom_vps_reject_species", + "RejectionReasonDescription": "This medicine is not suitable for this type of pet." + }, + "ValidRejectionReasons": [], + "ExternalReviewerId": "externalId", + "ReviewDate": "1970-01-19T03:59:27Z" + } + } + } + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$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." + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "orderId": { + "value": "TEST_CASE_400" + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Invalid Input" + } + ] + } + } + ] + } + }, + "403": { + "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/GetOrderRegulatedInfoResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference ID." + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "schema": { + "$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." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$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." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$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." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$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." + } + } + } + } + }, + "patch": { + "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.", + "operationId": "updateVerificationStatus", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "An orderId is an Amazon-defined order identifier, in 3-7-7 format.", + "required": true, + "type": "string" + }, + { + "name": "payload", + "in": "body", + "description": "Request to update the verification status of an order containing regulated products.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateVerificationStatusRequest" + } + } + ], + "responses": { + "204": { + "description": "Success.", + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "status": "Rejected", + "externalReviewerId": "reviewer1234", + "rejectionReasonId": "shield_pom_vps_reject_incorrect_weight" + } + } + } + } + }, + "response": {} + } + ] + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference ID.", + "type": "string" + } + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "status": "Rejected" + } + } + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Missing request parameter: rejectionReasonId." + }, + { + "code": "InvalidInput", + "message": "Missing request parameter: externalReviewerId." + } + ] + } + }, + { + "request": { + "parameters": { + "orderId": { + "value": "902-3159896-1390916" + }, + "body": { + "value": { + "regulatedOrderVerificationStatus": { + "status": "Cancelled", + "externalReviewerId": "reviewer1234" + } + } + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidInput", + "message": "Invalid request parameter `status`. Must be one of [Approved, Rejected]." + } + ] + } + } + ] + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference ID.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/UpdateVerificationStatusErrorResponse" + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference ID.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/UpdateVerificationStatusErrorResponse" + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference ID.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/UpdateVerificationStatusErrorResponse" + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference ID.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/UpdateVerificationStatusErrorResponse" + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference ID.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/UpdateVerificationStatusErrorResponse" + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference ID.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/UpdateVerificationStatusErrorResponse" + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference ID.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/UpdateVerificationStatusErrorResponse" + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference ID.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/UpdateVerificationStatusErrorResponse" + } + } + } + } } }, "definitions": { @@ -1956,6 +2506,55 @@ "shipmentStatus" ] }, + "UpdateVerificationStatusRequest": { + "description": "Request to update the verification status of an order containing regulated products.", + "type": "object", + "properties": { + "regulatedOrderVerificationStatus": { + "description": "The updated values of the VerificationStatus field.", + "$ref": "#/definitions/UpdateVerificationStatusRequestBody" + } + }, + "required": [ + "regulatedOrderVerificationStatus" + ] + }, + "UpdateVerificationStatusRequestBody": { + "description": "The updated values of the VerificationStatus field.", + "type": "object", + "properties": { + "status": { + "description": "The new verification status of the order.", + "type": "string", + "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.", + "type": "string" + }, + "rejectionReasonId": { + "description": "The unique identifier for the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected.", + "type": "string" + } + }, + "required": [ + "status", + "externalReviewerId" + ] + }, "MarketplaceId": { "description": "the unobfuscated marketplace ID", "type": "string" @@ -1996,6 +2595,16 @@ }, "description": "The error response schema for the UpdateShipmentStatus operation." }, + "UpdateVerificationStatusErrorResponse": { + "type": "object", + "properties": { + "errors": { + "description": "One or more unexpected errors occurred during the UpdateVerificationStatus operation.", + "$ref": "#/definitions/ErrorList" + } + }, + "description": "The error response schema for the UpdateVerificationStatus operation." + }, "GetOrdersResponse": { "type": "object", "properties": { @@ -2038,6 +2647,20 @@ }, "description": "The response schema for the getOrderBuyerInfo operation." }, + "GetOrderRegulatedInfoResponse": { + "type": "object", + "properties": { + "payload": { + "description": "The payload for the getOrderBuyerInfo operations.", + "$ref": "#/definitions/OrderRegulatedInfo" + }, + "errors": { + "description": "One or more unexpected errors occurred during the getOrderRegulatedInfo operation.", + "$ref": "#/definitions/ErrorList" + } + }, + "description": "The response schema for the getOrderRegulatedInfo operation." + }, "GetOrderAddressResponse": { "type": "object", "properties": { @@ -2358,6 +2981,10 @@ "type": "boolean", "description": "When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller." }, + "IsIBA": { + "type": "boolean", + "description": "When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller." + }, "DefaultShipFromLocationAddress": { "description": "The recommended location for the seller to ship the items from. It is calculated at checkout. The seller may or may not choose to ship from this location.", "$ref": "#/definitions/Address" @@ -2378,7 +3005,7 @@ "description": "Buyer should be issued a business invoice. Tax information is available in BuyerTaxInformation structure." } ], - "description": "The buyer’s invoicing preference." + "description": "The buyer's invoicing preference. Available only in the TR marketplace." }, "BuyerTaxInformation": { "description": "Contains the business invoice tax information.", @@ -2409,6 +3036,10 @@ "AutomatedShippingSettings": { "description": "Contains information regarding the Shipping Settings Automaton program, such as whether the order's shipping settings were generated automatically, and what those settings are.", "$ref": "#/definitions/AutomatedShippingSettings" + }, + "HasRegulatedItems": { + "type": "boolean", + "description": "Whether the order contains regulated items which may require additional approval steps before being fulfilled." } }, "description": "Order information." @@ -2446,6 +3077,177 @@ }, "description": "Buyer information for an order." }, + "OrderRegulatedInfo": { + "description": "The order's regulated information along with its verification status.", + "type": "object", + "required": [ + "AmazonOrderId", + "RegulatedInformation", + "RegulatedOrderVerificationStatus", + "RequiresDosageLabel" + ], + "properties": { + "AmazonOrderId": { + "type": "string", + "description": "An Amazon-defined order identifier, in 3-7-7 format." + }, + "RegulatedInformation": { + "$ref": "#/definitions/RegulatedInformation", + "description": "The regulated information collected during purchase and used to verify the order." + }, + "RequiresDosageLabel": { + "type": "boolean", + "description": "Whether the order requires attaching a dosage information label when shipped." + }, + "RegulatedOrderVerificationStatus": { + "$ref": "#/definitions/RegulatedOrderVerificationStatus", + "description": "The order's verification status." + } + } + }, + "RegulatedOrderVerificationStatus": { + "type": "object", + "description": "The verification status of the order along with associated approval or rejection metadata.", + "required": [ + "Status", + "RequiresMerchantAction", + "ValidRejectionReasons" + ], + "properties": { + "Status": { + "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." + } + ] + }, + "RequiresMerchantAction": { + "type": "boolean", + "description": "Whether the regulated information provided in the order requires a review by the merchant." + }, + "ValidRejectionReasons": { + "type": "array", + "description": "A list of valid rejection reasons that may be used to reject the order's regulated information.", + "items": { + "$ref": "#/definitions/RejectionReason" + } + }, + "RejectionReason": { + "$ref": "#/definitions/RejectionReason", + "description": "The reason for rejecting the order's regulated information. Not present if the order isn't rejected." + }, + "ReviewDate": { + "type": "string", + "description": "The date the order was reviewed. In ISO 8601 date time format." + }, + "ExternalReviewerId": { + "type": "string", + "description": "The identifier for the order's regulated information reviewer." + } + } + }, + "RejectionReason": { + "type": "object", + "description": "The reason for rejecting the order's regulated information. Not present if the order isn't rejected.", + "required": [ + "RejectionReasonId", + "RejectionReasonDescription" + ], + "properties": { + "RejectionReasonId": { + "type": "string", + "description": "The unique identifier for the rejection reason." + }, + "RejectionReasonDescription": { + "type": "string", + "description": "The human-readable description of this rejection reason." + } + } + }, + "RegulatedInformation": { + "type": "object", + "description": "The regulated information collected during purchase and used to verify the order.", + "required": [ + "Fields" + ], + "properties": { + "Fields": { + "type": "array", + "description": "A list of regulated information fields as collected from the regulatory form.", + "items": { + "$ref": "#/definitions/RegulatedInformationField" + } + } + } + }, + "RegulatedInformationField": { + "type": "object", + "required": [ + "FieldId", + "FieldLabel", + "FieldType", + "FieldValue" + ], + "description": "A field collected from the regulatory form.", + "properties": { + "FieldId": { + "type": "string", + "description": "The unique identifier for the field." + }, + "FieldLabel": { + "type": "string", + "description": "The human-readable name for the field." + }, + "FieldType": { + "type": "string", + "description": "The type of field the field.", + "enum": [ + "Text", + "FileAttachment" + ], + "x-docgen-enum-table-extension": [ + { + "value": "Text", + "description": "This field is a text representation of a response collected from the regulatory form." + }, + { + "value": "FileAttachment", + "description": "This field contains the link to an attachment collected from the regulatory form." + } + ] + }, + "FieldValue": { + "type": "string", + "description": "The content of the field as collected in regulatory form. Note that FileAttachment type fields will contain an URL to download the attachment here." + } + } + }, "OrderAddress": { "type": "object", "required": [ @@ -2809,6 +3611,10 @@ }, "BuyerInfo": { "$ref": "#/definitions/ItemBuyerInfo" + }, + "BuyerRequestedCancel": { + "description": "Information about whether or not a buyer requested cancellation.", + "$ref": "#/definitions/BuyerRequestedCancel" } }, "description": "A single order item." @@ -2967,7 +3773,7 @@ "description": "Business buyer's tax office." } }, - "description": "Contains the business invoice tax information." + "description": "Contains the business invoice tax information. Available only in the TR marketplace." }, "FulfillmentInstruction": { "type": "object", @@ -3049,6 +3855,20 @@ } } }, + "BuyerRequestedCancel": { + "type": "object", + "properties": { + "IsBuyerRequestedCancel": { + "type": "boolean", + "description": "When true, the buyer has requested cancellation." + }, + "BuyerCancelReason": { + "type": "string", + "description": "Reason for buyer requesting cancel" + } + }, + "description": "Information about whether or not a buyer requested cancellation." + }, "ErrorList": { "type": "array", "description": "A list of error responses returned when a request is unsuccessful.", @@ -3079,4 +3899,4 @@ "description": "Error response returned when the request is unsuccessful." } } -} \ No newline at end of file +} diff --git a/models/product-type-definitions-api-model/definitionsProductTypes_2020-09-01.json b/models/product-type-definitions-api-model/definitionsProductTypes_2020-09-01.json index 4e09959..9704dfd 100644 --- a/models/product-type-definitions-api-model/definitionsProductTypes_2020-09-01.json +++ b/models/product-type-definitions-api-model/definitionsProductTypes_2020-09-01.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "description": "The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds).\n\nFor more information, see the [Product Type Definitions API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/product-type-definitions-api-use-case-guide/definitions-product-types-api-use-case-guide_2020-09-01.md).", + "description": "The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds).\n\nFor more information, see the [Product Type Definitions API Use Case Guide](doc:product-type-api-use-case-guide).", "version": "2020-09-01", "title": "Selling Partner API for Product Type Definitions", "contact": { @@ -29,7 +29,7 @@ "tags": [ "definitions" ], - "description": "Search for and return a list of Amazon product types that have definitions available.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\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](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Search for and return a list of Amazon product types that have definitions available.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\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](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "searchDefinitionsProductTypes", "consumes": [ "application/json" @@ -264,7 +264,7 @@ "tags": [ "definitions" ], - "description": "Retrieve an Amazon product type definition.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\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](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).", + "description": "Retrieve an Amazon product type definition.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\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](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getDefinitionsProductType", "consumes": [ "application/json" diff --git a/models/shipment-invoicing-api-model/shipmentInvoicingV0.json b/models/shipment-invoicing-api-model/shipmentInvoicingV0.json index 9852825..de0b36c 100644 --- a/models/shipment-invoicing-api-model/shipmentInvoicingV0.json +++ b/models/shipment-invoicing-api-model/shipmentInvoicingV0.json @@ -35,7 +35,7 @@ { "name": "shipmentId", "in": "path", - "description": "The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the [Notifications API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/notifications-api-use-case-guide/notifications-use-case-guide-v1.md).", + "description": "The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the [Notifications API Use Case Guide](doc:notifications-api-v1-use-case-guide).", "required": true, "type": "string" } @@ -1132,4 +1132,4 @@ "description": "The response schema for the getInvoiceStatus operation." } } -} +} \ No newline at end of file diff --git a/models/shipping-api-model/.DS_Store b/models/shipping-api-model/.DS_Store new file mode 100644 index 0000000..06113e5 Binary files /dev/null and b/models/shipping-api-model/.DS_Store differ diff --git a/models/tokens-api-model/tokens_2021-03-01.json b/models/tokens-api-model/tokens_2021-03-01.json index 00b6863..2766753 100644 --- a/models/tokens-api-model/tokens_2021-03-01.json +++ b/models/tokens-api-model/tokens_2021-03-01.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "description": "The Selling Partner API for Tokens provides a secure way to access a customer's PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes subsequent calls to restricted operations that correspond to the restricted resources that you specified.\n\nFor more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md).", + "description": "The Selling Partner API for Tokens provides a secure way to access a customer's PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes subsequent calls to restricted operations that correspond to the restricted resources that you specified.\n\nFor more information, see the [Tokens API Use Case Guide](doc:tokens-api-use-case-guide).", "version": "2021-03-01", "title": "Selling Partner API for Tokens ", "contact": { @@ -321,7 +321,7 @@ }, "dataElements": { "type": "array", - "description": "Indicates the type of Personally Identifiable Information requested. This parameter is required only when getting an RDT for use with the getOrder, getOrders, or getOrderItems operation of the Orders API. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). Possible values include:\n- **buyerInfo**. On the order level this includes general identifying information about the buyer and tax-related information. On the order item level this includes gift wrap information and custom order information, if available.\n- **shippingAddress**. This includes information for fulfilling orders.", + "description": "Indicates the type of Personally Identifiable Information requested. This parameter is required only when getting an RDT for use with the getOrder, getOrders, or getOrderItems operation of the Orders API. For more information, see the [Tokens API Use Case Guide](doc:tokens-api-use-case-guide). Possible values include:\n- **buyerInfo**. On the order level this includes general identifying information about the buyer and tax-related information. On the order item level this includes gift wrap information and custom order information, if available.\n- **shippingAddress**. This includes information for fulfilling orders.\n- **buyerTaxInformation**. This includes information for issuing tax invoices.", "items": { "type": "string" }