python-amazon-sp-api 1.7.5__py3-none-any.whl → 2.0.10__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-1.7.5.data → python_amazon_sp_api-2.0.10.data}/scripts/make_endpoint +2 -2
  2. {python_amazon_sp_api-1.7.5.dist-info → python_amazon_sp_api-2.0.10.dist-info}/METADATA +58 -8
  3. python_amazon_sp_api-2.0.10.dist-info/RECORD +253 -0
  4. {python_amazon_sp_api-1.7.5.dist-info → python_amazon_sp_api-2.0.10.dist-info}/WHEEL +1 -1
  5. {python_amazon_sp_api-1.7.5.dist-info → python_amazon_sp_api-2.0.10.dist-info}/top_level.txt +0 -1
  6. sp_api/__version__.py +1 -1
  7. sp_api/api/__init__.py +48 -41
  8. sp_api/api/amazon_warehousing_and_distribu/amazon_warehousing_and_distribu.py +82 -76
  9. sp_api/api/aplus_content/aplus_content.py +76 -45
  10. sp_api/api/application_integrations/application_integrations.py +118 -0
  11. sp_api/api/application_management/application_management.py +6 -7
  12. sp_api/api/authorization/authorization.py +5 -5
  13. sp_api/api/catalog/catalog.py +9 -10
  14. sp_api/api/catalog_items/catalog_items.py +10 -13
  15. sp_api/api/customer_feedback/customer_feedback.py +110 -0
  16. sp_api/api/data_kiosk/data_kiosk.py +59 -39
  17. sp_api/api/easy_ship/easy_ship.py +190 -0
  18. sp_api/api/external_fulfillment/external_fulfillment.py +706 -0
  19. sp_api/api/fba_inbound_eligibility/fba_inbound_eligibility.py +23 -13
  20. sp_api/api/fba_small_and_light/fba_small_and_light.py +46 -20
  21. sp_api/api/feeds/feeds.py +60 -39
  22. sp_api/api/finances/finances.py +40 -9
  23. sp_api/api/fulfillment_inbound/fulfillment_inbound.py +844 -619
  24. sp_api/api/fulfillment_outbound/fulfillment_outbound.py +63 -57
  25. sp_api/api/inventories/inventories.py +13 -11
  26. sp_api/api/listings_items/listings_items.py +38 -25
  27. sp_api/api/listings_restrictions/listings_restrictions.py +6 -7
  28. sp_api/api/merchant_fulfillment/merchant_fulfillment.py +49 -36
  29. sp_api/api/messaging/messaging.py +129 -25
  30. sp_api/api/notifications/notifications.py +85 -45
  31. sp_api/api/orders/orders.py +123 -38
  32. sp_api/api/orders/orders_2026_01_01.py +54 -0
  33. sp_api/api/product_fees/product_fees.py +75 -67
  34. sp_api/api/product_type_definitions/product_type_definitions.py +9 -10
  35. sp_api/api/products/products.py +177 -53
  36. sp_api/api/products/products_definitions.py +11 -82
  37. sp_api/api/replenishment/replenishment.py +13 -11
  38. sp_api/api/reports/reports.py +113 -95
  39. sp_api/api/sales/sales.py +23 -13
  40. sp_api/api/sellers/sellers.py +3 -3
  41. sp_api/api/services/services.py +41 -30
  42. sp_api/api/shipping/shipping.py +39 -37
  43. sp_api/api/shipping/shippingV2.py +46 -30
  44. sp_api/api/solicitations/solicitations.py +20 -11
  45. sp_api/api/supply_sources/supply_sources.py +45 -37
  46. sp_api/api/tokens/tokens.py +4 -6
  47. sp_api/api/upload/upload.py +10 -8
  48. sp_api/api/vendor_direct_fulfillment_inventory/vendor_direct_fulfillment_inventory.py +10 -6
  49. sp_api/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders.py +12 -14
  50. sp_api/api/vendor_direct_fulfillment_payments/vendor_direct_fulfillment_payments.py +4 -6
  51. sp_api/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping.py +42 -37
  52. sp_api/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions.py +8 -6
  53. sp_api/api/vendor_invoices/vendor_invoices.py +6 -4
  54. sp_api/api/vendor_orders/vendor_orders.py +16 -19
  55. sp_api/api/vendor_shipments/vendor_shipments.py +91 -262
  56. sp_api/api/vendor_transaction_status/vendor_transaction_status.py +6 -6
  57. sp_api/asyncio/api/__init__.py +167 -0
  58. sp_api/asyncio/api/amazon_warehousing_and_distribu/__init__.py +9 -0
  59. sp_api/asyncio/api/amazon_warehousing_and_distribu/amazon_warehousing_and_distribu.py +130 -0
  60. sp_api/asyncio/api/aplus_content/__init__.py +5 -0
  61. sp_api/asyncio/api/aplus_content/aplus_content.py +330 -0
  62. sp_api/asyncio/api/application_integrations/__init__.py +5 -0
  63. sp_api/asyncio/api/application_integrations/application_integrations.py +119 -0
  64. sp_api/asyncio/api/application_management/__init__.py +5 -0
  65. sp_api/asyncio/api/application_management/application_management.py +36 -0
  66. sp_api/asyncio/api/authorization/__init__.py +5 -0
  67. sp_api/asyncio/api/authorization/authorization.py +54 -0
  68. sp_api/asyncio/api/catalog/__init__.py +5 -0
  69. sp_api/asyncio/api/catalog/catalog.py +111 -0
  70. sp_api/asyncio/api/catalog_items/__init__.py +6 -0
  71. sp_api/asyncio/api/catalog_items/catalog_items.py +93 -0
  72. sp_api/asyncio/api/clients/__init__.py +1 -0
  73. sp_api/asyncio/api/customer_feedback/__init__.py +5 -0
  74. sp_api/asyncio/api/customer_feedback/customer_feedback.py +111 -0
  75. sp_api/asyncio/api/data_kiosk/__init__.py +5 -0
  76. sp_api/asyncio/api/data_kiosk/data_kiosk.py +236 -0
  77. sp_api/asyncio/api/easy_ship/__init__.py +5 -0
  78. sp_api/asyncio/api/easy_ship/easy_ship.py +191 -0
  79. sp_api/asyncio/api/external_fulfillment/__init__.py +5 -0
  80. sp_api/asyncio/api/external_fulfillment/external_fulfillment.py +706 -0
  81. sp_api/asyncio/api/fba_inbound_eligibility/__init__.py +5 -0
  82. sp_api/asyncio/api/fba_inbound_eligibility/fba_inbound_eligibility.py +96 -0
  83. sp_api/asyncio/api/fba_small_and_light/__init__.py +5 -0
  84. sp_api/asyncio/api/fba_small_and_light/fba_small_and_light.py +213 -0
  85. sp_api/asyncio/api/feeds/feeds.py +260 -0
  86. sp_api/asyncio/api/finances/finances.py +100 -0
  87. sp_api/asyncio/api/fulfillment_inbound/fulfillment_inbound.py +1798 -0
  88. sp_api/asyncio/api/fulfillment_outbound/fulfillment_outbound.py +736 -0
  89. sp_api/asyncio/api/inventories/inventories.py +74 -0
  90. sp_api/asyncio/api/listings_items/__init__.py +0 -0
  91. sp_api/asyncio/api/listings_items/listings_items.py +170 -0
  92. sp_api/asyncio/api/listings_restrictions/__init__.py +0 -0
  93. sp_api/asyncio/api/listings_restrictions/listings_restrictions.py +36 -0
  94. sp_api/asyncio/api/merchant_fulfillment/__init__.py +0 -0
  95. sp_api/asyncio/api/merchant_fulfillment/merchant_fulfillment.py +384 -0
  96. sp_api/asyncio/api/messaging/__init__.py +0 -0
  97. sp_api/asyncio/api/messaging/messaging.py +511 -0
  98. sp_api/asyncio/api/models/__init__.py +4 -0
  99. sp_api/asyncio/api/notifications/__init__.py +0 -0
  100. sp_api/asyncio/api/notifications/notifications.py +295 -0
  101. sp_api/asyncio/api/orders/__init__.py +0 -0
  102. sp_api/asyncio/api/orders/orders.py +412 -0
  103. sp_api/asyncio/api/orders/orders_2026_01_01.py +40 -0
  104. sp_api/asyncio/api/overrides/__init__.py +1 -0
  105. sp_api/asyncio/api/product_fees/__init__.py +0 -0
  106. sp_api/asyncio/api/product_fees/product_fees.py +194 -0
  107. sp_api/asyncio/api/product_type_definitions/__init__.py +0 -0
  108. sp_api/asyncio/api/product_type_definitions/product_type_definitions.py +75 -0
  109. sp_api/asyncio/api/products/__init__.py +0 -0
  110. sp_api/asyncio/api/products/products.py +405 -0
  111. sp_api/asyncio/api/products/products_definitions.py +11 -0
  112. sp_api/asyncio/api/replenishment/__init__.py +0 -0
  113. sp_api/asyncio/api/replenishment/replenishment.py +121 -0
  114. sp_api/asyncio/api/reports/__init__.py +0 -0
  115. sp_api/asyncio/api/reports/reports.py +439 -0
  116. sp_api/asyncio/api/sales/__init__.py +0 -0
  117. sp_api/asyncio/api/sales/sales.py +93 -0
  118. sp_api/asyncio/api/sellers/__init__.py +0 -0
  119. sp_api/asyncio/api/sellers/sellers.py +70 -0
  120. sp_api/asyncio/api/services/__init__.py +0 -0
  121. sp_api/asyncio/api/services/services.py +218 -0
  122. sp_api/asyncio/api/shipping/__init__.py +0 -0
  123. sp_api/asyncio/api/shipping/shipping.py +459 -0
  124. sp_api/asyncio/api/shipping/shippingV2.py +651 -0
  125. sp_api/asyncio/api/solicitations/__init__.py +0 -0
  126. sp_api/asyncio/api/solicitations/solicitations.py +78 -0
  127. sp_api/asyncio/api/supply_sources/__init__.py +0 -0
  128. sp_api/asyncio/api/supply_sources/supply_sources.py +138 -0
  129. sp_api/asyncio/api/tokens/__init__.py +0 -0
  130. sp_api/asyncio/api/tokens/tokens.py +65 -0
  131. sp_api/asyncio/api/upload/__init__.py +0 -0
  132. sp_api/asyncio/api/upload/upload.py +18 -0
  133. sp_api/asyncio/api/vendor_direct_fulfillment_inventory/__init__.py +0 -0
  134. sp_api/asyncio/api/vendor_direct_fulfillment_inventory/vendor_direct_fulfillment_inventory.py +64 -0
  135. sp_api/asyncio/api/vendor_direct_fulfillment_orders/__init__.py +0 -0
  136. sp_api/asyncio/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders.py +196 -0
  137. sp_api/asyncio/api/vendor_direct_fulfillment_payments/__init__.py +0 -0
  138. sp_api/asyncio/api/vendor_direct_fulfillment_payments/vendor_direct_fulfillment_payments.py +254 -0
  139. sp_api/asyncio/api/vendor_direct_fulfillment_shipping/__init__.py +0 -0
  140. sp_api/asyncio/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping.py +627 -0
  141. sp_api/asyncio/api/vendor_direct_fulfillment_transactions/__init__.py +0 -0
  142. sp_api/asyncio/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions.py +43 -0
  143. sp_api/asyncio/api/vendor_invoices/__init__.py +0 -0
  144. sp_api/asyncio/api/vendor_invoices/vendor_invoices.py +295 -0
  145. sp_api/asyncio/api/vendor_orders/__init__.py +0 -0
  146. sp_api/asyncio/api/vendor_orders/vendor_orders.py +210 -0
  147. sp_api/asyncio/api/vendor_shipments/__init__.py +0 -0
  148. sp_api/asyncio/api/vendor_shipments/vendor_shipments.py +118 -0
  149. sp_api/asyncio/api/vendor_transaction_status/__init__.py +0 -0
  150. sp_api/asyncio/api/vendor_transaction_status/vendor_transaction_status.py +41 -0
  151. sp_api/asyncio/auth/__init__.py +12 -0
  152. sp_api/asyncio/auth/access_token_client.py +145 -0
  153. sp_api/asyncio/auth/exceptions.py +5 -0
  154. sp_api/asyncio/base/__init__.py +53 -0
  155. sp_api/asyncio/base/_transport_httpx.py +50 -0
  156. sp_api/asyncio/base/base_client.py +8 -0
  157. sp_api/asyncio/base/client.py +169 -0
  158. sp_api/asyncio/util/__init__.py +29 -0
  159. sp_api/asyncio/util/key_maker.py +5 -0
  160. sp_api/asyncio/util/load_all_pages.py +55 -0
  161. sp_api/asyncio/util/load_date_bound.py +53 -0
  162. sp_api/asyncio/util/retry.py +88 -0
  163. sp_api/auth/__init__.py +3 -3
  164. sp_api/auth/_core.py +39 -0
  165. sp_api/auth/access_token_client.py +20 -31
  166. sp_api/auth/access_token_response.py +4 -4
  167. sp_api/base/ApiResponse.py +5 -4
  168. sp_api/base/__init__.py +53 -42
  169. sp_api/base/_core.py +110 -0
  170. sp_api/base/_transport_httpx.py +39 -0
  171. sp_api/base/base_client.py +4 -4
  172. sp_api/base/client.py +131 -112
  173. sp_api/base/credential_provider.py +41 -34
  174. sp_api/base/exceptions.py +14 -3
  175. sp_api/base/feedTypes.py +44 -32
  176. sp_api/base/fulfillment_channel.py +2 -2
  177. sp_api/base/helpers.py +17 -16
  178. sp_api/base/identifiersType.py +8 -8
  179. sp_api/base/included_data.py +12 -12
  180. sp_api/base/marketplaces.py +5 -1
  181. sp_api/base/notifications.py +1 -1
  182. sp_api/base/processing_status.py +5 -5
  183. sp_api/base/reportTypes.py +198 -111
  184. sp_api/base/sales_enum.py +11 -13
  185. sp_api/util/__init__.py +42 -6
  186. sp_api/util/key_maker.py +4 -2
  187. sp_api/util/load_all_pages.py +16 -5
  188. sp_api/util/load_date_bound.py +28 -13
  189. sp_api/util/params.py +57 -0
  190. sp_api/util/product_fees.py +40 -0
  191. sp_api/util/products_definitions.py +169 -0
  192. sp_api/util/report_document.py +154 -0
  193. sp_api/util/retry.py +16 -15
  194. python_amazon_sp_api-1.7.5.dist-info/RECORD +0 -144
  195. tests/api/finances/test_finances.py +0 -19
  196. tests/api/notifications/test_notifications.py +0 -26
  197. tests/api/orders/test_orders.py +0 -122
  198. tests/api/product_fees/product_fees.py +0 -49
  199. tests/api/reports/test_reports.py +0 -127
  200. tests/client/test_auth.py +0 -59
  201. tests/client/test_base.py +0 -163
  202. tests/client/test_credential_provider.py +0 -45
  203. tests/client/test_helpers.py +0 -142
  204. {python_amazon_sp_api-1.7.5.dist-info → python_amazon_sp_api-2.0.10.dist-info/licenses}/LICENSE +0 -0
  205. {tests → sp_api/api/application_integrations}/__init__.py +0 -0
  206. {tests/api → sp_api/api/customer_feedback}/__init__.py +0 -0
  207. {tests/api/finances → sp_api/api/easy_ship}/__init__.py +0 -0
  208. {tests/api/notifications → sp_api/api/external_fulfillment}/__init__.py +0 -0
  209. {tests/api/orders → sp_api/asyncio}/__init__.py +0 -0
  210. {tests/api/product_fees → sp_api/asyncio/api/feeds}/__init__.py +0 -0
  211. {tests/api/reports → sp_api/asyncio/api/finances}/__init__.py +0 -0
  212. {tests/api/sellers → sp_api/asyncio/api/fulfillment_inbound}/__init__.py +0 -0
  213. {tests/client → sp_api/asyncio/api/fulfillment_outbound}/__init__.py +0 -0
  214. /tests/api/sellers/test_sellers.py → /sp_api/asyncio/api/inventories/__init__.py +0 -0
@@ -4,6 +4,7 @@ from sp_api.base import Client, Marketplaces, ApiResponse
4
4
  from sp_api.base import sp_endpoint, fill_query_params
5
5
 
6
6
  import urllib.parse
7
+ from sp_api.util import ensure_csv
7
8
 
8
9
 
9
10
  class FulfillmentInboundVersion(str, enum.Enum):
@@ -19,12 +20,13 @@ class FulfillmentInbound(Client):
19
20
 
20
21
  The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon's fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
21
22
  """
23
+
22
24
  version: FulfillmentInboundVersion = FulfillmentInboundVersion.V_v0
23
25
 
24
26
  def __init__(self, *args, **kwargs):
25
- if 'version' in kwargs:
26
- self.version = kwargs.get('version', FulfillmentInboundVersion.V_v0)
27
- super().__init__(*args, **{**kwargs, 'version': self.version})
27
+ if "version" in kwargs:
28
+ self.version = kwargs.get("version", FulfillmentInboundVersion.V_v0)
29
+ super().__init__(*args, **{**kwargs, "version": self.version})
28
30
 
29
31
  @sp_endpoint("/fba/inbound/<version>/itemsGuidance")
30
32
  def item_guidance(self, **kwargs):
@@ -196,6 +198,39 @@ class FulfillmentInbound(Client):
196
198
  fill_query_params(kwargs.pop("path"), shipment_id), data={**data, **kwargs}
197
199
  )
198
200
 
201
+ @sp_endpoint(
202
+ "/inbound/fba/<version>/inboundPlans/{}/shipments/{}/name", method="PUT"
203
+ )
204
+ def update_shipment_name(self, inboundPlanId, shipmentId, **kwargs):
205
+ """
206
+ update_shipment_name(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
207
+
208
+ Updates the name of an existing shipment.
209
+
210
+ **Usage Plan:**
211
+
212
+ | Rate (requests per second) | Burst |
213
+ | ---- | ---- |
214
+ | 2 | 30 |
215
+
216
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
217
+
218
+ Args:
219
+
220
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
221
+
222
+ shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
223
+
224
+ body: | * REQUIRED {'name': {'description': 'A human-readable name to update the shipment name to.'}, 'type': 'string'}
225
+
226
+ Returns:
227
+ ApiResponse:
228
+ """
229
+ return self._request(
230
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
231
+ data=kwargs,
232
+ )
233
+
199
234
  @sp_endpoint("/fba/inbound/<version>/shipments/{}/preorder")
200
235
  def preorder(self, shipment_id, **kwargs):
201
236
  """
@@ -314,7 +349,9 @@ class FulfillmentInbound(Client):
314
349
  add_marketplace=False,
315
350
  )
316
351
 
317
- @sp_endpoint("/fba/inbound/<version>/shipments/{}/transport/estimate", method="POST")
352
+ @sp_endpoint(
353
+ "/fba/inbound/<version>/shipments/{}/transport/estimate", method="POST"
354
+ )
318
355
  def estimate_transport(self, shipment_id, **kwargs):
319
356
  """
320
357
  estimate_transport(self, shipment_id, **kwargs) -> ApiResponse
@@ -453,1120 +490,1308 @@ class FulfillmentInbound(Client):
453
490
  Returns:
454
491
  ApiResponse
455
492
  """
456
- if not isinstance(shipment_id_list, str):
457
- shipment_id_list = ','.join(shipment_id_list)
458
- return self.get_shipments(QueryType='SHIPMENT', ShipmentIdList=shipment_id_list, **kwargs)
493
+ shipment_id_list = ensure_csv(shipment_id_list)
494
+ return self.get_shipments(
495
+ QueryType="SHIPMENT", ShipmentIdList=shipment_id_list, **kwargs
496
+ )
459
497
 
460
498
  # 2024-03-20 API
461
- @sp_endpoint('/inbound/fba/<version>/inboundPlans', method='GET')
499
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans", method="GET")
462
500
  def list_inbound_plans(self, **kwargs) -> ApiResponse:
463
501
  """
464
- list_inbound_plans(self, **kwargs) -> ApiResponse
502
+ list_inbound_plans(self, **kwargs) -> ApiResponse
465
503
 
466
- Provides a list of inbound plans with minimal information.
504
+ Provides a list of inbound plans with minimal information.
467
505
 
468
- **Usage Plan:**
506
+ **Usage Plan:**
469
507
 
470
- | Rate (requests per second) | Burst |
471
- | ---- | ---- |
472
- | 1 | 1 |
508
+ | Rate (requests per second) | Burst |
509
+ | ---- | ---- |
510
+ | 1 | 1 |
473
511
 
474
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
512
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
475
513
 
476
- Args:
514
+ Args:
477
515
 
478
- key pageSize:integer | The number of inbound plans to return in the response matching the given query.
516
+ key pageSize:integer | The number of inbound plans to return in the response matching the given query.
479
517
 
480
- key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
518
+ key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
481
519
 
482
- key status:string | The status of an inbound plan.
520
+ key status:string | The status of an inbound plan.
483
521
 
484
- key sortBy:string | Sort by field.
522
+ key sortBy:string | Sort by field.
485
523
 
486
- key sortOrder:string | The sort order.
524
+ key sortOrder:string | The sort order.
487
525
 
488
526
 
489
- Returns:
490
- ApiResponse:
491
- """
527
+ Returns:
528
+ ApiResponse:
529
+ """
492
530
 
493
- return self._request(kwargs.pop('path'), params=kwargs)
531
+ return self._request(kwargs.pop("path"), params=kwargs)
494
532
 
495
- @sp_endpoint('/inbound/fba/<version>/inboundPlans', method='POST')
533
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans", method="POST")
496
534
  def create_inbound_plan(self, **kwargs) -> ApiResponse:
497
535
  """
498
- create_inbound_plan(self, **kwargs) -> ApiResponse
536
+ create_inbound_plan(self, **kwargs) -> ApiResponse
499
537
 
500
- Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon's fufillment network.
538
+ Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon's fufillment network.
501
539
 
502
- **Usage Plan:**
540
+ **Usage Plan:**
503
541
 
504
- | Rate (requests per second) | Burst |
505
- | ---- | ---- |
506
- | 0.05 | 1 |
542
+ | Rate (requests per second) | Burst |
543
+ | ---- | ---- |
544
+ | 0.05 | 1 |
507
545
 
508
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
546
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
509
547
 
510
- Args:
548
+ Args:
511
549
 
512
- body: | * REQUIRED {'description': 'The `createInboundPlan` request.',
513
- 'example': {'contactInformation': {'email': 'email@email.com', 'phoneNumber': '1234567890'},
514
- 'destinationMarketplaces': ['ATVPDKIKX0DER'],
515
- 'items': [{'expiration': '2024-01-01', 'labelOwner': 'AMAZON', 'manufacturingLotCode': 'manufacturingLotCode', 'msku': 'Sunglasses', 'prepOwner': 'AMAZON', 'quantity': 10}],
516
- 'name': 'My inbound plan',
517
- 'sourceAddress': {'addressLine1': '123 example street', 'addressLine2': 'Floor 19', 'city': 'Toronto', 'companyName': 'Acme', 'countryCode': 'CA', 'name': 'name', 'postalCode': 'M1M1M1', 'stateOrProvinceCode': 'ON'}},
518
- 'properties': {'contactInformation': {'$ref': '#/definitions/ContactInformation'},
519
- 'destinationMarketplaces': {'description': 'Marketplaces where the items need to be shipped to. Currently only one marketplace can be selected in this request.',
520
- 'items': {'description': 'The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.',
521
- 'maxLength': 256,
522
- 'minLength': 1,
523
- 'type': 'string'},
524
- 'maxItems': 1,
525
- 'minItems': 1,
526
- 'type': 'array'},
527
- 'items': {'description': 'Items included in this plan.', 'items': {'$ref': '#/definitions/ItemInput'}, 'maxItems': 2000, 'minItems': 1, 'type': 'array'},
528
- 'name': {'description': "Name for the Inbound Plan. If one isn't provided, a default name will be provided.", 'maxLength': 40, 'minLength': 1, 'type': 'string'},
529
- 'sourceAddress': {'$ref': '#/definitions/Address'}},
530
- 'required': ['contactInformation', 'destinationMarketplaces', 'items', 'sourceAddress'],
531
- 'type': 'object'}
550
+ body: | * REQUIRED {'description': 'The `createInboundPlan` request.',
551
+ 'example': {'contactInformation': {'email': 'email@email.com', 'phoneNumber': '1234567890'},
552
+ 'destinationMarketplaces': ['ATVPDKIKX0DER'],
553
+ 'items': [{'expiration': '2024-01-01', 'labelOwner': 'AMAZON', 'manufacturingLotCode': 'manufacturingLotCode', 'msku': 'Sunglasses', 'prepOwner': 'AMAZON', 'quantity': 10}],
554
+ 'name': 'My inbound plan',
555
+ 'sourceAddress': {'addressLine1': '123 example street', 'addressLine2': 'Floor 19', 'city': 'Toronto', 'companyName': 'Acme', 'countryCode': 'CA', 'name': 'name', 'postalCode': 'M1M1M1', 'stateOrProvinceCode': 'ON'}},
556
+ 'properties': {'contactInformation': {'$ref': '#/definitions/ContactInformation'},
557
+ 'destinationMarketplaces': {'description': 'Marketplaces where the items need to be shipped to. Currently only one marketplace can be selected in this request.',
558
+ 'items': {'description': 'The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.',
559
+ 'maxLength': 256,
560
+ 'minLength': 1,
561
+ 'type': 'string'},
562
+ 'maxItems': 1,
563
+ 'minItems': 1,
564
+ 'type': 'array'},
565
+ 'items': {'description': 'Items included in this plan.', 'items': {'$ref': '#/definitions/ItemInput'}, 'maxItems': 2000, 'minItems': 1, 'type': 'array'},
566
+ 'name': {'description': "Name for the Inbound Plan. If one isn't provided, a default name will be provided.", 'maxLength': 40, 'minLength': 1, 'type': 'string'},
567
+ 'sourceAddress': {'$ref': '#/definitions/Address'}},
568
+ 'required': ['contactInformation', 'destinationMarketplaces', 'items', 'sourceAddress'],
569
+ 'type': 'object'}
532
570
 
533
571
 
534
- Returns:
535
- ApiResponse:
572
+ Returns:
573
+ ApiResponse:
536
574
  """
537
575
 
538
- return self._request(kwargs.pop('path'), data=kwargs)
576
+ return self._request(kwargs.pop("path"), data=kwargs)
539
577
 
540
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}', method='GET')
578
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}", method="GET")
541
579
  def get_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse:
542
580
  """
543
- get_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse
581
+ get_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse
544
582
 
545
- Fetches the top level information about an inbound plan.
583
+ Fetches the top level information about an inbound plan.
546
584
 
547
- **Usage Plan:**
585
+ **Usage Plan:**
548
586
 
549
- | Rate (requests per second) | Burst |
550
- | ---- | ---- |
551
- | 1 | 1 |
587
+ | Rate (requests per second) | Burst |
588
+ | ---- | ---- |
589
+ | 1 | 1 |
552
590
 
553
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
591
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
554
592
 
555
- Args:
593
+ Args:
556
594
 
557
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
595
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
558
596
 
559
597
 
560
- Returns:
561
- ApiResponse:
598
+ Returns:
599
+ ApiResponse:
562
600
  """
563
601
 
564
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), params=kwargs)
602
+ return self._request(
603
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
604
+ )
565
605
 
566
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/boxes', method='GET')
606
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/boxes", method="GET")
567
607
  def list_inbound_plan_boxes(self, inboundPlanId, **kwargs) -> ApiResponse:
568
608
  """
569
- list_inbound_plan_boxes(self, inboundPlanId, **kwargs) -> ApiResponse
609
+ list_inbound_plan_boxes(self, inboundPlanId, **kwargs) -> ApiResponse
570
610
 
571
- Provides a paginated list of box packages in an inbound plan.
611
+ Provides a paginated list of box packages in an inbound plan.
572
612
 
573
- **Usage Plan:**
613
+ **Usage Plan:**
574
614
 
575
- | Rate (requests per second) | Burst |
576
- | ---- | ---- |
577
- | 1 | 1 |
615
+ | Rate (requests per second) | Burst |
616
+ | ---- | ---- |
617
+ | 1 | 1 |
578
618
 
579
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
619
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
580
620
 
581
- Args:
621
+ Args:
582
622
 
583
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
623
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
584
624
 
585
- key pageSize:integer | The number of boxes to return in the response matching the given query.
625
+ key pageSize:integer | The number of boxes to return in the response matching the given query.
586
626
 
587
- key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
627
+ key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
588
628
 
589
629
 
590
- Returns:
591
- ApiResponse:
630
+ Returns:
631
+ ApiResponse:
592
632
  """
593
633
 
594
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), params=kwargs)
634
+ return self._request(
635
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
636
+ )
595
637
 
596
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/cancellation', method='PUT')
638
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/cancellation", method="PUT")
597
639
  def cancel_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse:
598
640
  """
599
- cancel_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse
641
+ cancel_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse
600
642
 
601
- Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window
602
- for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments.
643
+ Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window
644
+ for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments.
603
645
 
604
- **Usage Plan:**
646
+ **Usage Plan:**
605
647
 
606
- | Rate (requests per second) | Burst |
607
- | ---- | ---- |
608
- | 0.05 | 1 |
648
+ | Rate (requests per second) | Burst |
649
+ | ---- | ---- |
650
+ | 0.05 | 1 |
609
651
 
610
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
652
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
611
653
 
612
- Args:
654
+ Args:
613
655
 
614
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
656
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
615
657
 
616
658
 
617
- Returns:
618
- ApiResponse:
659
+ Returns:
660
+ ApiResponse:
619
661
  """
620
662
 
621
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), data=kwargs)
663
+ return self._request(
664
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
665
+ )
622
666
 
623
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/items', method='GET')
667
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/items", method="GET")
624
668
  def list_inbound_plan_items(self, inboundPlanId, **kwargs) -> ApiResponse:
625
669
  """
626
- list_inbound_plan_items(self, inboundPlanId, **kwargs) -> ApiResponse
670
+ list_inbound_plan_items(self, inboundPlanId, **kwargs) -> ApiResponse
627
671
 
628
- Provides a paginated list of item packages in an inbound plan.
672
+ Provides a paginated list of item packages in an inbound plan.
629
673
 
630
- **Usage Plan:**
674
+ **Usage Plan:**
631
675
 
632
- | Rate (requests per second) | Burst |
633
- | ---- | ---- |
634
- | 1 | 1 |
676
+ | Rate (requests per second) | Burst |
677
+ | ---- | ---- |
678
+ | 1 | 1 |
635
679
 
636
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
680
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
637
681
 
638
- Args:
682
+ Args:
639
683
 
640
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
684
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
641
685
 
642
- key pageSize:integer | The number of items to return in the response matching the given query.
686
+ key pageSize:integer | The number of items to return in the response matching the given query.
643
687
 
644
- key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
688
+ key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
645
689
 
646
690
 
647
- Returns:
648
- ApiResponse:
691
+ Returns:
692
+ ApiResponse:
649
693
  """
650
694
 
651
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), params=kwargs)
695
+ return self._request(
696
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
697
+ )
652
698
 
653
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/packingInformation', method='POST')
699
+ @sp_endpoint(
700
+ "/inbound/fba/<version>/inboundPlans/{}/packingInformation", method="POST"
701
+ )
654
702
  def set_packing_information(self, inboundPlanId, **kwargs) -> ApiResponse:
655
703
  """
656
- set_packing_information(self, inboundPlanId, **kwargs) -> ApiResponse
704
+ set_packing_information(self, inboundPlanId, **kwargs) -> ApiResponse
657
705
 
658
- Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate
659
- the box level information required for planning and transportation estimates.
706
+ Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate
707
+ the box level information required for planning and transportation estimates.
660
708
 
661
- **Usage Plan:**
709
+ **Usage Plan:**
662
710
 
663
- | Rate (requests per second) | Burst |
664
- | ---- | ---- |
665
- | 0.05 | 1 |
711
+ | Rate (requests per second) | Burst |
712
+ | ---- | ---- |
713
+ | 0.05 | 1 |
666
714
 
667
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
715
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
668
716
 
669
- Args:
717
+ Args:
670
718
 
671
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
719
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
672
720
 
673
- body: | * REQUIRED {'description': '`setPackingInformation` request.',
674
- 'example': {'packageGroupings': [{'boxes': [{'boxId': 'boxId',
675
- 'contentInformationSource': 'BOX_CONTENT_PROVIDED',
676
- 'contents': [{'expiration': '2024-01-01', 'labelOwner': 'AMAZON', 'manufacturingLotCode': 'manufacturingLotCode', 'msku': 'Sunglasses', 'prepOwner': 'AMAZON', 'quantityInBox': 10}],
677
- 'dimensions': {'height': 5, 'length': 3, 'unitOfMeasurement': 'CM', 'width': 4},
678
- 'quantity': 2,
679
- 'templateName': 'templateName',
680
- 'weight': {'unit': 'KG', 'value': 5.5}}],
681
- 'packingGroupId': 'pg1234abcd-1234-abcd-5678-1234abcd5678',
682
- 'shipmentId': 'sh1234abcd-1234-abcd-5678-1234abcd5678'}]},
683
- 'properties': {'packageGroupings': {'description': 'List of packing information for the inbound plan.', 'items': {'$ref': '#/definitions/PackageGroupingInput'}, 'type': 'array'}},
684
- 'type': 'object'}
721
+ body: | * REQUIRED {'description': '`setPackingInformation` request.',
722
+ 'example': {'packageGroupings': [{'boxes': [{'boxId': 'boxId',
723
+ 'contentInformationSource': 'BOX_CONTENT_PROVIDED',
724
+ 'contents': [{'expiration': '2024-01-01', 'labelOwner': 'AMAZON', 'manufacturingLotCode': 'manufacturingLotCode', 'msku': 'Sunglasses', 'prepOwner': 'AMAZON', 'quantityInBox': 10}],
725
+ 'dimensions': {'height': 5, 'length': 3, 'unitOfMeasurement': 'CM', 'width': 4},
726
+ 'quantity': 2,
727
+ 'templateName': 'templateName',
728
+ 'weight': {'unit': 'KG', 'value': 5.5}}],
729
+ 'packingGroupId': 'pg1234abcd-1234-abcd-5678-1234abcd5678',
730
+ 'shipmentId': 'sh1234abcd-1234-abcd-5678-1234abcd5678'}]},
731
+ 'properties': {'packageGroupings': {'description': 'List of packing information for the inbound plan.', 'items': {'$ref': '#/definitions/PackageGroupingInput'}, 'type': 'array'}},
732
+ 'type': 'object'}
685
733
 
686
734
 
687
- Returns:
688
- ApiResponse:
735
+ Returns:
736
+ ApiResponse:
689
737
  """
690
738
 
691
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), data=kwargs)
739
+ return self._request(
740
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
741
+ )
692
742
 
693
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/packingOptions', method='GET')
743
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/packingOptions", method="GET")
694
744
  def list_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse:
695
745
  """
696
- list_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse
746
+ list_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse
697
747
 
698
- Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available.
748
+ Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available.
699
749
 
700
- **Usage Plan:**
750
+ **Usage Plan:**
701
751
 
702
- | Rate (requests per second) | Burst |
703
- | ---- | ---- |
704
- | 1 | 1 |
752
+ | Rate (requests per second) | Burst |
753
+ | ---- | ---- |
754
+ | 1 | 1 |
705
755
 
706
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
756
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
707
757
 
708
- Args:
758
+ Args:
709
759
 
710
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
760
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
711
761
 
712
- key pageSize:integer | The number of packing options to return in the response matching the given query.
762
+ key pageSize:integer | The number of packing options to return in the response matching the given query.
713
763
 
714
- key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
764
+ key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
715
765
 
716
766
 
717
- Returns:
718
- ApiResponse:
767
+ Returns:
768
+ ApiResponse:
719
769
  """
720
770
 
721
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), params=kwargs)
771
+ return self._request(
772
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
773
+ )
722
774
 
723
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/packingOptions', method='POST')
775
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/packingOptions", method="POST")
724
776
  def generate_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse:
725
777
  """
726
- generate_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse
778
+ generate_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse
727
779
 
728
- Generates available packing options for the inbound plan.
780
+ Generates available packing options for the inbound plan.
729
781
 
730
- **Usage Plan:**
782
+ **Usage Plan:**
731
783
 
732
- | Rate (requests per second) | Burst |
733
- | ---- | ---- |
734
- | 0.05 | 1 |
784
+ | Rate (requests per second) | Burst |
785
+ | ---- | ---- |
786
+ | 0.05 | 1 |
735
787
 
736
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
788
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
737
789
 
738
- Args:
790
+ Args:
739
791
 
740
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
792
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
741
793
 
742
794
 
743
- Returns:
744
- ApiResponse:
795
+ Returns:
796
+ ApiResponse:
745
797
  """
746
798
 
747
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), data=kwargs)
799
+ return self._request(
800
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
801
+ )
748
802
 
749
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/packingOptions/{}/confirmation', method='POST')
750
- def confirm_packing_option(self, inboundPlanId, packingOptionId, **kwargs) -> ApiResponse:
803
+ @sp_endpoint(
804
+ "/inbound/fba/<version>/inboundPlans/{}/packingOptions/{}/confirmation",
805
+ method="POST",
806
+ )
807
+ def confirm_packing_option(
808
+ self, inboundPlanId, packingOptionId, **kwargs
809
+ ) -> ApiResponse:
751
810
  """
752
- confirm_packing_option(self, inboundPlanId, **kwargs) -> ApiResponse
811
+ confirm_packing_option(self, inboundPlanId, **kwargs) -> ApiResponse
753
812
 
754
- Confirms the packing option for an inbound plan.
813
+ Confirms the packing option for an inbound plan.
755
814
 
756
- **Usage Plan:**
815
+ **Usage Plan:**
757
816
 
758
- | Rate (requests per second) | Burst |
759
- | ---- | ---- |
760
- | 0.05 | 1 |
817
+ | Rate (requests per second) | Burst |
818
+ | ---- | ---- |
819
+ | 0.05 | 1 |
761
820
 
762
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
821
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
763
822
 
764
- Args:
823
+ Args:
765
824
 
766
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
825
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
767
826
 
768
- packingOptionId:string | * REQUIRED Identifier to a packing option.
827
+ packingOptionId:string | * REQUIRED Identifier to a packing option.
769
828
 
770
829
 
771
- Returns:
772
- ApiResponse:
830
+ Returns:
831
+ ApiResponse:
773
832
  """
774
833
 
775
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId, packingOptionId), data=kwargs)
834
+ return self._request(
835
+ fill_query_params(kwargs.pop("path"), inboundPlanId, packingOptionId),
836
+ data=kwargs,
837
+ )
776
838
 
777
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/items', method='GET')
778
- def list_packing_group_items(self, inboundPlanId, **kwargs) -> ApiResponse:
839
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/packingGroups/{}/items", method="GET")
840
+ def list_packing_group_items(self, inboundPlanId, packingGroupId, **kwargs) -> ApiResponse:
779
841
  """
780
- list_packing_group_items(self, inboundPlanId, **kwargs) -> ApiResponse
842
+ list_packing_group_items(self, inboundPlanId, **kwargs) -> ApiResponse
781
843
 
782
- Retrieves a list of all items in a packing options's packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed.
844
+ Retrieves a list of all items in a packing options's packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed.
783
845
 
784
- **Usage Plan:**
846
+ **Usage Plan:**
785
847
 
786
- | Rate (requests per second) | Burst |
787
- | ---- | ---- |
788
- | 1 | 1 |
848
+ | Rate (requests per second) | Burst |
849
+ | ---- | ---- |
850
+ | 1 | 1 |
789
851
 
790
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
852
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
791
853
 
792
- Args:
793
-
794
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
854
+ Args:
795
855
 
796
- packingOptionId:string | * REQUIRED Identifier to a packing option.
856
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
797
857
 
798
- packingGroupId:string | * REQUIRED Identifier to a packing group.
858
+ packingGroupId:string | * REQUIRED Identifier to a packing group.
799
859
 
800
- key pageSize:integer | The number of packing group items to return in the response matching the given query.
860
+ key pageSize:integer | The number of packing group items to return in the response matching the given query.
801
861
 
802
- key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
862
+ key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
803
863
 
804
864
 
805
- Returns:
806
- ApiResponse:
865
+ Returns:
866
+ ApiResponse:
807
867
  """
808
868
 
809
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), params=kwargs)
869
+ return self._request(
870
+ fill_query_params(kwargs.pop("path"), inboundPlanId, packingGroupId), params=kwargs
871
+ )
810
872
 
811
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/pallets', method='GET')
873
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/pallets", method="GET")
812
874
  def list_inbound_plan_pallets(self, inboundPlanId, **kwargs) -> ApiResponse:
813
875
  """
814
- list_inbound_plan_pallets(self, inboundPlanId, **kwargs) -> ApiResponse
876
+ list_inbound_plan_pallets(self, inboundPlanId, **kwargs) -> ApiResponse
815
877
 
816
- Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
878
+ Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
817
879
 
818
- **Usage Plan:**
880
+ **Usage Plan:**
819
881
 
820
- | Rate (requests per second) | Burst |
821
- | ---- | ---- |
822
- | 1 | 1 |
882
+ | Rate (requests per second) | Burst |
883
+ | ---- | ---- |
884
+ | 1 | 1 |
823
885
 
824
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
886
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
825
887
 
826
- Args:
888
+ Args:
827
889
 
828
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
890
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
829
891
 
830
- key pageSize:integer | The number of pallets to return in the response matching the given query.
892
+ key pageSize:integer | The number of pallets to return in the response matching the given query.
831
893
 
832
- key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
894
+ key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
833
895
 
834
896
 
835
- Returns:
836
- ApiResponse:
897
+ Returns:
898
+ ApiResponse:
837
899
  """
838
900
 
839
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), params=kwargs)
901
+ return self._request(
902
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
903
+ )
840
904
 
841
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/placementOptions', method='GET')
905
+ @sp_endpoint(
906
+ "/inbound/fba/<version>/inboundPlans/{}/placementOptions", method="GET"
907
+ )
842
908
  def list_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse:
843
909
  """
844
- list_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse
910
+ list_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse
845
911
 
846
- Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available.
912
+ Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available.
847
913
 
848
- **Usage Plan:**
914
+ **Usage Plan:**
849
915
 
850
- | Rate (requests per second) | Burst |
851
- | ---- | ---- |
852
- | 1 | 1 |
916
+ | Rate (requests per second) | Burst |
917
+ | ---- | ---- |
918
+ | 1 | 1 |
853
919
 
854
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
920
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
855
921
 
856
- Args:
922
+ Args:
857
923
 
858
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
924
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
859
925
 
860
- key pageSize:integer | The number of placement options to return in the response matching the given query.
926
+ key pageSize:integer | The number of placement options to return in the response matching the given query.
861
927
 
862
- key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
928
+ key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
863
929
 
864
930
 
865
- Returns:
866
- ApiResponse:
931
+ Returns:
932
+ ApiResponse:
867
933
  """
868
934
 
869
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), params=kwargs)
935
+ return self._request(
936
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
937
+ )
870
938
 
871
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/placementOptions', method='POST')
939
+ @sp_endpoint(
940
+ "/inbound/fba/<version>/inboundPlans/{}/placementOptions", method="POST"
941
+ )
872
942
  def generate_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse:
873
943
  """
874
- generate_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse
944
+ generate_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse
875
945
 
876
- Generates placement options for the inbound plan.
946
+ Generates placement options for the inbound plan.
877
947
 
878
- **Usage Plan:**
948
+ **Usage Plan:**
879
949
 
880
- | Rate (requests per second) | Burst |
881
- | ---- | ---- |
882
- | 0.05 | 1 |
950
+ | Rate (requests per second) | Burst |
951
+ | ---- | ---- |
952
+ | 0.05 | 1 |
883
953
 
884
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
954
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
885
955
 
886
- Args:
956
+ Args:
887
957
 
888
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
958
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
889
959
 
890
- body: | * REQUIRED {'description': 'The `generatePlacementOptions` request.',
891
- 'example': {'customPlacement': [{'items': [{'expiration': '2024-01-01', 'labelOwner': 'AMAZON', 'manufacturingLotCode': 'manufacturingLotCode', 'msku': 'Sunglasses', 'prepOwner': 'AMAZON', 'quantity': 10}], 'warehouseId': 'YYZ14'}]},
892
- 'properties': {'customPlacement': {'description': 'Custom placements options to be added to the plan.', 'items': {'$ref': '#/definitions/CustomPlacementInput'}, 'type': 'array'}},
893
- 'type': 'object'}
960
+ body: | * REQUIRED {'description': 'The `generatePlacementOptions` request.',
961
+ 'example': {'customPlacement': [{'items': [{'expiration': '2024-01-01', 'labelOwner': 'AMAZON', 'manufacturingLotCode': 'manufacturingLotCode', 'msku': 'Sunglasses', 'prepOwner': 'AMAZON', 'quantity': 10}], 'warehouseId': 'YYZ14'}]},
962
+ 'properties': {'customPlacement': {'description': 'Custom placements options to be added to the plan.', 'items': {'$ref': '#/definitions/CustomPlacementInput'}, 'type': 'array'}},
963
+ 'type': 'object'}
894
964
 
895
965
 
896
- Returns:
897
- ApiResponse:
966
+ Returns:
967
+ ApiResponse:
898
968
  """
899
969
 
900
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), data=kwargs)
970
+ return self._request(
971
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
972
+ )
901
973
 
902
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/placementOptions/{}/confirmation', method='POST')
903
- def confirm_placement_option(self, inboundPlanId, placementOptionId, **kwargs) -> ApiResponse:
974
+ @sp_endpoint(
975
+ "/inbound/fba/<version>/inboundPlans/{}/placementOptions/{}/confirmation",
976
+ method="POST",
977
+ )
978
+ def confirm_placement_option(
979
+ self, inboundPlanId, placementOptionId, **kwargs
980
+ ) -> ApiResponse:
904
981
  """
905
- confirm_placement_option(self, inboundPlanId, **kwargs) -> ApiResponse
982
+ confirm_placement_option(self, inboundPlanId, **kwargs) -> ApiResponse
906
983
 
907
- Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
984
+ Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
908
985
 
909
- **Usage Plan:**
986
+ **Usage Plan:**
910
987
 
911
- | Rate (requests per second) | Burst |
912
- | ---- | ---- |
913
- | 0.05 | 1 |
988
+ | Rate (requests per second) | Burst |
989
+ | ---- | ---- |
990
+ | 0.05 | 1 |
914
991
 
915
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
992
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
916
993
 
917
- Args:
994
+ Args:
918
995
 
919
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
996
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
920
997
 
921
- placementOptionId:string | * REQUIRED Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs.
998
+ placementOptionId:string | * REQUIRED Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs.
922
999
 
923
1000
 
924
- Returns:
925
- ApiResponse:
1001
+ Returns:
1002
+ ApiResponse:
926
1003
  """
927
1004
 
928
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId, placementOptionId), data=kwargs)
1005
+ return self._request(
1006
+ fill_query_params(kwargs.pop("path"), inboundPlanId, placementOptionId),
1007
+ data=kwargs,
1008
+ )
929
1009
 
930
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/shipments/{}', method='GET')
1010
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/shipments/{}", method="GET")
931
1011
  def get_shipment(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
932
1012
  """
933
- get_shipment(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
1013
+ get_shipment(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
934
1014
 
935
- Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment.
1015
+ Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment.
936
1016
 
937
- **Usage Plan:**
1017
+ **Usage Plan:**
938
1018
 
939
- | Rate (requests per second) | Burst |
940
- | ---- | ---- |
941
- | 1 | 1 |
1019
+ | Rate (requests per second) | Burst |
1020
+ | ---- | ---- |
1021
+ | 1 | 1 |
942
1022
 
943
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1023
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
944
1024
 
945
- Args:
1025
+ Args:
946
1026
 
947
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1027
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
948
1028
 
949
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1029
+ shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
950
1030
 
951
1031
 
952
- Returns:
953
- ApiResponse:
1032
+ Returns:
1033
+ ApiResponse:
954
1034
  """
955
1035
 
956
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId, shipmentId), params=kwargs)
1036
+ return self._request(
1037
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1038
+ params=kwargs,
1039
+ )
957
1040
 
958
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/deliveryChallanDocument', method='GET')
1041
+ @sp_endpoint(
1042
+ "/inbound/fba/<version>/inboundPlans/{}/deliveryChallanDocument", method="GET"
1043
+ )
959
1044
  def get_delivery_challan_document(self, inboundPlanId, **kwargs) -> ApiResponse:
960
1045
  """
961
- get_delivery_challan_document(self, inboundPlanId, **kwargs) -> ApiResponse
1046
+ get_delivery_challan_document(self, inboundPlanId, **kwargs) -> ApiResponse
962
1047
 
963
- Provide delivery challan document for PCP transportation in IN marketplace.
1048
+ Provide delivery challan document for PCP transportation in IN marketplace.
964
1049
 
965
- **Usage Plan:**
1050
+ **Usage Plan:**
966
1051
 
967
- | Rate (requests per second) | Burst |
968
- | ---- | ---- |
969
- | 1 | 1 |
1052
+ | Rate (requests per second) | Burst |
1053
+ | ---- | ---- |
1054
+ | 1 | 1 |
970
1055
 
971
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1056
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
972
1057
 
973
- Args:
1058
+ Args:
974
1059
 
975
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1060
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
976
1061
 
977
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1062
+ shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
978
1063
 
979
1064
 
980
- Returns:
981
- ApiResponse:
1065
+ Returns:
1066
+ ApiResponse:
982
1067
  """
983
1068
 
984
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), params=kwargs)
1069
+ return self._request(
1070
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
1071
+ )
985
1072
 
986
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/deliveryWindow', method='POST')
1073
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/deliveryWindow", method="POST")
987
1074
  def update_shipment_delivery_window(self, inboundPlanId, **kwargs) -> ApiResponse:
988
1075
  """
989
- update_shipment_delivery_window(self, inboundPlanId, **kwargs) -> ApiResponse
1076
+ update_shipment_delivery_window(self, inboundPlanId, **kwargs) -> ApiResponse
990
1077
 
991
- Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse.
1078
+ Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse.
992
1079
 
993
- **Usage Plan:**
1080
+ **Usage Plan:**
994
1081
 
995
- | Rate (requests per second) | Burst |
996
- | ---- | ---- |
997
- | 1 | 1 |
1082
+ | Rate (requests per second) | Burst |
1083
+ | ---- | ---- |
1084
+ | 1 | 1 |
998
1085
 
999
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1086
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1000
1087
 
1001
- Args:
1088
+ Args:
1002
1089
 
1003
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1090
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1004
1091
 
1005
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1092
+ shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1006
1093
 
1007
- body: | * REQUIRED {'description': 'The `updateShipmentDeliveryWindow` request.',
1008
- 'example': {'deliveryWindow': {'start': '2024-01-01T00:00Z'}},
1009
- 'properties': {'deliveryWindow': {'$ref': '#/definitions/WindowInput', 'description': 'The range of dates within which the seller expects that their shipment will be delivered to Amazon.\n'}},
1010
- 'required': ['deliveryWindow'],
1011
- 'type': 'object'}
1094
+ body: | * REQUIRED {'description': 'The `updateShipmentDeliveryWindow` request.',
1095
+ 'example': {'deliveryWindow': {'start': '2024-01-01T00:00Z'}},
1096
+ 'properties': {'deliveryWindow': {'$ref': '#/definitions/WindowInput', 'description': 'The range of dates within which the seller expects that their shipment will be delivered to Amazon.\n'}},
1097
+ 'required': ['deliveryWindow'],
1098
+ 'type': 'object'}
1012
1099
 
1013
1100
 
1014
- Returns:
1015
- ApiResponse:
1101
+ Returns:
1102
+ ApiResponse:
1016
1103
  """
1017
1104
 
1018
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), data=kwargs)
1105
+ return self._request(
1106
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1107
+ )
1019
1108
 
1020
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/selfShipAppointmentSlots', method='GET')
1109
+ @sp_endpoint(
1110
+ "/inbound/fba/<version>/inboundPlans/{}/selfShipAppointmentSlots", method="GET"
1111
+ )
1021
1112
  def get_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse:
1022
1113
  """
1023
- get_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse
1114
+ get_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse
1024
1115
 
1025
- Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse.
1116
+ Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse.
1026
1117
 
1027
- **Usage Plan:**
1118
+ **Usage Plan:**
1028
1119
 
1029
- | Rate (requests per second) | Burst |
1030
- | ---- | ---- |
1031
- | 1 | 1 |
1120
+ | Rate (requests per second) | Burst |
1121
+ | ---- | ---- |
1122
+ | 1 | 1 |
1032
1123
 
1033
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1124
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1034
1125
 
1035
- Args:
1126
+ Args:
1036
1127
 
1037
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1128
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1038
1129
 
1039
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1130
+ shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1040
1131
 
1041
- key pageSize:integer | The number of self ship appointment slots to return in the response matching the given query.
1132
+ key pageSize:integer | The number of self ship appointment slots to return in the response matching the given query.
1042
1133
 
1043
- key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1134
+ key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1044
1135
 
1045
1136
 
1046
- Returns:
1047
- ApiResponse:
1137
+ Returns:
1138
+ ApiResponse:
1048
1139
  """
1049
1140
 
1050
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), params=kwargs)
1141
+ return self._request(
1142
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
1143
+ )
1051
1144
 
1052
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/selfShipAppointmentSlots', method='POST')
1053
- def generate_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse:
1145
+ @sp_endpoint(
1146
+ "/inbound/fba/<version>/inboundPlans/{}/selfShipAppointmentSlots", method="POST"
1147
+ )
1148
+ def generate_self_ship_appointment_slots(
1149
+ self, inboundPlanId, **kwargs
1150
+ ) -> ApiResponse:
1054
1151
  """
1055
- generate_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse
1152
+ generate_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse
1056
1153
 
1057
- Initiates the process of generating the appointment slots list.
1154
+ Initiates the process of generating the appointment slots list.
1058
1155
 
1059
- **Usage Plan:**
1156
+ **Usage Plan:**
1060
1157
 
1061
- | Rate (requests per second) | Burst |
1062
- | ---- | ---- |
1063
- | 1 | 1 |
1158
+ | Rate (requests per second) | Burst |
1159
+ | ---- | ---- |
1160
+ | 1 | 1 |
1064
1161
 
1065
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1162
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1066
1163
 
1067
- Args:
1164
+ Args:
1068
1165
 
1069
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1166
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1070
1167
 
1071
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1168
+ shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1072
1169
 
1073
- body: | * REQUIRED {'description': 'The `generateSelfShipAppointmentSlots` request.',
1074
- 'example': {'desiredEndDate': '2024-01-06T14:48:00.000Z', 'desiredStartDate': '2024-01-05T14:48:00.000Z'},
1075
- 'properties': {'desiredEndDate': {'description': 'The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.', 'format': 'date-time', 'type': 'string'},
1076
- 'desiredStartDate': {'description': 'The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.', 'format': 'date-time', 'type': 'string'}},
1077
- 'type': 'object'}
1170
+ body: | * REQUIRED {'description': 'The `generateSelfShipAppointmentSlots` request.',
1171
+ 'example': {'desiredEndDate': '2024-01-06T14:48:00.000Z', 'desiredStartDate': '2024-01-05T14:48:00.000Z'},
1172
+ 'properties': {'desiredEndDate': {'description': 'The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.', 'format': 'date-time', 'type': 'string'},
1173
+ 'desiredStartDate': {'description': 'The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.', 'format': 'date-time', 'type': 'string'}},
1174
+ 'type': 'object'}
1078
1175
 
1079
1176
 
1080
- Returns:
1081
- ApiResponse:
1177
+ Returns:
1178
+ ApiResponse:
1082
1179
  """
1083
1180
 
1084
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), data=kwargs)
1181
+ return self._request(
1182
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1183
+ )
1085
1184
 
1086
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/cancellation', method='PUT')
1185
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/cancellation", method="PUT")
1087
1186
  def cancel_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse:
1088
1187
  """
1089
- cancel_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse
1188
+ cancel_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse
1090
1189
 
1091
- Cancels a self-ship appointment slot against a shipment.
1190
+ Cancels a self-ship appointment slot against a shipment.
1092
1191
 
1093
- **Usage Plan:**
1192
+ **Usage Plan:**
1094
1193
 
1095
- | Rate (requests per second) | Burst |
1096
- | ---- | ---- |
1097
- | 1 | 1 |
1194
+ | Rate (requests per second) | Burst |
1195
+ | ---- | ---- |
1196
+ | 1 | 1 |
1098
1197
 
1099
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1198
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1100
1199
 
1101
- Args:
1200
+ Args:
1102
1201
 
1103
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1202
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1104
1203
 
1105
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1204
+ shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1106
1205
 
1107
- slotId:string | * REQUIRED Identifier to a self-ship appointment slot.
1206
+ slotId:string | * REQUIRED Identifier to a self-ship appointment slot.
1108
1207
 
1109
- body: | * REQUIRED {'description': 'The `cancelSelfShipAppointment` request.', 'example': {'reasonComment': 'OTHER'}, 'properties': {'reasonComment': {'$ref': '#/definitions/ReasonComment'}}, 'type': 'object'}
1208
+ body: | * REQUIRED {'description': 'The `cancelSelfShipAppointment` request.', 'example': {'reasonComment': 'OTHER'}, 'properties': {'reasonComment': {'$ref': '#/definitions/ReasonComment'}}, 'type': 'object'}
1110
1209
 
1111
1210
 
1112
- Returns:
1113
- ApiResponse:
1211
+ Returns:
1212
+ ApiResponse:
1114
1213
  """
1115
1214
 
1116
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), data=kwargs)
1215
+ return self._request(
1216
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1217
+ )
1117
1218
 
1118
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/schedule', method='POST')
1219
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/schedule", method="POST")
1119
1220
  def schedule_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse:
1120
1221
  """
1121
- schedule_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse
1222
+ schedule_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse
1122
1223
 
1123
- Confirms or reschedules a self-ship appointment slot against a shipment.
1224
+ Confirms or reschedules a self-ship appointment slot against a shipment.
1124
1225
 
1125
- **Usage Plan:**
1226
+ **Usage Plan:**
1126
1227
 
1127
- | Rate (requests per second) | Burst |
1128
- | ---- | ---- |
1129
- | 1 | 1 |
1228
+ | Rate (requests per second) | Burst |
1229
+ | ---- | ---- |
1230
+ | 1 | 1 |
1130
1231
 
1131
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1232
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1132
1233
 
1133
- Args:
1234
+ Args:
1134
1235
 
1135
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1236
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1136
1237
 
1137
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1238
+ shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1138
1239
 
1139
- slotId:string | * REQUIRED Identifier to a self-ship appointment slot.
1240
+ slotId:string | * REQUIRED Identifier to a self-ship appointment slot.
1140
1241
 
1141
- body: | * REQUIRED {'description': '`scheduleSelfShipAppointment` request.', 'example': {'reasonComment': 'OTHER'}, 'properties': {'reasonComment': {'$ref': '#/definitions/ReasonComment'}}, 'type': 'object'}
1242
+ body: | * REQUIRED {'description': '`scheduleSelfShipAppointment` request.', 'example': {'reasonComment': 'OTHER'}, 'properties': {'reasonComment': {'$ref': '#/definitions/ReasonComment'}}, 'type': 'object'}
1142
1243
 
1143
1244
 
1144
- Returns:
1145
- ApiResponse:
1245
+ Returns:
1246
+ ApiResponse:
1146
1247
  """
1147
1248
 
1148
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), data=kwargs)
1249
+ return self._request(
1250
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1251
+ )
1149
1252
 
1150
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/trackingDetails', method='PUT')
1253
+ @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/trackingDetails", method="PUT")
1151
1254
  def update_shipment_tracking_details(self, inboundPlanId, **kwargs) -> ApiResponse:
1152
1255
  """
1153
- update_shipment_tracking_details(self, inboundPlanId, **kwargs) -> ApiResponse
1256
+ update_shipment_tracking_details(self, inboundPlanId, **kwargs) -> ApiResponse
1154
1257
 
1155
- Updates a shipment's tracking details.
1258
+ Updates a shipment's tracking details.
1156
1259
 
1157
- **Usage Plan:**
1260
+ **Usage Plan:**
1158
1261
 
1159
- | Rate (requests per second) | Burst |
1160
- | ---- | ---- |
1161
- | 1 | 1 |
1262
+ | Rate (requests per second) | Burst |
1263
+ | ---- | ---- |
1264
+ | 1 | 1 |
1162
1265
 
1163
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1266
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1164
1267
 
1165
- Args:
1268
+ Args:
1166
1269
 
1167
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1270
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1168
1271
 
1169
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1272
+ shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1170
1273
 
1171
- body: | * REQUIRED {'description': 'The `updateShipmentTrackingDetails` request.',
1172
- 'example': {'trackingDetails': {'spdTrackingDetail': {'spdTrackingItems': [{'boxId': 'FBA10ABC0YY100001', 'trackingId': 'FBA10002000'}]}}},
1173
- 'properties': {'trackingDetails': {'$ref': '#/definitions/TrackingDetailsInput'}},
1174
- 'required': ['trackingDetails'],
1175
- 'type': 'object'}
1274
+ body: | * REQUIRED {'description': 'The `updateShipmentTrackingDetails` request.',
1275
+ 'example': {'trackingDetails': {'spdTrackingDetail': {'spdTrackingItems': [{'boxId': 'FBA10ABC0YY100001', 'trackingId': 'FBA10002000'}]}}},
1276
+ 'properties': {'trackingDetails': {'$ref': '#/definitions/TrackingDetailsInput'}},
1277
+ 'required': ['trackingDetails'],
1278
+ 'type': 'object'}
1176
1279
 
1177
1280
 
1178
- Returns:
1179
- ApiResponse:
1281
+ Returns:
1282
+ ApiResponse:
1180
1283
  """
1181
1284
 
1182
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), data=kwargs)
1285
+ return self._request(
1286
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1287
+ )
1183
1288
 
1184
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/transportationOptions', method='GET')
1289
+ @sp_endpoint(
1290
+ "/inbound/fba/<version>/inboundPlans/{}/transportationOptions", method="GET"
1291
+ )
1185
1292
  def list_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse:
1186
1293
  """
1187
- list_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1294
+ list_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1188
1295
 
1189
- Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available.
1296
+ Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available.
1190
1297
 
1191
- **Usage Plan:**
1298
+ **Usage Plan:**
1192
1299
 
1193
- | Rate (requests per second) | Burst |
1194
- | ---- | ---- |
1195
- | 1 | 1 |
1300
+ | Rate (requests per second) | Burst |
1301
+ | ---- | ---- |
1302
+ | 1 | 1 |
1196
1303
 
1197
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1304
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1198
1305
 
1199
- Args:
1306
+ Args:
1200
1307
 
1201
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1308
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1202
1309
 
1203
- key pageSize:integer | The number of transportation options to return in the response matching the given query.
1310
+ key pageSize:integer | The number of transportation options to return in the response matching the given query.
1204
1311
 
1205
- key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1312
+ key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1206
1313
 
1207
- key placementOptionId:string | The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.
1314
+ key placementOptionId:string | The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.
1208
1315
 
1209
- key shipmentId:string | The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.
1316
+ key shipmentId:string | The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.
1210
1317
 
1211
1318
 
1212
- Returns:
1213
- ApiResponse:
1319
+ Returns:
1320
+ ApiResponse:
1214
1321
  """
1215
1322
 
1216
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), params=kwargs)
1323
+ return self._request(
1324
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
1325
+ )
1217
1326
 
1218
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/transportationOptions', method='POST')
1327
+ @sp_endpoint(
1328
+ "/inbound/fba/<version>/inboundPlans/{}/transportationOptions", method="POST"
1329
+ )
1219
1330
  def generate_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse:
1220
1331
  """
1221
- generate_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1332
+ generate_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1222
1333
 
1223
- Generates available transportation options for a given placement option.
1334
+ Generates available transportation options for a given placement option.
1224
1335
 
1225
- **Usage Plan:**
1336
+ **Usage Plan:**
1226
1337
 
1227
- | Rate (requests per second) | Burst |
1228
- | ---- | ---- |
1229
- | 0.05 | 1 |
1338
+ | Rate (requests per second) | Burst |
1339
+ | ---- | ---- |
1340
+ | 0.05 | 1 |
1230
1341
 
1231
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1342
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1232
1343
 
1233
- Args:
1344
+ Args:
1234
1345
 
1235
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1236
-
1237
- body: | * REQUIRED {'description': 'The `generateTransportationOptions` request.',
1238
- 'example': {'placementOptionId': 'pl1234abcd-1234-abcd-5678-1234abcd5678',
1239
- 'shipmentTransportationConfigurations': [{'contactInformation': {'email': 'email@email.com', 'name': 'John Smithy', 'phoneNumber': '1234567890'},
1240
- 'palletInformation': {'declaredValue': {'amount': 500, 'code': 'USD'},
1241
- 'freightClass': 'FC_50',
1242
- 'pallets': [{'dimensions': {'height': 5, 'length': 3, 'unitOfMeasurement': 'CM', 'width': 4},
1243
- 'quantity': 2,
1244
- 'stackability': 'STACKABLE',
1245
- 'weight': {'unit': 'KG', 'value': 5.5}}]},
1246
- 'readyToShipWindow': {'start': '2024-01-01T00:00Z'},
1247
- 'shipmentId': 'sh1234abcd-1234-abcd-5678-1234abcd5678'}]},
1248
- 'properties': {'placementOptionId': {'description': 'The placement option to generate transportation options for.', 'maxLength': 38, 'minLength': 38, 'pattern': '^[a-zA-Z0-9-]*$', 'type': 'string'},
1249
- 'shipmentTransportationConfigurations': {'description': 'List of shipment transportation configurations.', 'items': {'$ref': '#/definitions/ShipmentTransportationConfiguration'}, 'type': 'array'}},
1250
- 'required': ['placementOptionId', 'shipmentTransportationConfigurations'],
1251
- 'type': 'object'}
1346
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1252
1347
 
1348
+ body: | * REQUIRED {'description': 'The `generateTransportationOptions` request.',
1349
+ 'example': {'placementOptionId': 'pl1234abcd-1234-abcd-5678-1234abcd5678',
1350
+ 'shipmentTransportationConfigurations': [{'contactInformation': {'email': 'email@email.com', 'name': 'John Smithy', 'phoneNumber': '1234567890'},
1351
+ 'palletInformation': {'declaredValue': {'amount': 500, 'code': 'USD'},
1352
+ 'freightClass': 'FC_50',
1353
+ 'pallets': [{'dimensions': {'height': 5, 'length': 3, 'unitOfMeasurement': 'CM', 'width': 4},
1354
+ 'quantity': 2,
1355
+ 'stackability': 'STACKABLE',
1356
+ 'weight': {'unit': 'KG', 'value': 5.5}}]},
1357
+ 'readyToShipWindow': {'start': '2024-01-01T00:00Z'},
1358
+ 'shipmentId': 'sh1234abcd-1234-abcd-5678-1234abcd5678'}]},
1359
+ 'properties': {'placementOptionId': {'description': 'The placement option to generate transportation options for.', 'maxLength': 38, 'minLength': 38, 'pattern': '^[a-zA-Z0-9-]*$', 'type': 'string'},
1360
+ 'shipmentTransportationConfigurations': {'description': 'List of shipment transportation configurations.', 'items': {'$ref': '#/definitions/ShipmentTransportationConfiguration'}, 'type': 'array'}},
1361
+ 'required': ['placementOptionId', 'shipmentTransportationConfigurations'],
1362
+ 'type': 'object'}
1253
1363
 
1254
- Returns:
1255
- ApiResponse:
1364
+
1365
+ Returns:
1366
+ ApiResponse:
1256
1367
  """
1257
1368
 
1258
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), data=kwargs)
1369
+ return self._request(
1370
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1371
+ )
1259
1372
 
1260
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/transportationOptions/confirmation', method='POST')
1373
+ @sp_endpoint(
1374
+ "/inbound/fba/<version>/inboundPlans/{}/transportationOptions/confirmation",
1375
+ method="POST",
1376
+ )
1261
1377
  def confirm_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse:
1262
1378
  """
1263
- confirm_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1379
+ confirm_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1264
1380
 
1265
- Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan.
1381
+ Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan.
1266
1382
 
1267
- **Usage Plan:**
1383
+ **Usage Plan:**
1268
1384
 
1269
- | Rate (requests per second) | Burst |
1270
- | ---- | ---- |
1271
- | 0.05 | 1 |
1385
+ | Rate (requests per second) | Burst |
1386
+ | ---- | ---- |
1387
+ | 0.05 | 1 |
1272
1388
 
1273
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1389
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1274
1390
 
1275
- Args:
1391
+ Args:
1276
1392
 
1277
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1393
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1278
1394
 
1279
- body: | * REQUIRED {'description': 'The `confirmTransportationOptions` request.',
1280
- 'example': {'transportationSelections': [{'contactInformation': {'email': 'email@email.com', 'name': 'John Smithy', 'phoneNumber': '1234567890'},
1281
- 'deliveryWindow': {'start': '2024-01-01T00:00Z'},
1282
- 'shipmentId': 'sh1234abcd-1234-abcd-5678-1234abcd5678',
1283
- 'transportationOptionId': 'to1234abcd-1234-abcd-5678-1234abcd5678'}]},
1284
- 'properties': {'transportationSelections': {'description': 'Information needed to confirm one of the available transportation options.', 'items': {'$ref': '#/definitions/TransportationSelection'}, 'minItems': 1, 'type': 'array'}},
1285
- 'required': ['transportationSelections'],
1286
- 'type': 'object'}
1395
+ body: | * REQUIRED {'description': 'The `confirmTransportationOptions` request.',
1396
+ 'example': {'transportationSelections': [{'contactInformation': {'email': 'email@email.com', 'name': 'John Smithy', 'phoneNumber': '1234567890'},
1397
+ 'deliveryWindow': {'start': '2024-01-01T00:00Z'},
1398
+ 'shipmentId': 'sh1234abcd-1234-abcd-5678-1234abcd5678',
1399
+ 'transportationOptionId': 'to1234abcd-1234-abcd-5678-1234abcd5678'}]},
1400
+ 'properties': {'transportationSelections': {'description': 'Information needed to confirm one of the available transportation options.', 'items': {'$ref': '#/definitions/TransportationSelection'}, 'minItems': 1, 'type': 'array'}},
1401
+ 'required': ['transportationSelections'],
1402
+ 'type': 'object'}
1287
1403
 
1288
1404
 
1289
- Returns:
1290
- ApiResponse:
1405
+ Returns:
1406
+ ApiResponse:
1291
1407
  """
1292
1408
 
1293
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId), data=kwargs)
1409
+ return self._request(
1410
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1411
+ )
1294
1412
 
1295
- @sp_endpoint('/inbound/fba/<version>/items/compliance', method='GET')
1413
+ @sp_endpoint("/inbound/fba/<version>/items/compliance", method="GET")
1296
1414
  def list_item_compliance_details(self, **kwargs) -> ApiResponse:
1297
1415
  """
1298
- list_item_compliance_details(self, **kwargs) -> ApiResponse
1416
+ list_item_compliance_details(self, **kwargs) -> ApiResponse
1299
1417
 
1300
- List the inbound compliance details for MSKUs in a given marketplace.
1418
+ List the inbound compliance details for MSKUs in a given marketplace.
1301
1419
 
1302
- **Usage Plan:**
1420
+ **Usage Plan:**
1303
1421
 
1304
- | Rate (requests per second) | Burst |
1305
- | ---- | ---- |
1306
- | 1 | 1 |
1422
+ | Rate (requests per second) | Burst |
1423
+ | ---- | ---- |
1424
+ | 1 | 1 |
1307
1425
 
1308
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1426
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1309
1427
 
1310
- Args:
1428
+ Args:
1311
1429
 
1312
- key mskus:array | * REQUIRED List of merchant SKUs, a merchant-supplied identifier for a specific SKU.
1430
+ key mskus:array | * REQUIRED List of merchant SKUs, a merchant-supplied identifier for a specific SKU.
1313
1431
 
1314
- key marketplaceId:string | * REQUIRED The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
1432
+ key marketplaceId:string | * REQUIRED The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
1315
1433
 
1316
1434
 
1317
- Returns:
1318
- ApiResponse:
1435
+ Returns:
1436
+ ApiResponse:
1319
1437
  """
1320
1438
 
1321
- return self._request(kwargs.pop('path'), params=kwargs)
1439
+ return self._request(kwargs.pop("path"), params=kwargs)
1322
1440
 
1323
- @sp_endpoint('/inbound/fba/<version>/items/compliance', method='PUT')
1441
+ @sp_endpoint("/inbound/fba/<version>/items/compliance", method="PUT")
1324
1442
  def update_item_compliance_details(self, **kwargs) -> ApiResponse:
1325
1443
  """
1326
- update_item_compliance_details(self, **kwargs) -> ApiResponse
1444
+ update_item_compliance_details(self, **kwargs) -> ApiResponse
1327
1445
 
1328
- Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation.
1446
+ Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation.
1329
1447
 
1330
- **Usage Plan:**
1448
+ **Usage Plan:**
1331
1449
 
1332
- | Rate (requests per second) | Burst |
1333
- | ---- | ---- |
1334
- | 1 | 1 |
1450
+ | Rate (requests per second) | Burst |
1451
+ | ---- | ---- |
1452
+ | 1 | 1 |
1335
1453
 
1336
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1454
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1337
1455
 
1338
- Args:
1456
+ Args:
1339
1457
 
1340
- key marketplaceId:string | * REQUIRED The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
1458
+ key marketplaceId:string | * REQUIRED The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
1341
1459
 
1342
- body: | * REQUIRED {'description': 'The `updateItemComplianceDetails` request.',
1343
- 'example': {'msku': 'Sunglasses', 'taxDetails': {'declaredValue': {'amount': 5.5, 'code': 'CAD'}, 'hsnCode': 'hsnCode'}},
1344
- 'properties': {'msku': {'description': 'The merchant SKU, a merchant-supplied identifier for a specific SKU.', 'maxLength': 40, 'minLength': 1, 'type': 'string'}, 'taxDetails': {'$ref': '#/definitions/TaxDetails'}},
1345
- 'required': ['msku', 'taxDetails'],
1346
- 'type': 'object'}
1460
+ body: | * REQUIRED {'description': 'The `updateItemComplianceDetails` request.',
1461
+ 'example': {'msku': 'Sunglasses', 'taxDetails': {'declaredValue': {'amount': 5.5, 'code': 'CAD'}, 'hsnCode': 'hsnCode'}},
1462
+ 'properties': {'msku': {'description': 'The merchant SKU, a merchant-supplied identifier for a specific SKU.', 'maxLength': 40, 'minLength': 1, 'type': 'string'}, 'taxDetails': {'$ref': '#/definitions/TaxDetails'}},
1463
+ 'required': ['msku', 'taxDetails'],
1464
+ 'type': 'object'}
1347
1465
 
1348
1466
 
1349
- Returns:
1350
- ApiResponse:
1467
+ Returns:
1468
+ ApiResponse:
1351
1469
  """
1352
1470
 
1353
- return self._request(kwargs.pop('path'), data=kwargs)
1471
+ return self._request(kwargs.pop("path"), data=kwargs)
1354
1472
 
1355
- @sp_endpoint('/inbound/fba/<version>/operations/{}', method='GET')
1473
+ @sp_endpoint("/inbound/fba/<version>/operations/{}", method="GET")
1356
1474
  def get_inbound_operation_status(self, operationId, **kwargs) -> ApiResponse:
1357
1475
  """
1358
- get_inbound_operation_status(self, operationId, **kwargs) -> ApiResponse
1476
+ get_inbound_operation_status(self, operationId, **kwargs) -> ApiResponse
1359
1477
 
1360
- Gets the status of the processing of an asynchronous API call.
1478
+ Gets the status of the processing of an asynchronous API call.
1361
1479
 
1362
- **Usage Plan:**
1480
+ **Usage Plan:**
1363
1481
 
1364
- | Rate (requests per second) | Burst |
1365
- | ---- | ---- |
1366
- | 1 | 1 |
1482
+ | Rate (requests per second) | Burst |
1483
+ | ---- | ---- |
1484
+ | 1 | 1 |
1367
1485
 
1368
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1486
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1369
1487
 
1370
- Args:
1488
+ Args:
1371
1489
 
1372
- operationId:string | * REQUIRED Identifier to an asynchronous operation.
1490
+ operationId:string | * REQUIRED Identifier to an asynchronous operation.
1373
1491
 
1374
1492
 
1375
- Returns:
1376
- ApiResponse:
1493
+ Returns:
1494
+ ApiResponse:
1377
1495
  """
1378
1496
 
1379
- return self._request(fill_query_params(kwargs.pop('path'), operationId), params=kwargs)
1497
+ return self._request(
1498
+ fill_query_params(kwargs.pop("path"), operationId), params=kwargs
1499
+ )
1380
1500
 
1381
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/shipments/{}/deliveryWindowOptions', method='POST')
1382
- def generate_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1501
+ @sp_endpoint(
1502
+ "/inbound/fba/<version>/inboundPlans/{}/shipments/{}/deliveryWindowOptions",
1503
+ method="POST",
1504
+ )
1505
+ def generate_delivery_window_options(
1506
+ self, inboundPlanId, shipmentId, **kwargs
1507
+ ) -> ApiResponse:
1383
1508
  """
1384
- def generate_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1509
+ def generate_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1385
1510
 
1386
- Generates available delivery window options for a given shipment.
1511
+ Generates available delivery window options for a given shipment.
1387
1512
 
1388
- **Usage Plan:**
1513
+ **Usage Plan:**
1389
1514
 
1390
- | Rate (requests per second) | Burst |
1391
- | ---- | ---- |
1392
- | 2 | 30 |
1515
+ | Rate (requests per second) | Burst |
1516
+ | ---- | ---- |
1517
+ | 2 | 30 |
1393
1518
 
1394
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1519
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1395
1520
 
1396
- Args:
1521
+ Args:
1397
1522
 
1398
- inboundPlanId:string | * REQUIRED Identifier of an inbound plan.
1399
- shipmentId:string | * REQUIRED The shipment to generate delivery window options for.
1523
+ inboundPlanId:string | * REQUIRED Identifier of an inbound plan.
1524
+ shipmentId:string | * REQUIRED The shipment to generate delivery window options for.
1400
1525
 
1401
1526
 
1402
- Returns:
1403
- ApiResponse:
1527
+ Returns:
1528
+ ApiResponse:
1404
1529
  """
1405
1530
 
1406
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId, shipmentId), params=kwargs)
1531
+ return self._request(
1532
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1533
+ params=kwargs,
1534
+ )
1407
1535
 
1408
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/shipments/{}/deliveryWindowOptions', method='GET')
1409
- def list_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1536
+ @sp_endpoint(
1537
+ "/inbound/fba/<version>/inboundPlans/{}/shipments/{}/deliveryWindowOptions",
1538
+ method="GET",
1539
+ )
1540
+ def list_delivery_window_options(
1541
+ self, inboundPlanId, shipmentId, **kwargs
1542
+ ) -> ApiResponse:
1410
1543
  """
1411
- def generate_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1544
+ def generate_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1412
1545
 
1413
- Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the generateDeliveryWindowOptions operation before becoming available.
1546
+ Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the generateDeliveryWindowOptions operation before becoming available.
1414
1547
 
1415
- **Usage Plan:**
1548
+ **Usage Plan:**
1416
1549
 
1417
- | Rate (requests per second) | Burst |
1418
- | ---- | ---- |
1419
- | 2 | 30 |
1550
+ | Rate (requests per second) | Burst |
1551
+ | ---- | ---- |
1552
+ | 2 | 30 |
1420
1553
 
1421
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1554
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1422
1555
 
1423
- Args:
1556
+ Args:
1424
1557
 
1425
- inboundPlanId:string | * REQUIRED Identifier of an inbound plan.
1426
- shipmentId:string | * REQUIRED The shipment to generate delivery window options for.
1558
+ inboundPlanId:string | * REQUIRED Identifier of an inbound plan.
1559
+ shipmentId:string | * REQUIRED The shipment to generate delivery window options for.
1427
1560
 
1428
1561
 
1429
- Returns:
1430
- ApiResponse:
1562
+ Returns:
1563
+ ApiResponse:
1431
1564
  """
1432
1565
 
1433
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId, shipmentId), params=kwargs)
1566
+ return self._request(
1567
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1568
+ params=kwargs,
1569
+ )
1434
1570
 
1435
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/shipments/{}/deliveryWindowOptions/{}/confirmation', method='POST')
1436
- def confirm_delivery_window_options(self, inboundPlanId, shipmentId, deliveryWindowOptionId, **kwargs) -> ApiResponse:
1571
+ @sp_endpoint(
1572
+ "/inbound/fba/<version>/inboundPlans/{}/shipments/{}/deliveryWindowOptions/{}/confirmation",
1573
+ method="POST",
1574
+ )
1575
+ def confirm_delivery_window_options(
1576
+ self, inboundPlanId, shipmentId, deliveryWindowOptionId, **kwargs
1577
+ ) -> ApiResponse:
1437
1578
  """
1438
- def confirm_delivery_window_options(self, inboundPlanId, shipmentId, deliveryWindowOptionId, **kwargs) -> ApiResponse:
1579
+ def confirm_delivery_window_options(self, inboundPlanId, shipmentId, deliveryWindowOptionId, **kwargs) -> ApiResponse:
1439
1580
 
1440
- Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program CONFIRMED_DELIVERY_WINDOW require a delivery window to be confirmed prior to transportation option confirmation.
1581
+ Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program CONFIRMED_DELIVERY_WINDOW require a delivery window to be confirmed prior to transportation option confirmation.
1441
1582
 
1442
- **Usage Plan:**
1583
+ **Usage Plan:**
1443
1584
 
1444
- | Rate (requests per second) | Burst |
1445
- | ---- | ---- |
1446
- | 2 | 30 |
1585
+ | Rate (requests per second) | Burst |
1586
+ | ---- | ---- |
1587
+ | 2 | 30 |
1447
1588
 
1448
- The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1589
+ The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
1449
1590
 
1450
- Args:
1591
+ Args:
1451
1592
 
1452
- inboundPlanId:string | * REQUIRED Identifier of an inbound plan.
1453
- shipmentId:string | * REQUIRED The shipment to generate delivery window options for.
1454
- deliveryWindowOptionId:string | REQUIRED The id of the delivery window option to be confirmed.
1593
+ inboundPlanId:string | * REQUIRED Identifier of an inbound plan.
1594
+ shipmentId:string | * REQUIRED The shipment to generate delivery window options for.
1595
+ deliveryWindowOptionId:string | REQUIRED The id of the delivery window option to be confirmed.
1455
1596
 
1456
1597
 
1457
- Returns:
1458
- ApiResponse:
1598
+ Returns:
1599
+ ApiResponse:
1459
1600
  """
1460
1601
 
1461
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId, shipmentId, deliveryWindowOptionId), params=kwargs)
1602
+ return self._request(
1603
+ fill_query_params(
1604
+ kwargs.pop("path"), inboundPlanId, shipmentId, deliveryWindowOptionId
1605
+ ),
1606
+ params=kwargs,
1607
+ )
1462
1608
 
1463
- @sp_endpoint('/inbound/fba/<version>/inboundPlans/{}/shipments/{}/items', method='GET')
1609
+ @sp_endpoint(
1610
+ "/inbound/fba/<version>/inboundPlans/{}/shipments/{}/items", method="GET"
1611
+ )
1464
1612
  def list_shipment_items(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1465
1613
  """
1466
- list_shipment_items(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
1614
+ list_shipment_items(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
1467
1615
 
1468
- Provides a paginated list of item packages in a shipment.
1616
+ Provides a paginated list of item packages in a shipment.
1469
1617
 
1470
- **Usage Plan:**
1618
+ **Usage Plan:**
1471
1619
 
1472
- | Rate (requests per second) | Burst |
1473
- | ---- | ---- |
1474
- | 2 | 30 |
1620
+ | Rate (requests per second) | Burst |
1621
+ | ---- | ---- |
1622
+ | 2 | 30 |
1475
1623
 
1476
- 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 contains the default rate and burst values for this operation. Selling partners 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).
1624
+ 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 contains the default rate and burst values for this operation. Selling partners 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).
1477
1625
 
1478
- Args:
1626
+ Args:
1479
1627
 
1480
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1628
+ inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1481
1629
 
1482
- shipmentId:string | * REQUIRED Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1630
+ shipmentId:string | * REQUIRED Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1483
1631
 
1484
- key pageSize:integer | The number of items to return in the response matching the given query.
1632
+ key pageSize:integer | The number of items to return in the response matching the given query.
1485
1633
 
1486
- key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1634
+ key paginationToken:string | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1487
1635
 
1488
1636
 
1489
- Returns:
1490
- ApiResponse:
1637
+ Returns:
1638
+ ApiResponse:
1491
1639
  """
1492
- return self._request(fill_query_params(kwargs.pop('path'), inboundPlanId, shipmentId), params=kwargs)
1640
+ return self._request(
1641
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1642
+ params=kwargs,
1643
+ )
1493
1644
 
1494
- @sp_endpoint('/inbound/fba/<version>/items/labels', method='POST')
1645
+ @sp_endpoint("/inbound/fba/<version>/items/labels", method="POST")
1495
1646
  def create_marketplace_item_labels(self, **kwargs) -> ApiResponse:
1496
1647
  """
1497
- create_marketplace_item_labels(self, **kwargs) -> ApiResponse
1648
+ create_marketplace_item_labels(self, **kwargs) -> ApiResponse
1498
1649
 
1499
- For a given marketplace - creates labels for a list of MSKUs.
1650
+ For a given marketplace - creates labels for a list of MSKUs.
1500
1651
 
1501
- **Usage Plan:**
1652
+ **Usage Plan:**
1502
1653
 
1503
- | Rate (requests per second) | Burst |
1504
- | ---- | ---- |
1505
- | 2 | 30 |
1654
+ | Rate (requests per second) | Burst |
1655
+ | ---- | ---- |
1656
+ | 2 | 30 |
1506
1657
 
1507
- 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 contains the default rate and burst values for this operation. Selling partners 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.
1508
- Args:
1658
+ 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 contains the default rate and burst values for this operation. Selling partners 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.
1659
+ Args:
1509
1660
 
1510
- height:number | *OPTIONAL The height of the item label.
1511
- labelType: | *RERQUIRED ndicates the type of print type for a given label.
1512
- localeCode:string | *OPTIONAL The locale code constructed from ISO 639 language code and ISO 3166-1 alpha-2 standard of country codes separated by an underscore character.
1513
- marketplaceId:string | *REQUIRED The marketplace ID.
1514
- mskuQuantities:array | *REQUIRED Represents the quantity of an MSKU to print item labels for.
1515
- pageType: | *OPTIONAL The page type to use to print the labels.
1516
- width:number | *OPTIONAL The width of the item label.
1661
+ height:number | *OPTIONAL The height of the item label.
1662
+ labelType: | *RERQUIRED ndicates the type of print type for a given label.
1663
+ localeCode:string | *OPTIONAL The locale code constructed from ISO 639 language code and ISO 3166-1 alpha-2 standard of country codes separated by an underscore character.
1664
+ marketplaceId:string | *REQUIRED The marketplace ID.
1665
+ mskuQuantities:array | *REQUIRED Represents the quantity of an MSKU to print item labels for.
1666
+ pageType: | *OPTIONAL The page type to use to print the labels.
1667
+ width:number | *OPTIONAL The width of the item label.
1517
1668
 
1518
- Returns:
1519
- ApiResponse:
1669
+ Returns:
1670
+ ApiResponse:
1520
1671
  """
1521
1672
 
1522
- return self._request(kwargs.pop('path'), data=kwargs)
1673
+ return self._request(kwargs.pop("path"), data=kwargs)
1523
1674
 
1524
- @sp_endpoint('/inbound/fba/<version>/items/prepDetails', method='GET')
1675
+ @sp_endpoint("/inbound/fba/<version>/items/prepDetails", method="GET")
1525
1676
  def list_prep_details(self, **kwargs) -> ApiResponse:
1526
1677
  """
1527
- list_prep_details(self, **kwargs) -> ApiResponse:
1678
+ list_prep_details(self, **kwargs) -> ApiResponse:
1528
1679
 
1529
- Get preparation details for a list of MSKUs in a specified marketplace.
1680
+ Get preparation details for a list of MSKUs in a specified marketplace.
1530
1681
 
1531
- **Usage Plan:**
1682
+ **Usage Plan:**
1532
1683
 
1533
- | Rate (requests per second) | Burst |
1534
- | ---- | ---- |
1535
- | 2 | 30 |
1684
+ | Rate (requests per second) | Burst |
1685
+ | ---- | ---- |
1686
+ | 2 | 30 |
1536
1687
 
1537
- 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 contains the default rate and burst values for this operation. Selling partners 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.
1538
- Args:
1539
- marketplaceId:string | *REQUIRED The marketplace ID.
1540
- mskus:array | *REQUIRED A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
1688
+ 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 contains the default rate and burst values for this operation. Selling partners 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.
1689
+ Args:
1690
+ marketplaceId:string | *REQUIRED The marketplace ID.
1691
+ mskus:array | *REQUIRED A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
1541
1692
 
1542
- Returns:
1543
- ApiResponse:
1693
+ Returns:
1694
+ ApiResponse:
1544
1695
  """
1545
1696
 
1546
- return self._request(kwargs.pop('path'), params=kwargs)
1697
+ return self._request(kwargs.pop("path"), params=kwargs)
1547
1698
 
1548
- @sp_endpoint('/inbound/fba/<version>/items/prepDetails', method='POST')
1699
+ @sp_endpoint("/inbound/fba/<version>/items/prepDetails", method="POST")
1549
1700
  def set_prep_details(self, **kwargs) -> ApiResponse:
1550
1701
  """
1551
- set_prep_details(self, **kwargs) -> ApiResponse:
1702
+ set_prep_details(self, **kwargs) -> ApiResponse:
1552
1703
 
1553
- Set the preparation details for a list of MSKUs in a specified marketplace.
1704
+ Set the preparation details for a list of MSKUs in a specified marketplace.
1554
1705
 
1555
- **Usage Plan:**
1706
+ **Usage Plan:**
1556
1707
 
1557
- | Rate (requests per second) | Burst |
1558
- | ---- | ---- |
1559
- | 2 | 30 |
1708
+ | Rate (requests per second) | Burst |
1709
+ | ---- | ---- |
1710
+ | 2 | 30 |
1560
1711
 
1561
- 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 contains the default rate and burst values for this operation. Selling partners 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.
1562
- Args:
1712
+ 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 contains the default rate and burst values for this operation. Selling partners 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.
1713
+ Args:
1563
1714
 
1564
- marketplaceId:string | *REQUIRED The marketplace ID.
1565
- mskuPrepDetails:array | *REQUIRED A list of MSKUs and related prep details.
1715
+ marketplaceId:string | *REQUIRED The marketplace ID.
1716
+ mskuPrepDetails:array | *REQUIRED A list of MSKUs and related prep details.
1566
1717
 
1567
- Returns:
1568
- ApiResponse:
1718
+ Returns:
1719
+ ApiResponse:
1720
+ """
1721
+
1722
+ return self._request(kwargs.pop("path"), data=kwargs)
1723
+
1724
+ @sp_endpoint(
1725
+ "/inbound/fba/<version>/inboundPlans/{}/shipments/{}/boxes", method="GET"
1726
+ )
1727
+ def list_shipment_boxes(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1728
+ """
1729
+ list_shipment_boxes(self, **kwargs) -> ApiResponse:
1730
+
1731
+ Provides a paginated list of box packages in a shipment.
1732
+
1733
+ **Usage Plan:**
1734
+
1735
+ | Rate (requests per second) | Burst |
1736
+ | ---- | ---- |
1737
+ | 2 | 30 |
1738
+
1739
+ 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 contains the default rate and burst values for this operation. Selling partners 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.
1740
+ Args:
1741
+
1742
+ pageSize:string | *OPTIONAL Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1743
+ paginationToken: | *OPTIONAL A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1744
+
1745
+ Returns:
1746
+ ApiResponse:
1569
1747
  """
1570
1748
 
1571
- return self._request(kwargs.pop('path'), data=kwargs)
1749
+ return self._request(
1750
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1751
+ params=kwargs,
1752
+ )
1753
+
1754
+ @sp_endpoint(
1755
+ "/inbound/fba/<version>/inboundPlans/{}/shipments/{}/trackingDetails",
1756
+ method="PUT",
1757
+ )
1758
+ def update_shipment_tracking_details(
1759
+ self, inboundPlanId, shipmentId, **kwargs
1760
+ ) -> ApiResponse:
1761
+ """
1762
+ update_shipment_tracking_details(self, **kwargs) -> ApiResponse:
1763
+
1764
+ Updates a shipment's tracking details.
1765
+
1766
+ **Usage Plan:**
1767
+
1768
+ | Rate (requests per second) | Burst |
1769
+ | ---- | ---- |
1770
+ | 2 | 2 |
1771
+
1772
+ 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 contains the default rate and burst values for this operation. Selling partners 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.
1773
+ Args:
1774
+
1775
+ body: | * REQUIRED {
1776
+ 'trackingDetails': [
1777
+ ltlTrackingDetail: [
1778
+ billOfLadingNumber: string,
1779
+ freightBillNumber: string<array>
1780
+ ],
1781
+ spdTrackingDetail: [
1782
+ spdTrackingItems:[
1783
+ boxId: string,
1784
+ trackingId: string,
1785
+ ]
1786
+ ],
1787
+ ],
1788
+ }
1572
1789
 
1790
+ Returns:
1791
+ ApiResponse:
1792
+ """
1793
+
1794
+ return self._request(
1795
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1796
+ data=kwargs,
1797
+ )