python-amazon-sp-api 2.0.15__py3-none-any.whl → 2.1.3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (214) hide show
  1. {python_amazon_sp_api-2.0.15.dist-info → python_amazon_sp_api-2.1.3.dist-info}/METADATA +7 -7
  2. python_amazon_sp_api-2.1.3.dist-info/RECORD +350 -0
  3. sp_api/__version__.py +1 -1
  4. sp_api/api/__init__.py +160 -4
  5. sp_api/api/amazon_warehousing_and_distribu/amazon_warehousing_and_distribu.py +85 -110
  6. sp_api/api/amazon_warehousing_and_distribu/amazon_warehousing_and_distribu_2024_05_09.py +456 -0
  7. sp_api/api/aplus_content/aplus_content.py +176 -125
  8. sp_api/api/application_integrations/application_integrations.py +59 -68
  9. sp_api/api/application_management/application_management.py +20 -13
  10. sp_api/api/authorization/authorization.py +8 -26
  11. sp_api/api/catalog/catalog.py +27 -61
  12. sp_api/api/catalog_items/catalog_items.py +108 -78
  13. sp_api/api/catalog_items/catalog_items_2020_12_01.py +86 -0
  14. sp_api/api/catalog_items/catalog_items_2022_04_01.py +89 -0
  15. sp_api/api/customer_feedback/customer_feedback.py +100 -0
  16. sp_api/api/data_kiosk/data_kiosk.py +80 -75
  17. sp_api/api/delivery_by_amazon/__init__.py +0 -0
  18. sp_api/api/delivery_by_amazon/delivery_by_amazon.py +92 -0
  19. sp_api/api/delivery_by_amazon/delivery_by_amazon_2022_07_01.py +81 -0
  20. sp_api/api/easy_ship/easy_ship.py +121 -111
  21. sp_api/api/external_fulfillment/external_fulfillment.py +211 -434
  22. sp_api/api/external_fulfillment/inventory.py +120 -0
  23. sp_api/api/external_fulfillment/inventory_2021_01_06.py +71 -0
  24. sp_api/api/external_fulfillment/inventory_2024_09_11.py +96 -0
  25. sp_api/api/external_fulfillment/returns.py +120 -0
  26. sp_api/api/external_fulfillment/returns_2021_08_19.py +88 -0
  27. sp_api/api/external_fulfillment/returns_2024_09_11.py +141 -0
  28. sp_api/api/external_fulfillment/shipping.py +120 -0
  29. sp_api/api/external_fulfillment/shipping_2021_01_06.py +256 -0
  30. sp_api/api/external_fulfillment/shipping_2024_09_11.py +233 -0
  31. sp_api/api/fba_inbound_eligibility/fba_inbound_eligibility.py +30 -24
  32. sp_api/api/fba_small_and_light/fba_small_and_light.py +60 -99
  33. sp_api/api/feeds/feeds.py +75 -245
  34. sp_api/api/feeds/feeds_2021_06_30.py +320 -0
  35. sp_api/api/finances/finances.py +123 -90
  36. sp_api/api/finances/finances_2024_06_01.py +71 -0
  37. sp_api/api/finances/finances_2024_06_19.py +114 -0
  38. sp_api/api/finances/finances_v0.py +116 -0
  39. sp_api/api/fulfillment_inbound/fulfillment_inbound.py +107 -1784
  40. sp_api/api/fulfillment_inbound/fulfillment_inbound_2024_03_20.py +1722 -0
  41. sp_api/api/fulfillment_inbound/fulfillment_inbound_v0.py +1384 -0
  42. sp_api/api/fulfillment_outbound/fulfillment_outbound.py +256 -480
  43. sp_api/api/inventories/inventories.py +79 -42
  44. sp_api/api/invoices/__init__.py +0 -0
  45. sp_api/api/invoices/invoices.py +92 -0
  46. sp_api/api/invoices/invoices_2024_06_19.py +344 -0
  47. sp_api/api/listings_items/listings_items.py +110 -163
  48. sp_api/api/listings_items/listings_items_2020_09_01.py +189 -0
  49. sp_api/api/listings_items/listings_items_2021_08_01.py +233 -0
  50. sp_api/api/listings_restrictions/listings_restrictions.py +23 -10
  51. sp_api/api/merchant_fulfillment/merchant_fulfillment.py +107 -222
  52. sp_api/api/messaging/messaging.py +184 -198
  53. sp_api/api/notifications/notifications.py +144 -106
  54. sp_api/api/orders/orders.py +9 -46
  55. sp_api/api/orders/orders_2026_01_01.py +19 -65
  56. sp_api/api/orders/orders_v0.py +152 -184
  57. sp_api/api/product_fees/product_fees.py +101 -75
  58. sp_api/api/product_type_definitions/product_type_definitions.py +47 -36
  59. sp_api/api/products/products.py +94 -386
  60. sp_api/api/products/products_2022_05_01.py +96 -0
  61. sp_api/api/products/products_v0.py +389 -0
  62. sp_api/api/replenishment/replenishment.py +58 -69
  63. sp_api/api/reports/reports.py +124 -157
  64. sp_api/api/sales/sales.py +22 -39
  65. sp_api/api/seller_wallet/__init__.py +0 -0
  66. sp_api/api/seller_wallet/seller_wallet.py +92 -0
  67. sp_api/api/seller_wallet/seller_wallet_2024_03_01.py +300 -0
  68. sp_api/api/sellers/sellers.py +15 -35
  69. sp_api/api/services/services.py +479 -82
  70. sp_api/api/shipment_invoicing/__init__.py +0 -0
  71. sp_api/api/shipment_invoicing/shipment_invoicing.py +92 -0
  72. sp_api/api/shipment_invoicing/shipment_invoicing_v0.py +101 -0
  73. sp_api/api/shipping/shipping.py +94 -440
  74. sp_api/api/shipping/shippingV2.py +183 -474
  75. sp_api/api/shipping/shipping_v1.py +330 -0
  76. sp_api/api/shipping/shipping_v2.py +723 -0
  77. sp_api/api/solicitations/solicitations.py +28 -18
  78. sp_api/api/supply_sources/supply_sources.py +67 -57
  79. sp_api/api/tokens/tokens.py +14 -35
  80. sp_api/api/vehicles/__init__.py +0 -0
  81. sp_api/api/vehicles/vehicles.py +92 -0
  82. sp_api/api/vehicles/vehicles_2024_11_01.py +33 -0
  83. sp_api/api/vendor_direct_fulfillment_inventory/vendor_direct_fulfillment_inventory.py +16 -29
  84. sp_api/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders.py +116 -189
  85. sp_api/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders_2021_12_28.py +114 -0
  86. sp_api/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders_v1.py +114 -0
  87. sp_api/api/vendor_direct_fulfillment_payments/vendor_direct_fulfillment_payments.py +15 -225
  88. sp_api/api/vendor_direct_fulfillment_sandbox_test_data/__init__.py +0 -0
  89. sp_api/api/vendor_direct_fulfillment_sandbox_test_data/vendor_direct_fulfillment_sandbox_test_data.py +92 -0
  90. sp_api/api/vendor_direct_fulfillment_sandbox_test_data/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.py +50 -0
  91. sp_api/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping.py +122 -624
  92. sp_api/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping_2021_12_28.py +390 -0
  93. sp_api/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping_v1.py +320 -0
  94. sp_api/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions.py +113 -29
  95. sp_api/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions_2021_12_28.py +47 -0
  96. sp_api/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions_v1.py +47 -0
  97. sp_api/api/vendor_invoices/vendor_invoices.py +15 -264
  98. sp_api/api/vendor_orders/vendor_orders.py +83 -131
  99. sp_api/api/vendor_shipments/vendor_shipments.py +149 -68
  100. sp_api/api/vendor_transaction_status/vendor_transaction_status.py +16 -11
  101. sp_api/asyncio/api/__init__.py +159 -4
  102. sp_api/asyncio/api/amazon_warehousing_and_distribu/amazon_warehousing_and_distribu.py +84 -110
  103. sp_api/asyncio/api/amazon_warehousing_and_distribu/amazon_warehousing_and_distribu_2024_05_09.py +457 -0
  104. sp_api/asyncio/api/aplus_content/aplus_content.py +176 -125
  105. sp_api/asyncio/api/application_integrations/application_integrations.py +59 -68
  106. sp_api/asyncio/api/application_management/application_management.py +20 -13
  107. sp_api/asyncio/api/authorization/authorization.py +8 -26
  108. sp_api/asyncio/api/catalog/catalog.py +27 -61
  109. sp_api/asyncio/api/catalog_items/catalog_items.py +94 -71
  110. sp_api/asyncio/api/catalog_items/catalog_items_2020_12_01.py +87 -0
  111. sp_api/asyncio/api/catalog_items/catalog_items_2022_04_01.py +90 -0
  112. sp_api/asyncio/api/customer_feedback/customer_feedback.py +100 -0
  113. sp_api/asyncio/api/data_kiosk/data_kiosk.py +80 -75
  114. sp_api/asyncio/api/delivery_by_amazon/__init__.py +0 -0
  115. sp_api/asyncio/api/delivery_by_amazon/delivery_by_amazon.py +92 -0
  116. sp_api/asyncio/api/delivery_by_amazon/delivery_by_amazon_2022_07_01.py +82 -0
  117. sp_api/asyncio/api/easy_ship/easy_ship.py +121 -111
  118. sp_api/asyncio/api/external_fulfillment/external_fulfillment.py +212 -435
  119. sp_api/asyncio/api/external_fulfillment/inventory.py +126 -0
  120. sp_api/asyncio/api/external_fulfillment/inventory_2021_01_06.py +73 -0
  121. sp_api/asyncio/api/external_fulfillment/inventory_2024_09_11.py +98 -0
  122. sp_api/asyncio/api/external_fulfillment/returns.py +124 -0
  123. sp_api/asyncio/api/external_fulfillment/returns_2021_08_19.py +90 -0
  124. sp_api/asyncio/api/external_fulfillment/returns_2024_09_11.py +143 -0
  125. sp_api/asyncio/api/external_fulfillment/shipping.py +124 -0
  126. sp_api/asyncio/api/external_fulfillment/shipping_2021_01_06.py +258 -0
  127. sp_api/asyncio/api/external_fulfillment/shipping_2024_09_11.py +235 -0
  128. sp_api/asyncio/api/fba_inbound_eligibility/fba_inbound_eligibility.py +31 -25
  129. sp_api/asyncio/api/fba_small_and_light/fba_small_and_light.py +61 -100
  130. sp_api/asyncio/api/feeds/feeds.py +75 -243
  131. sp_api/asyncio/api/feeds/feeds_2021_06_30.py +318 -0
  132. sp_api/asyncio/api/finances/finances.py +123 -91
  133. sp_api/asyncio/api/finances/finances_2024_06_01.py +72 -0
  134. sp_api/asyncio/api/finances/finances_2024_06_19.py +115 -0
  135. sp_api/asyncio/api/finances/finances_v0.py +117 -0
  136. sp_api/asyncio/api/fulfillment_inbound/fulfillment_inbound.py +107 -1785
  137. sp_api/asyncio/api/fulfillment_inbound/fulfillment_inbound_2024_03_20.py +1723 -0
  138. sp_api/asyncio/api/fulfillment_inbound/fulfillment_inbound_v0.py +1385 -0
  139. sp_api/asyncio/api/fulfillment_outbound/fulfillment_outbound.py +257 -481
  140. sp_api/asyncio/api/inventories/inventories.py +79 -42
  141. sp_api/asyncio/api/invoices/__init__.py +0 -0
  142. sp_api/asyncio/api/invoices/invoices.py +92 -0
  143. sp_api/asyncio/api/invoices/invoices_2024_06_19.py +345 -0
  144. sp_api/asyncio/api/listings_items/listings_items.py +109 -163
  145. sp_api/asyncio/api/listings_items/listings_items_2020_09_01.py +190 -0
  146. sp_api/asyncio/api/listings_items/listings_items_2021_08_01.py +233 -0
  147. sp_api/asyncio/api/listings_restrictions/listings_restrictions.py +23 -10
  148. sp_api/asyncio/api/merchant_fulfillment/merchant_fulfillment.py +110 -222
  149. sp_api/asyncio/api/messaging/messaging.py +185 -199
  150. sp_api/asyncio/api/notifications/notifications.py +145 -107
  151. sp_api/asyncio/api/orders/orders.py +9 -46
  152. sp_api/asyncio/api/orders/orders_2026_01_01.py +19 -65
  153. sp_api/asyncio/api/orders/orders_v0.py +152 -184
  154. sp_api/asyncio/api/product_fees/product_fees.py +101 -75
  155. sp_api/asyncio/api/product_type_definitions/product_type_definitions.py +47 -36
  156. sp_api/asyncio/api/products/products.py +94 -387
  157. sp_api/asyncio/api/products/products_2022_05_01.py +109 -0
  158. sp_api/asyncio/api/products/products_v0.py +388 -0
  159. sp_api/asyncio/api/replenishment/replenishment.py +59 -70
  160. sp_api/asyncio/api/reports/reports.py +124 -157
  161. sp_api/asyncio/api/sales/sales.py +22 -39
  162. sp_api/asyncio/api/seller_wallet/__init__.py +0 -0
  163. sp_api/asyncio/api/seller_wallet/seller_wallet.py +92 -0
  164. sp_api/asyncio/api/seller_wallet/seller_wallet_2024_03_01.py +301 -0
  165. sp_api/asyncio/api/sellers/sellers.py +16 -36
  166. sp_api/asyncio/api/services/services.py +479 -82
  167. sp_api/asyncio/api/shipment_invoicing/__init__.py +0 -0
  168. sp_api/asyncio/api/shipment_invoicing/shipment_invoicing.py +92 -0
  169. sp_api/asyncio/api/shipment_invoicing/shipment_invoicing_v0.py +102 -0
  170. sp_api/asyncio/api/shipping/shipping.py +94 -441
  171. sp_api/asyncio/api/shipping/shippingV2.py +181 -472
  172. sp_api/asyncio/api/shipping/shipping_v1.py +331 -0
  173. sp_api/asyncio/api/shipping/shipping_v2.py +717 -0
  174. sp_api/asyncio/api/solicitations/solicitations.py +29 -19
  175. sp_api/asyncio/api/supply_sources/supply_sources.py +67 -57
  176. sp_api/asyncio/api/tokens/tokens.py +14 -35
  177. sp_api/asyncio/api/vehicles/__init__.py +0 -0
  178. sp_api/asyncio/api/vehicles/vehicles.py +92 -0
  179. sp_api/asyncio/api/vehicles/vehicles_2024_11_01.py +34 -0
  180. sp_api/asyncio/api/vendor_direct_fulfillment_inventory/vendor_direct_fulfillment_inventory.py +16 -29
  181. sp_api/asyncio/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders.py +120 -192
  182. sp_api/asyncio/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders_2021_12_28.py +116 -0
  183. sp_api/asyncio/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders_v1.py +115 -0
  184. sp_api/asyncio/api/vendor_direct_fulfillment_payments/vendor_direct_fulfillment_payments.py +15 -225
  185. sp_api/asyncio/api/vendor_direct_fulfillment_sandbox_test_data/__init__.py +0 -0
  186. sp_api/asyncio/api/vendor_direct_fulfillment_sandbox_test_data/vendor_direct_fulfillment_sandbox_test_data.py +92 -0
  187. sp_api/asyncio/api/vendor_direct_fulfillment_sandbox_test_data/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.py +51 -0
  188. sp_api/asyncio/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping.py +120 -623
  189. sp_api/asyncio/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping_2021_12_28.py +392 -0
  190. sp_api/asyncio/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping_v1.py +321 -0
  191. sp_api/asyncio/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions.py +112 -29
  192. sp_api/asyncio/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions_2021_12_28.py +49 -0
  193. sp_api/asyncio/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions_v1.py +48 -0
  194. sp_api/asyncio/api/vendor_invoices/vendor_invoices.py +16 -265
  195. sp_api/asyncio/api/vendor_orders/vendor_orders.py +84 -132
  196. sp_api/asyncio/api/vendor_shipments/vendor_shipments.py +150 -69
  197. sp_api/asyncio/api/vendor_transaction_status/vendor_transaction_status.py +17 -12
  198. sp_api/asyncio/base/client.py +2 -2
  199. sp_api/asyncio/util/load_date_bound.py +1 -1
  200. sp_api/base/__init__.py +10 -0
  201. sp_api/base/_core.py +2 -2
  202. sp_api/base/client.py +3 -3
  203. sp_api/base/helpers.py +12 -1
  204. sp_api/base/marketplaces.py +6 -3
  205. sp_api/util/__init__.py +2 -0
  206. sp_api/util/load_date_bound.py +1 -1
  207. sp_api/util/versioned_client.py +45 -0
  208. python_amazon_sp_api-2.0.15.dist-info/RECORD +0 -255
  209. sp_api/asyncio/api/models/__init__.py +0 -4
  210. sp_api/asyncio/api/overrides/__init__.py +0 -1
  211. {python_amazon_sp_api-2.0.15.data → python_amazon_sp_api-2.1.3.data}/scripts/make_endpoint +0 -0
  212. {python_amazon_sp_api-2.0.15.dist-info → python_amazon_sp_api-2.1.3.dist-info}/WHEEL +0 -0
  213. {python_amazon_sp_api-2.0.15.dist-info → python_amazon_sp_api-2.1.3.dist-info}/licenses/LICENSE +0 -0
  214. {python_amazon_sp_api-2.0.15.dist-info → python_amazon_sp_api-2.1.3.dist-info}/top_level.txt +0 -0
@@ -16,26 +16,30 @@ class AplusContent(AsyncBaseClient):
16
16
  async def search_content_documents(self, **kwargs) -> ApiResponse:
17
17
  """
18
18
  search_content_documents(self, **kwargs) -> ApiResponse
19
-
20
- Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents.
21
-
22
- **Usage Plans:**
23
-
24
-
19
+
20
+ Returns a list of all A+ Content documents, including metadata, that are assigned to a selling partner. To get the actual contents of the A+ Content documents, call the `getContentDocument` operation.
21
+
22
+ **Usage Plan:**
23
+
25
24
  ====================================== ==============
26
25
  Rate (requests per second) Burst
27
26
  ====================================== ==============
28
27
  10 10
29
28
  ====================================== ==============
30
-
31
- The 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.
32
-
29
+
30
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
31
+
32
+ Examples:
33
+ literal blocks::
34
+
35
+ await AplusContent().search_content_documents()
36
+
33
37
  Args:
34
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
35
- key pageToken:string | A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations.
36
-
38
+ key marketplaceId: object | required The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
39
+ key pageToken: object | A token that you use to fetch a specific page when there are multiple pages of results.
40
+
37
41
  Returns:
38
- ApiResponse:
42
+ ApiResponse
39
43
  """
40
44
 
41
45
  return await self._request(kwargs.pop("path"), params=kwargs)
@@ -44,27 +48,30 @@ class AplusContent(AsyncBaseClient):
44
48
  async def create_content_document(self, **kwargs) -> ApiResponse:
45
49
  """
46
50
  create_content_document(self, **kwargs) -> ApiResponse
47
-
51
+
48
52
  Creates a new A+ Content document.
49
-
50
- **Usage Plans:**
51
-
52
-
53
+
54
+ **Usage Plan:**
55
+
53
56
  ====================================== ==============
54
57
  Rate (requests per second) Burst
55
58
  ====================================== ==============
56
- 10 10
59
+ 10 10
57
60
  ====================================== ==============
58
-
59
- The 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.
60
-
61
+
62
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
63
+
64
+ Examples:
65
+ literal blocks::
66
+
67
+ await AplusContent().create_content_document()
68
+
61
69
  Args:
62
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
63
- postContentDocumentRequest: | * REQUIRED {'properties': {'contentDocument': {'$ref': '#/definitions/ContentDocument'}}, 'required': ['contentDocument'], 'type': 'object'}
64
-
65
-
70
+ key marketplaceId: object | required The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
71
+ postContentDocumentRequest: PostContentDocumentRequest | required The content document request details.
72
+
66
73
  Returns:
67
- ApiResponse:
74
+ ApiResponse
68
75
  """
69
76
 
70
77
  return await self._request(
@@ -78,28 +85,31 @@ class AplusContent(AsyncBaseClient):
78
85
  async def get_content_document(self, contentReferenceKey, **kwargs) -> ApiResponse:
79
86
  """
80
87
  get_content_document(self, contentReferenceKey, **kwargs) -> ApiResponse
81
-
88
+
82
89
  Returns an A+ Content document, if available.
83
-
84
- **Usage Plans:**
85
-
86
-
90
+
91
+ **Usage Plan:**
92
+
87
93
  ====================================== ==============
88
94
  Rate (requests per second) Burst
89
95
  ====================================== ==============
90
96
  10 10
91
97
  ====================================== ==============
92
-
93
- The 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.
94
-
98
+
99
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
100
+
101
+ Examples:
102
+ literal blocks::
103
+
104
+ await AplusContent().get_content_document("value")
105
+
95
106
  Args:
96
- contentReferenceKey:string | * REQUIRED The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
97
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
98
- key includedDataSet:array | * REQUIRED The set of A+ Content data types to include in the response.
99
-
100
-
107
+ contentReferenceKey: object | required The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
108
+ key marketplaceId: object | required The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
109
+ key includedDataSet: object | required The set of A+ Content data types to include in the response.
110
+
101
111
  Returns:
102
- ApiResponse:
112
+ ApiResponse
103
113
  """
104
114
 
105
115
  return await self._request(
@@ -110,25 +120,31 @@ class AplusContent(AsyncBaseClient):
110
120
  async def update_content_document(self, contentReferenceKey, **kwargs) -> ApiResponse:
111
121
  """
112
122
  update_content_document(self, contentReferenceKey, **kwargs) -> ApiResponse
113
-
123
+
114
124
  Updates an existing A+ Content document.
115
-
116
-
125
+
126
+ **Usage Plan:**
127
+
117
128
  ====================================== ==============
118
129
  Rate (requests per second) Burst
119
130
  ====================================== ==============
120
131
  10 10
121
132
  ====================================== ==============
122
-
123
- The 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.
124
-
133
+
134
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
135
+
136
+ Examples:
137
+ literal blocks::
138
+
139
+ await AplusContent().update_content_document("value")
140
+
125
141
  Args:
126
- contentReferenceKey:string | * REQUIRED The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
127
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
128
- postContentDocumentRequest: | * REQUIRED {'properties': {'contentDocument': {'$ref': '#/definitions/ContentDocument'}}, 'required': ['contentDocument'], 'type': 'object'}
129
-
142
+ contentReferenceKey: object | required The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
143
+ key marketplaceId: object | required The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
144
+ postContentDocumentRequest: PostContentDocumentRequest | required The content document request details.
145
+
130
146
  Returns:
131
- ApiResponse:
147
+ ApiResponse
132
148
  """
133
149
 
134
150
  return await self._request(
@@ -144,27 +160,33 @@ class AplusContent(AsyncBaseClient):
144
160
  ) -> ApiResponse:
145
161
  """
146
162
  list_content_document_asin_relations(self, contentReferenceKey, **kwargs) -> ApiResponse
147
-
148
- Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document.
149
-
150
-
163
+
164
+ Returns a list of ASINs that are related to the specified A+ Content document, if available. If you don't include the `asinSet` parameter, this operation returns all ASINs related to the content document.
165
+
166
+ **Usage Plan:**
167
+
151
168
  ====================================== ==============
152
169
  Rate (requests per second) Burst
153
170
  ====================================== ==============
154
171
  10 10
155
172
  ====================================== ==============
156
-
157
- The 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.
158
-
173
+
174
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
175
+
176
+ Examples:
177
+ literal blocks::
178
+
179
+ await AplusContent().list_content_document_asin_relations("value")
180
+
159
181
  Args:
160
- contentReferenceKey:string | * REQUIRED The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
161
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
162
- key includedDataSet:array | The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata.
163
- key asinSet:array | The set of ASINs.
164
- key pageToken:string | A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations.
165
-
182
+ contentReferenceKey: object | required The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.
183
+ key marketplaceId: object | required The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
184
+ key includedDataSet: object | The set of A+ Content data types to include in the response. If you don't include this parameter, the operation returns the related ASINs without metadata.
185
+ key asinSet: object | The set of ASINs.
186
+ key pageToken: object | A token that you use to fetch a specific page when there are multiple pages of results.
187
+
166
188
  Returns:
167
- ApiResponse:
189
+ ApiResponse
168
190
  """
169
191
 
170
192
  return await self._request(
@@ -177,25 +199,31 @@ class AplusContent(AsyncBaseClient):
177
199
  ) -> ApiResponse:
178
200
  """
179
201
  post_content_document_asin_relations(self, contentReferenceKey, **kwargs) -> ApiResponse
180
-
181
- Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN.
182
-
183
-
202
+
203
+ Replaces all ASINs related to the specified A+ Content document, if available. This operation can add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN will suspend the content document from that ASIN.
204
+
205
+ **Usage Plan:**
206
+
184
207
  ====================================== ==============
185
208
  Rate (requests per second) Burst
186
209
  ====================================== ==============
187
210
  10 10
188
211
  ====================================== ==============
189
-
190
- The 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.
191
-
212
+
213
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
214
+
215
+ Examples:
216
+ literal blocks::
217
+
218
+ await AplusContent().post_content_document_asin_relations("value")
219
+
192
220
  Args:
193
- contentReferenceKey:string | * REQUIRED The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
194
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
195
- postContentDocumentAsinRelationsRequest: | * REQUIRED {'properties': {'asinSet': {'$ref': '#/definitions/AsinSet'}}, 'required': ['asinSet'], 'type': 'object'}
196
-
221
+ contentReferenceKey: object | required The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
222
+ key marketplaceId: object | required The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
223
+ postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest | required The request details for the content document ASIN relations.
224
+
197
225
  Returns:
198
- ApiResponse:
226
+ ApiResponse
199
227
  """
200
228
 
201
229
  return await self._request(
@@ -209,26 +237,31 @@ class AplusContent(AsyncBaseClient):
209
237
  async def validate_content_document_asin_relations(self, **kwargs) -> ApiResponse:
210
238
  """
211
239
  validate_content_document_asin_relations(self, **kwargs) -> ApiResponse
212
-
240
+
213
241
  Checks if the A+ Content document is valid for use on a set of ASINs.
214
-
215
-
242
+
243
+ **Usage Plan:**
244
+
216
245
  ====================================== ==============
217
246
  Rate (requests per second) Burst
218
247
  ====================================== ==============
219
- 10 10
248
+ 10 10
220
249
  ====================================== ==============
221
-
222
- The 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.
223
-
250
+
251
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
252
+
253
+ Examples:
254
+ literal blocks::
255
+
256
+ await AplusContent().validate_content_document_asin_relations()
257
+
224
258
  Args:
225
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
226
- key asinSet:array | The set of ASINs.
227
- postContentDocumentRequest: | * REQUIRED {'properties': {'contentDocument': {'$ref': '#/definitions/ContentDocument'}}, 'required': ['contentDocument'], 'type': 'object'}
228
-
229
-
259
+ key marketplaceId: object | required The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
260
+ key asinSet: object | The set of ASINs.
261
+ postContentDocumentRequest: PostContentDocumentRequest | required The content document request details.
262
+
230
263
  Returns:
231
- ApiResponse:
264
+ ApiResponse
232
265
  """
233
266
 
234
267
  return await self._request(
@@ -242,25 +275,31 @@ class AplusContent(AsyncBaseClient):
242
275
  async def search_content_publish_records(self, **kwargs) -> ApiResponse:
243
276
  """
244
277
  search_content_publish_records(self, **kwargs) -> ApiResponse
245
-
278
+
246
279
  Searches for A+ Content publishing records, if available.
247
-
248
-
280
+
281
+ **Usage Plan:**
282
+
249
283
  ====================================== ==============
250
284
  Rate (requests per second) Burst
251
285
  ====================================== ==============
252
286
  10 10
253
287
  ====================================== ==============
254
-
255
- The 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.
256
-
288
+
289
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
290
+
291
+ Examples:
292
+ literal blocks::
293
+
294
+ await AplusContent().search_content_publish_records()
295
+
257
296
  Args:
258
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
259
- key asin:string | * REQUIRED The Amazon Standard Identification Number (ASIN).
260
- key pageToken:string | A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include pageToken as the only parameter. Specifying pageToken with any other parameter will cause the request to fail. When no nextPageToken value is returned there are no more pages to return. A pageToken value is not usable across different operations.
261
-
297
+ key marketplaceId: object | required The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
298
+ key asin: object | required The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
299
+ key pageToken: object | A token that you use to fetch a specific page when there are multiple pages of results.
300
+
262
301
  Returns:
263
- ApiResponse:
302
+ ApiResponse
264
303
  """
265
304
 
266
305
  return await self._request(kwargs.pop("path"), params=kwargs)
@@ -273,24 +312,30 @@ class AplusContent(AsyncBaseClient):
273
312
  ) -> ApiResponse:
274
313
  """
275
314
  post_content_document_approval_submission(self, contentReferenceKey, **kwargs) -> ApiResponse
276
-
315
+
277
316
  Submits an A+ Content document for review, approval, and publishing.
278
-
279
-
317
+
318
+ **Usage Plan:**
319
+
280
320
  ====================================== ==============
281
321
  Rate (requests per second) Burst
282
322
  ====================================== ==============
283
- 10 10
323
+ 10 10
284
324
  ====================================== ==============
285
-
286
- The 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.
287
-
325
+
326
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
327
+
328
+ Examples:
329
+ literal blocks::
330
+
331
+ await AplusContent().post_content_document_approval_submission("value")
332
+
288
333
  Args:
289
- contentReferenceKey:string | * REQUIRED The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
290
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
291
-
334
+ contentReferenceKey: object | required The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
335
+ key marketplaceId: object | required The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
336
+
292
337
  Returns:
293
- ApiResponse:
338
+ ApiResponse
294
339
  """
295
340
 
296
341
  return await self._request(
@@ -305,24 +350,30 @@ class AplusContent(AsyncBaseClient):
305
350
  ) -> ApiResponse:
306
351
  """
307
352
  post_content_document_suspend_submission(self, contentReferenceKey, **kwargs) -> ApiResponse
308
-
309
- Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations.
310
-
311
-
353
+
354
+ Submits a request to suspend visible A+ Content. This doesn't delete the content document or the ASIN relations.
355
+
356
+ **Usage Plan:**
357
+
312
358
  ====================================== ==============
313
359
  Rate (requests per second) Burst
314
360
  ====================================== ==============
315
- 10 10
361
+ 10 10
316
362
  ====================================== ==============
317
-
318
- The 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.
319
-
363
+
364
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
365
+
366
+ Examples:
367
+ literal blocks::
368
+
369
+ await AplusContent().post_content_document_suspend_submission("value")
370
+
320
371
  Args:
321
- contentReferenceKey:string | * REQUIRED The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier.
322
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
323
-
372
+ contentReferenceKey: object | required The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
373
+ key marketplaceId: object | required The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
374
+
324
375
  Returns:
325
- ApiResponse:
376
+ ApiResponse
326
377
  """
327
378
 
328
379
  return await self._request(
@@ -17,30 +17,29 @@ class ApplicationIntegrations(AsyncBaseClient):
17
17
  async def create_notification(self, **kwargs) -> ApiResponse:
18
18
  """
19
19
  create_notification(self, **kwargs) -> ApiResponse
20
-
20
+
21
21
  Create a notification for sellers in Seller Central.
22
-
22
+
23
23
  **Usage Plan:**
24
-
25
- | Rate (requests per second) | Burst |
26
- | ---- | ---- |
27
- | 1 | 5 |
28
-
29
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
30
-
24
+
25
+ ====================================== ==============
26
+ Rate (requests per second) Burst
27
+ ====================================== ==============
28
+ 1 5
29
+ ====================================== ==============
30
+
31
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
32
+
33
+ Examples:
34
+ literal blocks::
35
+
36
+ await ApplicationIntegrations().create_notification()
37
+
31
38
  Args:
39
+ body: CreateNotificationRequest | required The request body for the `createNotification` operation.
32
40
 
33
- body: | * REQUIRED {'description': 'The request for the `createNotification` operation.',
34
- 'example': {'marketplaceId': 'ATVPDKIKX0DER', 'notificationParameters': {'priceValue': '200'}, 'templateId': 'PRICE_CHANGE'},
35
- 'properties': {'marketplaceId': {'description': 'An encrypted marketplace identifier for the posted notification.', 'type': 'string'},
36
- 'notificationParameters': {'$ref': '#/definitions/NotificationParameters', 'description': 'The parameters specified in the template you used to onboard your application.'},
37
- 'templateId': {'description': 'The unique identifier of the notification template you used to onboard your application.', 'type': 'string'}},
38
- 'required': ['templateId', 'notificationParameters'],
39
- 'type': 'object'}
40
-
41
-
42
41
  Returns:
43
- ApiResponse:
42
+ ApiResponse
44
43
  """
45
44
 
46
45
  return await self._request(kwargs.pop('path'), data=kwargs)
@@ -50,33 +49,29 @@ class ApplicationIntegrations(AsyncBaseClient):
50
49
  async def delete_notifications(self, **kwargs) -> ApiResponse:
51
50
  """
52
51
  delete_notifications(self, **kwargs) -> ApiResponse
53
-
52
+
54
53
  Remove your application's notifications from the Appstore notifications dashboard.
55
-
54
+
56
55
  **Usage Plan:**
57
-
58
- | Rate (requests per second) | Burst |
59
- | ---- | ---- |
60
- | 1 | 5 |
61
-
62
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
63
-
64
- Args:
65
-
66
- body: | * REQUIRED {'description': 'The request for the `deleteNotifications` operation.',
67
- 'example': {'deletionReason': 'INCORRECT_CONTENT', 'templateId': 'PRICE_CHANGE'},
68
- 'properties': {'deletionReason': {'description': 'The unique identifier that maps each notification status to a reason code.',
69
- 'enum': ['INCORRECT_CONTENT', 'INCORRECT_RECIPIENT'],
70
- 'type': 'string',
71
- 'x-docgen-enum-table-extension': [{'description': "The notification's content is recognized to be incorrect.", 'value': 'INCORRECT_CONTENT'},
72
- {'description': 'The notification was sent to incorrect seller.', 'value': 'INCORRECT_RECIPIENT'}]},
73
- 'templateId': {'description': 'The unique identifier of the notification template you used to onboard your application.', 'type': 'string'}},
74
- 'required': ['templateId', 'deletionReason'],
75
- 'type': 'object'}
76
-
77
-
56
+
57
+ ====================================== ==============
58
+ Rate (requests per second) Burst
59
+ ====================================== ==============
60
+ 1 5
61
+ ====================================== ==============
62
+
63
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
64
+
65
+ Examples:
66
+ literal blocks::
67
+
68
+ await ApplicationIntegrations().delete_notifications()
69
+
70
+ Args:
71
+ body: DeleteNotificationsRequest | required The request body for the `deleteNotifications` operation.
72
+
78
73
  Returns:
79
- ApiResponse:
74
+ ApiResponse
80
75
  """
81
76
 
82
77
  return await self._request(kwargs.pop('path'), data=kwargs)
@@ -86,34 +81,30 @@ class ApplicationIntegrations(AsyncBaseClient):
86
81
  async def record_action_feedback(self, notificationId, **kwargs) -> ApiResponse:
87
82
  """
88
83
  record_action_feedback(self, notificationId, **kwargs) -> ApiResponse
89
-
84
+
90
85
  Records the seller's response to a notification.
91
-
86
+
92
87
  **Usage Plan:**
93
-
94
- | Rate (requests per second) | Burst |
95
- | ---- | ---- |
96
- | 1 | 5 |
97
-
98
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [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).
99
-
100
- Args:
101
-
102
- notificationId:string | * REQUIRED A `notificationId` uniquely identifies a notification.
103
-
104
- body: | * REQUIRED {'description': 'The request for the `recordActionFeedback` operation.',
105
- 'example': {'feedbackActionCode': 'SELLER_ACTION_COMPLETED'},
106
- 'properties': {'feedbackActionCode': {'description': 'The unique identifier for each notification status.',
107
- 'enum': ['SELLER_ACTION_COMPLETED'],
108
- 'type': 'string',
109
- 'x-docgen-enum-table-extension': [{'description': 'The seller completed the action attached to the posted notification.', 'value': 'SELLER_ACTION_COMPLETED'}]}},
110
- 'required': ['feedbackActionCode'],
111
- 'type': 'object'}
112
-
113
-
88
+
89
+ ====================================== ==============
90
+ Rate (requests per second) Burst
91
+ ====================================== ==============
92
+ 1 5
93
+ ====================================== ==============
94
+
95
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
96
+
97
+ Examples:
98
+ literal blocks::
99
+
100
+ await ApplicationIntegrations().record_action_feedback("value")
101
+
102
+ Args:
103
+ notificationId: object | required A `notificationId` uniquely identifies a notification.
104
+ body: RecordActionFeedbackRequest | required The request body for the `recordActionFeedback` operation.
105
+
114
106
  Returns:
115
- ApiResponse:
107
+ ApiResponse
116
108
  """
117
109
 
118
110
  return await self._request(fill_query_params(kwargs.pop('path'), notificationId), data=kwargs)
119
-