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
@@ -14,26 +14,30 @@ class AplusContent(Client):
14
14
  def search_content_documents(self, **kwargs) -> ApiResponse:
15
15
  """
16
16
  search_content_documents(self, **kwargs) -> ApiResponse
17
-
18
- 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.
19
-
20
- **Usage Plans:**
21
-
22
-
17
+
18
+ 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.
19
+
20
+ **Usage Plan:**
21
+
23
22
  ====================================== ==============
24
23
  Rate (requests per second) Burst
25
24
  ====================================== ==============
26
25
  10 10
27
26
  ====================================== ==============
28
-
29
- 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.
30
-
27
+
28
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
29
+
30
+ Examples:
31
+ literal blocks::
32
+
33
+ AplusContent().search_content_documents()
34
+
31
35
  Args:
32
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
33
- 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.
34
-
36
+ 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).
37
+ key pageToken: object | A token that you use to fetch a specific page when there are multiple pages of results.
38
+
35
39
  Returns:
36
- ApiResponse:
40
+ ApiResponse
37
41
  """
38
42
 
39
43
  return self._request(kwargs.pop("path"), params=kwargs)
@@ -42,27 +46,30 @@ class AplusContent(Client):
42
46
  def create_content_document(self, **kwargs) -> ApiResponse:
43
47
  """
44
48
  create_content_document(self, **kwargs) -> ApiResponse
45
-
49
+
46
50
  Creates a new A+ Content document.
47
-
48
- **Usage Plans:**
49
-
50
-
51
+
52
+ **Usage Plan:**
53
+
51
54
  ====================================== ==============
52
55
  Rate (requests per second) Burst
53
56
  ====================================== ==============
54
- 10 10
57
+ 10 10
55
58
  ====================================== ==============
56
-
57
- 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.
58
-
59
+
60
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
61
+
62
+ Examples:
63
+ literal blocks::
64
+
65
+ AplusContent().create_content_document()
66
+
59
67
  Args:
60
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
61
- postContentDocumentRequest: | * REQUIRED {'properties': {'contentDocument': {'$ref': '#/definitions/ContentDocument'}}, 'required': ['contentDocument'], 'type': 'object'}
62
-
63
-
68
+ 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).
69
+ postContentDocumentRequest: PostContentDocumentRequest | required The content document request details.
70
+
64
71
  Returns:
65
- ApiResponse:
72
+ ApiResponse
66
73
  """
67
74
 
68
75
  return self._request(
@@ -76,28 +83,31 @@ class AplusContent(Client):
76
83
  def get_content_document(self, contentReferenceKey, **kwargs) -> ApiResponse:
77
84
  """
78
85
  get_content_document(self, contentReferenceKey, **kwargs) -> ApiResponse
79
-
86
+
80
87
  Returns an A+ Content document, if available.
81
-
82
- **Usage Plans:**
83
-
84
-
88
+
89
+ **Usage Plan:**
90
+
85
91
  ====================================== ==============
86
92
  Rate (requests per second) Burst
87
93
  ====================================== ==============
88
94
  10 10
89
95
  ====================================== ==============
90
-
91
- 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.
92
-
96
+
97
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
98
+
99
+ Examples:
100
+ literal blocks::
101
+
102
+ AplusContent().get_content_document("value")
103
+
93
104
  Args:
94
- 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.
95
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
96
- key includedDataSet:array | * REQUIRED The set of A+ Content data types to include in the response.
97
-
98
-
105
+ 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.
106
+ 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).
107
+ key includedDataSet: object | required The set of A+ Content data types to include in the response.
108
+
99
109
  Returns:
100
- ApiResponse:
110
+ ApiResponse
101
111
  """
102
112
 
103
113
  return self._request(
@@ -108,25 +118,31 @@ class AplusContent(Client):
108
118
  def update_content_document(self, contentReferenceKey, **kwargs) -> ApiResponse:
109
119
  """
110
120
  update_content_document(self, contentReferenceKey, **kwargs) -> ApiResponse
111
-
121
+
112
122
  Updates an existing A+ Content document.
113
-
114
-
123
+
124
+ **Usage Plan:**
125
+
115
126
  ====================================== ==============
116
127
  Rate (requests per second) Burst
117
128
  ====================================== ==============
118
129
  10 10
119
130
  ====================================== ==============
120
-
121
- 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.
122
-
131
+
132
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
133
+
134
+ Examples:
135
+ literal blocks::
136
+
137
+ AplusContent().update_content_document("value")
138
+
123
139
  Args:
124
- 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.
125
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
126
- postContentDocumentRequest: | * REQUIRED {'properties': {'contentDocument': {'$ref': '#/definitions/ContentDocument'}}, 'required': ['contentDocument'], 'type': 'object'}
127
-
140
+ 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.
141
+ 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).
142
+ postContentDocumentRequest: PostContentDocumentRequest | required The content document request details.
143
+
128
144
  Returns:
129
- ApiResponse:
145
+ ApiResponse
130
146
  """
131
147
 
132
148
  return self._request(
@@ -142,27 +158,33 @@ class AplusContent(Client):
142
158
  ) -> ApiResponse:
143
159
  """
144
160
  list_content_document_asin_relations(self, contentReferenceKey, **kwargs) -> ApiResponse
145
-
146
- 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.
147
-
148
-
161
+
162
+ 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.
163
+
164
+ **Usage Plan:**
165
+
149
166
  ====================================== ==============
150
167
  Rate (requests per second) Burst
151
168
  ====================================== ==============
152
169
  10 10
153
170
  ====================================== ==============
154
-
155
- 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.
156
-
171
+
172
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
173
+
174
+ Examples:
175
+ literal blocks::
176
+
177
+ AplusContent().list_content_document_asin_relations("value")
178
+
157
179
  Args:
158
- 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.
159
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
160
- 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.
161
- key asinSet:array | The set of ASINs.
162
- 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.
163
-
180
+ 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.
181
+ 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).
182
+ 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.
183
+ key asinSet: object | The set of ASINs.
184
+ key pageToken: object | A token that you use to fetch a specific page when there are multiple pages of results.
185
+
164
186
  Returns:
165
- ApiResponse:
187
+ ApiResponse
166
188
  """
167
189
 
168
190
  return self._request(
@@ -175,25 +197,31 @@ class AplusContent(Client):
175
197
  ) -> ApiResponse:
176
198
  """
177
199
  post_content_document_asin_relations(self, contentReferenceKey, **kwargs) -> ApiResponse
178
-
179
- 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.
180
-
181
-
200
+
201
+ 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.
202
+
203
+ **Usage Plan:**
204
+
182
205
  ====================================== ==============
183
206
  Rate (requests per second) Burst
184
207
  ====================================== ==============
185
208
  10 10
186
209
  ====================================== ==============
187
-
188
- 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.
189
-
210
+
211
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
212
+
213
+ Examples:
214
+ literal blocks::
215
+
216
+ AplusContent().post_content_document_asin_relations("value")
217
+
190
218
  Args:
191
- 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.
192
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
193
- postContentDocumentAsinRelationsRequest: | * REQUIRED {'properties': {'asinSet': {'$ref': '#/definitions/AsinSet'}}, 'required': ['asinSet'], 'type': 'object'}
194
-
219
+ 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.
220
+ 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).
221
+ postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest | required The request details for the content document ASIN relations.
222
+
195
223
  Returns:
196
- ApiResponse:
224
+ ApiResponse
197
225
  """
198
226
 
199
227
  return self._request(
@@ -207,26 +235,31 @@ class AplusContent(Client):
207
235
  def validate_content_document_asin_relations(self, **kwargs) -> ApiResponse:
208
236
  """
209
237
  validate_content_document_asin_relations(self, **kwargs) -> ApiResponse
210
-
238
+
211
239
  Checks if the A+ Content document is valid for use on a set of ASINs.
212
-
213
-
240
+
241
+ **Usage Plan:**
242
+
214
243
  ====================================== ==============
215
244
  Rate (requests per second) Burst
216
245
  ====================================== ==============
217
- 10 10
246
+ 10 10
218
247
  ====================================== ==============
219
-
220
- 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.
221
-
248
+
249
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
250
+
251
+ Examples:
252
+ literal blocks::
253
+
254
+ AplusContent().validate_content_document_asin_relations()
255
+
222
256
  Args:
223
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
224
- key asinSet:array | The set of ASINs.
225
- postContentDocumentRequest: | * REQUIRED {'properties': {'contentDocument': {'$ref': '#/definitions/ContentDocument'}}, 'required': ['contentDocument'], 'type': 'object'}
226
-
227
-
257
+ 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).
258
+ key asinSet: object | The set of ASINs.
259
+ postContentDocumentRequest: PostContentDocumentRequest | required The content document request details.
260
+
228
261
  Returns:
229
- ApiResponse:
262
+ ApiResponse
230
263
  """
231
264
 
232
265
  return self._request(
@@ -240,25 +273,31 @@ class AplusContent(Client):
240
273
  def search_content_publish_records(self, **kwargs) -> ApiResponse:
241
274
  """
242
275
  search_content_publish_records(self, **kwargs) -> ApiResponse
243
-
276
+
244
277
  Searches for A+ Content publishing records, if available.
245
-
246
-
278
+
279
+ **Usage Plan:**
280
+
247
281
  ====================================== ==============
248
282
  Rate (requests per second) Burst
249
283
  ====================================== ==============
250
284
  10 10
251
285
  ====================================== ==============
252
-
253
- 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.
254
-
286
+
287
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
288
+
289
+ Examples:
290
+ literal blocks::
291
+
292
+ AplusContent().search_content_publish_records()
293
+
255
294
  Args:
256
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
257
- key asin:string | * REQUIRED The Amazon Standard Identification Number (ASIN).
258
- 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.
259
-
295
+ 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).
296
+ key asin: object | required The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
297
+ key pageToken: object | A token that you use to fetch a specific page when there are multiple pages of results.
298
+
260
299
  Returns:
261
- ApiResponse:
300
+ ApiResponse
262
301
  """
263
302
 
264
303
  return self._request(kwargs.pop("path"), params=kwargs)
@@ -271,24 +310,30 @@ class AplusContent(Client):
271
310
  ) -> ApiResponse:
272
311
  """
273
312
  post_content_document_approval_submission(self, contentReferenceKey, **kwargs) -> ApiResponse
274
-
313
+
275
314
  Submits an A+ Content document for review, approval, and publishing.
276
-
277
-
315
+
316
+ **Usage Plan:**
317
+
278
318
  ====================================== ==============
279
319
  Rate (requests per second) Burst
280
320
  ====================================== ==============
281
- 10 10
321
+ 10 10
282
322
  ====================================== ==============
283
-
284
- 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.
285
-
323
+
324
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
325
+
326
+ Examples:
327
+ literal blocks::
328
+
329
+ AplusContent().post_content_document_approval_submission("value")
330
+
286
331
  Args:
287
- 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.
288
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
289
-
332
+ 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.
333
+ 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).
334
+
290
335
  Returns:
291
- ApiResponse:
336
+ ApiResponse
292
337
  """
293
338
 
294
339
  return self._request(
@@ -303,24 +348,30 @@ class AplusContent(Client):
303
348
  ) -> ApiResponse:
304
349
  """
305
350
  post_content_document_suspend_submission(self, contentReferenceKey, **kwargs) -> ApiResponse
306
-
307
- Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations.
308
-
309
-
351
+
352
+ Submits a request to suspend visible A+ Content. This doesn't delete the content document or the ASIN relations.
353
+
354
+ **Usage Plan:**
355
+
310
356
  ====================================== ==============
311
357
  Rate (requests per second) Burst
312
358
  ====================================== ==============
313
- 10 10
359
+ 10 10
314
360
  ====================================== ==============
315
-
316
- 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.
317
-
361
+
362
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
363
+
364
+ Examples:
365
+ literal blocks::
366
+
367
+ AplusContent().post_content_document_suspend_submission("value")
368
+
318
369
  Args:
319
- 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.
320
- key marketplaceId:string | * REQUIRED The identifier for the marketplace where the A+ Content is published.
321
-
370
+ 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.
371
+ 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).
372
+
322
373
  Returns:
323
- ApiResponse:
374
+ ApiResponse
324
375
  """
325
376
 
326
377
  return self._request(
@@ -16,30 +16,29 @@ class ApplicationIntegrations(Client):
16
16
  def create_notification(self, **kwargs) -> ApiResponse:
17
17
  """
18
18
  create_notification(self, **kwargs) -> ApiResponse
19
-
19
+
20
20
  Create a notification for sellers in Seller Central.
21
-
21
+
22
22
  **Usage Plan:**
23
-
24
- | Rate (requests per second) | Burst |
25
- | ---- | ---- |
26
- | 1 | 5 |
27
-
28
- 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).
29
-
23
+
24
+ ====================================== ==============
25
+ Rate (requests per second) Burst
26
+ ====================================== ==============
27
+ 1 5
28
+ ====================================== ==============
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
+ ApplicationIntegrations().create_notification()
36
+
30
37
  Args:
38
+ body: CreateNotificationRequest | required The request body for the `createNotification` operation.
31
39
 
32
- body: | * REQUIRED {'description': 'The request for the `createNotification` operation.',
33
- 'example': {'marketplaceId': 'ATVPDKIKX0DER', 'notificationParameters': {'priceValue': '200'}, 'templateId': 'PRICE_CHANGE'},
34
- 'properties': {'marketplaceId': {'description': 'An encrypted marketplace identifier for the posted notification.', 'type': 'string'},
35
- 'notificationParameters': {'$ref': '#/definitions/NotificationParameters', 'description': 'The parameters specified in the template you used to onboard your application.'},
36
- 'templateId': {'description': 'The unique identifier of the notification template you used to onboard your application.', 'type': 'string'}},
37
- 'required': ['templateId', 'notificationParameters'],
38
- 'type': 'object'}
39
-
40
-
41
40
  Returns:
42
- ApiResponse:
41
+ ApiResponse
43
42
  """
44
43
 
45
44
  return self._request(kwargs.pop('path'), data=kwargs)
@@ -49,33 +48,29 @@ class ApplicationIntegrations(Client):
49
48
  def delete_notifications(self, **kwargs) -> ApiResponse:
50
49
  """
51
50
  delete_notifications(self, **kwargs) -> ApiResponse
52
-
51
+
53
52
  Remove your application's notifications from the Appstore notifications dashboard.
54
-
53
+
55
54
  **Usage Plan:**
56
-
57
- | Rate (requests per second) | Burst |
58
- | ---- | ---- |
59
- | 1 | 5 |
60
-
61
- 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).
62
-
63
- Args:
64
-
65
- body: | * REQUIRED {'description': 'The request for the `deleteNotifications` operation.',
66
- 'example': {'deletionReason': 'INCORRECT_CONTENT', 'templateId': 'PRICE_CHANGE'},
67
- 'properties': {'deletionReason': {'description': 'The unique identifier that maps each notification status to a reason code.',
68
- 'enum': ['INCORRECT_CONTENT', 'INCORRECT_RECIPIENT'],
69
- 'type': 'string',
70
- 'x-docgen-enum-table-extension': [{'description': "The notification's content is recognized to be incorrect.", 'value': 'INCORRECT_CONTENT'},
71
- {'description': 'The notification was sent to incorrect seller.', 'value': 'INCORRECT_RECIPIENT'}]},
72
- 'templateId': {'description': 'The unique identifier of the notification template you used to onboard your application.', 'type': 'string'}},
73
- 'required': ['templateId', 'deletionReason'],
74
- 'type': 'object'}
75
-
76
-
55
+
56
+ ====================================== ==============
57
+ Rate (requests per second) Burst
58
+ ====================================== ==============
59
+ 1 5
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
+ ApplicationIntegrations().delete_notifications()
68
+
69
+ Args:
70
+ body: DeleteNotificationsRequest | required The request body for the `deleteNotifications` operation.
71
+
77
72
  Returns:
78
- ApiResponse:
73
+ ApiResponse
79
74
  """
80
75
 
81
76
  return self._request(kwargs.pop('path'), data=kwargs)
@@ -85,34 +80,30 @@ class ApplicationIntegrations(Client):
85
80
  def record_action_feedback(self, notificationId, **kwargs) -> ApiResponse:
86
81
  """
87
82
  record_action_feedback(self, notificationId, **kwargs) -> ApiResponse
88
-
83
+
89
84
  Records the seller's response to a notification.
90
-
85
+
91
86
  **Usage Plan:**
92
-
93
- | Rate (requests per second) | Burst |
94
- | ---- | ---- |
95
- | 1 | 5 |
96
-
97
- 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).
98
-
99
- Args:
100
-
101
- notificationId:string | * REQUIRED A `notificationId` uniquely identifies a notification.
102
-
103
- body: | * REQUIRED {'description': 'The request for the `recordActionFeedback` operation.',
104
- 'example': {'feedbackActionCode': 'SELLER_ACTION_COMPLETED'},
105
- 'properties': {'feedbackActionCode': {'description': 'The unique identifier for each notification status.',
106
- 'enum': ['SELLER_ACTION_COMPLETED'],
107
- 'type': 'string',
108
- 'x-docgen-enum-table-extension': [{'description': 'The seller completed the action attached to the posted notification.', 'value': 'SELLER_ACTION_COMPLETED'}]}},
109
- 'required': ['feedbackActionCode'],
110
- 'type': 'object'}
111
-
112
-
87
+
88
+ ====================================== ==============
89
+ Rate (requests per second) Burst
90
+ ====================================== ==============
91
+ 1 5
92
+ ====================================== ==============
93
+
94
+ For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
95
+
96
+ Examples:
97
+ literal blocks::
98
+
99
+ ApplicationIntegrations().record_action_feedback("value")
100
+
101
+ Args:
102
+ notificationId: object | required A `notificationId` uniquely identifies a notification.
103
+ body: RecordActionFeedbackRequest | required The request body for the `recordActionFeedback` operation.
104
+
113
105
  Returns:
114
- ApiResponse:
106
+ ApiResponse
115
107
  """
116
108
 
117
109
  return self._request(fill_query_params(kwargs.pop('path'), notificationId), data=kwargs)
118
-