diff --git a/.DS_Store b/.DS_Store index 066d450b..52e8b63d 100644 Binary files a/.DS_Store and b/.DS_Store differ diff --git a/models/.DS_Store b/models/.DS_Store index e4e25f86..cd5aa68a 100644 Binary files a/models/.DS_Store and b/models/.DS_Store differ diff --git a/models/fba-small-and-light-api-model/fbaSmallandLight.json b/models/fba-small-and-light-api-model/fbaSmallandLight.json index 04d86edf..b5e5aac9 100644 --- a/models/fba-small-and-light-api-model/fbaSmallandLight.json +++ b/models/fba-small-and-light-api-model/fbaSmallandLight.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "description": "The Selling Partner API for FBA Small and Light lets you help sellers manage their listings in the Small and Light program. The program reduces the cost of fulfilling orders for small and lightweight FBA inventory. You can enroll or remove items from the program and check item eligibility and enrollment status. You can also preview the estimated program fees charged to a seller for items sold while enrolled in the program.", + "description": "The Selling Partner API for FBA Small and Light lets you help sellers manage their listings in the Small and Light program. The program reduces the cost of fulfilling orders for small and lightweight FBA inventory. You can enroll or remove items from the program and check item eligibility and enrollment status. You can also preview the estimated program fees charged to a seller for items sold while enrolled in the program. \n\n**Note:** The FBA Small and Light program sunset in the US and EU regions on **September 26, 2023**. The program will be deprecated in the JP region on **March 31, 2024** and sunset on **April 1, 2024**. APIs announcing deprecation will no longer be supported after their deprecation date. Calls to deprecated APIs will fail beginning on their sunset date. For more information, refer to [FBA Small and Light program deprecation](https://developer-docs.amazon.com/sp-api/changelog/fba-small-and-light-program-deprecation).", "version": "v1", "title": "Selling Partner API for FBA Small And Light", "contact": { @@ -31,6 +31,7 @@ ], "description": "Returns the Small and Light enrollment status for the item indicated by the specified seller SKU in the specified marketplace.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getSmallAndLightEnrollmentBySellerSKU", + "deprecated": true, "parameters": [ { "name": "sellerSKU", @@ -431,6 +432,7 @@ ], "description": "Enrolls the item indicated by the specified seller SKU in the Small and Light program in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 5 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "putSmallAndLightEnrollmentBySellerSKU", + "deprecated": true, "parameters": [ { "name": "sellerSKU", @@ -831,6 +833,7 @@ ], "description": "Removes the item indicated by the specified seller SKU from the Small and Light program in the specified marketplace. If the item is not eligible for disenrollment, the ineligibility reasons are returned.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 5 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "deleteSmallAndLightEnrollmentBySellerSKU", + "deprecated": true, "parameters": [ { "name": "sellerSKU", @@ -1226,6 +1229,7 @@ ], "description": "Returns the Small and Light program eligibility status of the item indicated by the specified seller SKU in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getSmallAndLightEligibilityBySellerSKU", + "deprecated": true, "parameters": [ { "name": "sellerSKU", @@ -1628,6 +1632,7 @@ ], "description": "Returns the Small and Light fee estimates for the specified items. You must include a marketplaceId parameter to retrieve the proper fee estimates for items to be sold in that marketplace. The ordering of items in the response will mirror the order of the items in the request. Duplicate ASIN/price combinations are removed.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 3 |\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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getSmallAndLightFeePreview", + "deprecated": true, "parameters": [ { "in": "body", @@ -2027,11 +2032,11 @@ }, "message": { "type": "string", - "description": "A message that describes the error condition in a human-readable form." + "description": "A message that describes the error condition." }, "details": { "type": "string", - "description": "Additional information that can help the caller understand or fix the issue." + "description": "Additional details that can help the caller understand or fix the issue." } }, "description": "Error response returned when the request is unsuccessful." diff --git a/models/product-fees-api-model/productFeesV0.json b/models/product-fees-api-model/productFeesV0.json index 17fb9391..e5839a83 100644 --- a/models/product-fees-api-model/productFeesV0.json +++ b/models/product-fees-api-model/productFeesV0.json @@ -29,7 +29,7 @@ "tags": [ "fees" ], - "description": "Returns the estimated fees for the item indicated by the specified seller SKU in the marketplace specified in the request body.\n\n**Note:** The parameters associated with this operation may contain special characters that require URL encoding to call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\nYou can call `getMyFeesEstimateForSKU` for an item on behalf of a selling partner before the selling partner sets the item's price. The selling partner can then take any estimated fees into account. Each fees estimate request must include an original identifier. This identifier is included in the fees estimate so that you can correlate a fees estimate with the original request.\n\n**Note:** This identifier value is used to identify an estimate. Actual costs may vary. Search \"fees\" in [Seller Central](https://sellercentral.amazon.com/) and consult the store-specific fee schedule for the most up-to-date information.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 2 |\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 than 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).", + "description": "Returns the estimated fees for the item indicated by the specified seller SKU in the marketplace specified in the request body.\n\n**Note:** The parameters associated with this operation may contain special characters that require URL encoding to call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\nYou can call `getMyFeesEstimateForSKU` for an item on behalf of a selling partner before the selling partner sets the item's price. The selling partner can then take any estimated fees into account. Each fees estimate request must include an original identifier. This identifier is included in the fees estimate so that you can correlate a fees estimate with the original request.\n\n**Note:** This identifier value is used to identify an estimate. Actual costs may vary. Search \"fees\" in [Seller Central](https://sellercentral.amazon.com/) and consult the store-specific fee schedule for the most up-to-date information.\n\n**Note:** When sellers use the `getMyFeesEstimateForSKU` operation with their `SellerSKU`, they get accurate fees based on real item measurements, but only after they've sent their items to Amazon.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 2 |\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 than 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": "getMyFeesEstimateForSKU", "parameters": [ { @@ -290,7 +290,7 @@ "tags": [ "fees" ], - "description": "Returns the estimated fees for the item indicated by the specified ASIN in the marketplace specified in the request body.\n\nYou can call `getMyFeesEstimateForASIN` for an item on behalf of a selling partner before the selling partner sets the item's price. The selling partner can then take estimated fees into account. Each fees request must include an original identifier. This identifier is included in the fees estimate so you can correlate a fees estimate with the original request.\n\n**Note:** This identifier value is used to identify an estimate. Actual costs may vary. Search \"fees\" in [Seller Central](https://sellercentral.amazon.com/) and consult the store-specific fee schedule for the most up-to-date information.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 2 |\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 than 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).", + "description": "Returns the estimated fees for the item indicated by the specified ASIN in the marketplace specified in the request body.\n\nYou can call `getMyFeesEstimateForASIN` for an item on behalf of a selling partner before the selling partner sets the item's price. The selling partner can then take estimated fees into account. Each fees request must include an original identifier. This identifier is included in the fees estimate so you can correlate a fees estimate with the original request.\n\n**Note:** This identifier value is used to identify an estimate. Actual costs may vary. Search \"fees\" in [Seller Central](https://sellercentral.amazon.com/) and consult the store-specific fee schedule for the most up-to-date information.\n\n**Note:** When using the `getMyFeesEstimateForASIN` operation with an ASIN, the fee estimates might be different. This is because these estimates use the item's catalog size, which might not always match the actual size of the item sent to Amazon.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 2 |\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 than 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": "getMyFeesEstimateForASIN", "parameters": [ { @@ -1035,7 +1035,7 @@ }, "details": { "type": "string", - "description": "Additional information that can help the caller understand or fix the issue." + "description": "Additional details that can help the caller understand or fix the issue." } } }, @@ -1276,7 +1276,7 @@ }, { "value": "FBA_SNL", - "description": "Returns the FBA Small and Light (SNL) fees for the offer. The SNL program offers reduced fulfillment costs on qualified items. To check item eligibility for the SNL program, use the getSmallAndLightEligibilityBySellerSKU operation of the FBA Small And Light API." + "description": "Returns the FBA Small and Light (SNL) fees for the offer. The SNL program offers reduced fulfillment costs on qualified items. To check item eligibility for the SNL program, use the getSmallAndLightEligibilityBySellerSKU operation of the FBA Small And Light API.\n\n**Note:** The FBA Small and Light program sunset in the US and EU regions on **September 26, 2023**. The program will be deprecated in the JP region on **March 31, 2024** and sunset on **April 1, 2024**. APIs announcing deprecation will no longer be supported after their deprecation date. Calls to deprecated APIs will fail beginning on their sunset date. For more information, refer to [FBA Small and Light program deprecation](https://developer-docs.amazon.com/sp-api/changelog/fba-small-and-light-program-deprecation)." }, { "value": "FBA_EFN", diff --git a/schemas/notifications/ListingsItemIssuesChangeNotification.json b/schemas/notifications/ListingsItemIssuesChangeNotification.json index 957aa814..7e465caf 100644 --- a/schemas/notifications/ListingsItemIssuesChangeNotification.json +++ b/schemas/notifications/ListingsItemIssuesChangeNotification.json @@ -242,4 +242,4 @@ } } } -} +} \ No newline at end of file diff --git a/schemas/notifications/ListingsItemIssuesChangeNotification_2023-12-13.json b/schemas/notifications/ListingsItemIssuesChangeNotification_2023-12-13.json new file mode 100644 index 00000000..ac9687e7 --- /dev/null +++ b/schemas/notifications/ListingsItemIssuesChangeNotification_2023-12-13.json @@ -0,0 +1,245 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Listings Item Issues Change Notification", + "description": "To be delivered when issues are created, changed, or resolved for a listings item.", + "type": "object", + "examples": [ + { + "NotificationVersion": "1.0", + "NotificationType": "LISTINGS_ITEM_ISSUES_CHANGE", + "PayloadVersion": "2023-12-13", + "EventTime": "2024-02-05T18:59:30.194Z", + "Payload": { + "SellerId": "AXXXXXXXXXXXXX", + "MarketplaceId": "ATVPDKIKX0DER", + "Asin": "BT6RZ7JM4H", + "Sku": "NLS-SHOES-03", + "Severities": [ + "ERROR", + "WARNING" + ], + "EnforcementActions": [ + "SEARCH_SUPPRESSED", + "LISTING_SUPPRESSED", + "ATTRIBUTE_SUPPRESSED", + "CATALOG_ITEM_REMOVED" + ] + }, + "NotificationMetadata": { + "ApplicationId": "amzn1.sellerapps.app.f108f511-eeac-46a6-b125-bcb752069ed0", + "SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369", + "PublishTime": "2024-02-05T18:59:48.768Z", + "NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60" + } + } + ], + "required": [ + "NotificationVersion", + "NotificationType", + "PayloadVersion", + "EventTime", + "Payload", + "NotificationMetadata" + ], + "properties": { + "NotificationVersion": { + "type": "string", + "title": "Notification Version", + "description": "The version of the notification.", + "examples": [ + "1.0" + ] + }, + "NotificationType": { + "type": "string", + "title": "Notification Type", + "description": "The type of the notification.", + "enum": ["LISTINGS_ITEM_ISSUES_CHANGE"] + }, + "PayloadVersion": { + "type": "string", + "title": "Payload Version", + "description": "The version of the payload.", + "examples": [ + "2023-12-13" + ] + }, + "EventTime": { + "type": "string", + "format": "date-time", + "title": "Event Time", + "description": "Timestamp of the event, formatted as ISO8601 date-time.", + "examples": [ + "2019-03-20T18:59:30.194Z" + ] + }, + "Payload": { + "type": "object", + "title": "Payload", + "description": "The details of this notification.", + "examples": [ + { + "SellerId": "A3AYAZLIQ7AX77", + "MarketplaceId": "ATVPDKIKX0DER", + "Asin": "BT6RZ7JM4H", + "Sku": "NLS-SHOES-03", + "Severities": [ + "ERROR", + "WARNING" + ], + "EnforcementActions": [ + "SEARCH_SUPPRESSED", + "LISTING_SUPPRESSED", + "ATTRIBUTE_SUPPRESSED", + "CATALOG_ITEM_REMOVED" + ] + } + ], + "required": [ + "SellerId", + "Sku", + "Severities" + ], + "properties": { + "SellerId": { + "type": "string", + "title": "Seller ID", + "description": "Selling partner identifier, such as a merchant account or vendor code, of the affected listings item.", + "examples": [ + "AXXXXXXXXXXXXX", + "TXXXX" + ] + }, + "MarketplaceId": { + "type": "string", + "title": "Marketplace ID", + "description": "Amazon marketplace identifier of the affected listings item.", + "examples": [ + "ATVPDKIKX0DER" + ] + }, + "Asin": { + "type": "string", + "title": "ASIN", + "description": "The Amazon Standard Identification Number (ASIN) identifier of the catalog item associated with the listings item.", + "examples": [ + "BT6RZ7JM4H" + ] + }, + "Sku": { + "type": "string", + "title": "SKU", + "description": "Identifier of the affected listings item.", + "examples": [ + "NLS-SHOES-03" + ] + }, + "Severities": { + "type": "array", + "title": "Severities", + "description": "Array of severities for the issues currently associated with the affected listings item. When no issues are affecting the listings item, \"NONE\" is provided instead.", + "items": { + "type": "string", + "enum": [ + "NONE", + "ERROR", + "WARNING" + ], + "x-docgen-enum-table-extension": [ + { + "value": "NONE", + "description": "When provided, no issues are affecting the listings item." + }, + { + "value": "ERROR", + "description": "When provided, at least one issue with \"ERROR\" severity is affecting the listings item." + }, + { + "value": "WARNING", + "description": "When provided, at least one issue with \"WARNING\" severity is affecting the listings item." + } + ] + }, + "uniqueItems": true, + "examples": [ + [ + "ERROR", + "WARNING" + ] + ] + }, + "EnforcementActions": { + "type": "array", + "title": "Enforcement Actions Taken", + "description": "Array of enforcement actions taken by Amazon for the issues associated with the affected listings item. Possible values: 'LISTING_SUPPRESSED' - This enforcement takes down the current listing item's buyability. 'ATTRIBUTE_SUPPRESSED' - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon. 'CATALOG_ITEM_REMOVED' - This catalog item is inactive on Amazon, and all offers against it in the applicable marketplace are non-buyable. 'SEARCH_SUPPRESSED' - This value indicates that the catalog item is hidden from search results.", + "items": { + "type": "string" + }, + "uniqueItems": true, + "examples": [ + [ + "SEARCH_SUPPRESSED", + "LISTING_SUPPRESSED", + "ATTRIBUTE_SUPPRESSED", + "CATALOG_ITEM_REMOVED" + ] + ] + } + } + }, + "NotificationMetadata": { + "type": "object", + "title": "Notification Metadata", + "description": "The metadata of the notification.", + "examples": [ + { + "ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5", + "SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369", + "PublishTime": "2019-03-20T18:59:48.768Z", + "NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60" + } + ], + "required": [ + "ApplicationId", + "SubscriptionId", + "PublishTime", + "NotificationId" + ], + "properties": { + "ApplicationId": { + "type": "string", + "title": "Application ID", + "description": "Identifies the application.", + "examples": [ + "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5" + ] + }, + "SubscriptionId": { + "type": "string", + "title": "Subscription ID", + "description": "Identifies the subscription.", + "examples": [ + "93b098e1-c42-2f45-93a1-78910a6a8369" + ] + }, + "PublishTime": { + "type": "string", + "format": "date-time", + "title": "Publish Time", + "description": "Timestamp of when the notification was published, formatted as ISO8601 date-time.", + "examples": [ + "2019-03-20T18:59:48.768Z" + ] + }, + "NotificationId": { + "type": "string", + "title": "Notification ID", + "description": "Identifies the notification.", + "examples": [ + "8e009934-da2c-4f9c-9bc7-93f23b7e1f60" + ] + } + } + } + } +}