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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (214) hide show
  1. {python_amazon_sp_api-2.0.15.dist-info → python_amazon_sp_api-2.1.3.dist-info}/METADATA +7 -7
  2. python_amazon_sp_api-2.1.3.dist-info/RECORD +350 -0
  3. sp_api/__version__.py +1 -1
  4. sp_api/api/__init__.py +160 -4
  5. sp_api/api/amazon_warehousing_and_distribu/amazon_warehousing_and_distribu.py +85 -110
  6. sp_api/api/amazon_warehousing_and_distribu/amazon_warehousing_and_distribu_2024_05_09.py +456 -0
  7. sp_api/api/aplus_content/aplus_content.py +176 -125
  8. sp_api/api/application_integrations/application_integrations.py +59 -68
  9. sp_api/api/application_management/application_management.py +20 -13
  10. sp_api/api/authorization/authorization.py +8 -26
  11. sp_api/api/catalog/catalog.py +27 -61
  12. sp_api/api/catalog_items/catalog_items.py +108 -78
  13. sp_api/api/catalog_items/catalog_items_2020_12_01.py +86 -0
  14. sp_api/api/catalog_items/catalog_items_2022_04_01.py +89 -0
  15. sp_api/api/customer_feedback/customer_feedback.py +100 -0
  16. sp_api/api/data_kiosk/data_kiosk.py +80 -75
  17. sp_api/api/delivery_by_amazon/__init__.py +0 -0
  18. sp_api/api/delivery_by_amazon/delivery_by_amazon.py +92 -0
  19. sp_api/api/delivery_by_amazon/delivery_by_amazon_2022_07_01.py +81 -0
  20. sp_api/api/easy_ship/easy_ship.py +121 -111
  21. sp_api/api/external_fulfillment/external_fulfillment.py +211 -434
  22. sp_api/api/external_fulfillment/inventory.py +120 -0
  23. sp_api/api/external_fulfillment/inventory_2021_01_06.py +71 -0
  24. sp_api/api/external_fulfillment/inventory_2024_09_11.py +96 -0
  25. sp_api/api/external_fulfillment/returns.py +120 -0
  26. sp_api/api/external_fulfillment/returns_2021_08_19.py +88 -0
  27. sp_api/api/external_fulfillment/returns_2024_09_11.py +141 -0
  28. sp_api/api/external_fulfillment/shipping.py +120 -0
  29. sp_api/api/external_fulfillment/shipping_2021_01_06.py +256 -0
  30. sp_api/api/external_fulfillment/shipping_2024_09_11.py +233 -0
  31. sp_api/api/fba_inbound_eligibility/fba_inbound_eligibility.py +30 -24
  32. sp_api/api/fba_small_and_light/fba_small_and_light.py +60 -99
  33. sp_api/api/feeds/feeds.py +75 -245
  34. sp_api/api/feeds/feeds_2021_06_30.py +320 -0
  35. sp_api/api/finances/finances.py +123 -90
  36. sp_api/api/finances/finances_2024_06_01.py +71 -0
  37. sp_api/api/finances/finances_2024_06_19.py +114 -0
  38. sp_api/api/finances/finances_v0.py +116 -0
  39. sp_api/api/fulfillment_inbound/fulfillment_inbound.py +107 -1784
  40. sp_api/api/fulfillment_inbound/fulfillment_inbound_2024_03_20.py +1722 -0
  41. sp_api/api/fulfillment_inbound/fulfillment_inbound_v0.py +1384 -0
  42. sp_api/api/fulfillment_outbound/fulfillment_outbound.py +256 -480
  43. sp_api/api/inventories/inventories.py +79 -42
  44. sp_api/api/invoices/__init__.py +0 -0
  45. sp_api/api/invoices/invoices.py +92 -0
  46. sp_api/api/invoices/invoices_2024_06_19.py +344 -0
  47. sp_api/api/listings_items/listings_items.py +110 -163
  48. sp_api/api/listings_items/listings_items_2020_09_01.py +189 -0
  49. sp_api/api/listings_items/listings_items_2021_08_01.py +233 -0
  50. sp_api/api/listings_restrictions/listings_restrictions.py +23 -10
  51. sp_api/api/merchant_fulfillment/merchant_fulfillment.py +107 -222
  52. sp_api/api/messaging/messaging.py +184 -198
  53. sp_api/api/notifications/notifications.py +144 -106
  54. sp_api/api/orders/orders.py +9 -46
  55. sp_api/api/orders/orders_2026_01_01.py +19 -65
  56. sp_api/api/orders/orders_v0.py +152 -184
  57. sp_api/api/product_fees/product_fees.py +101 -75
  58. sp_api/api/product_type_definitions/product_type_definitions.py +47 -36
  59. sp_api/api/products/products.py +94 -386
  60. sp_api/api/products/products_2022_05_01.py +96 -0
  61. sp_api/api/products/products_v0.py +389 -0
  62. sp_api/api/replenishment/replenishment.py +58 -69
  63. sp_api/api/reports/reports.py +124 -157
  64. sp_api/api/sales/sales.py +22 -39
  65. sp_api/api/seller_wallet/__init__.py +0 -0
  66. sp_api/api/seller_wallet/seller_wallet.py +92 -0
  67. sp_api/api/seller_wallet/seller_wallet_2024_03_01.py +300 -0
  68. sp_api/api/sellers/sellers.py +15 -35
  69. sp_api/api/services/services.py +479 -82
  70. sp_api/api/shipment_invoicing/__init__.py +0 -0
  71. sp_api/api/shipment_invoicing/shipment_invoicing.py +92 -0
  72. sp_api/api/shipment_invoicing/shipment_invoicing_v0.py +101 -0
  73. sp_api/api/shipping/shipping.py +94 -440
  74. sp_api/api/shipping/shippingV2.py +183 -474
  75. sp_api/api/shipping/shipping_v1.py +330 -0
  76. sp_api/api/shipping/shipping_v2.py +723 -0
  77. sp_api/api/solicitations/solicitations.py +28 -18
  78. sp_api/api/supply_sources/supply_sources.py +67 -57
  79. sp_api/api/tokens/tokens.py +14 -35
  80. sp_api/api/vehicles/__init__.py +0 -0
  81. sp_api/api/vehicles/vehicles.py +92 -0
  82. sp_api/api/vehicles/vehicles_2024_11_01.py +33 -0
  83. sp_api/api/vendor_direct_fulfillment_inventory/vendor_direct_fulfillment_inventory.py +16 -29
  84. sp_api/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders.py +116 -189
  85. sp_api/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders_2021_12_28.py +114 -0
  86. sp_api/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders_v1.py +114 -0
  87. sp_api/api/vendor_direct_fulfillment_payments/vendor_direct_fulfillment_payments.py +15 -225
  88. sp_api/api/vendor_direct_fulfillment_sandbox_test_data/__init__.py +0 -0
  89. sp_api/api/vendor_direct_fulfillment_sandbox_test_data/vendor_direct_fulfillment_sandbox_test_data.py +92 -0
  90. sp_api/api/vendor_direct_fulfillment_sandbox_test_data/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.py +50 -0
  91. sp_api/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping.py +122 -624
  92. sp_api/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping_2021_12_28.py +390 -0
  93. sp_api/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping_v1.py +320 -0
  94. sp_api/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions.py +113 -29
  95. sp_api/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions_2021_12_28.py +47 -0
  96. sp_api/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions_v1.py +47 -0
  97. sp_api/api/vendor_invoices/vendor_invoices.py +15 -264
  98. sp_api/api/vendor_orders/vendor_orders.py +83 -131
  99. sp_api/api/vendor_shipments/vendor_shipments.py +149 -68
  100. sp_api/api/vendor_transaction_status/vendor_transaction_status.py +16 -11
  101. sp_api/asyncio/api/__init__.py +159 -4
  102. sp_api/asyncio/api/amazon_warehousing_and_distribu/amazon_warehousing_and_distribu.py +84 -110
  103. sp_api/asyncio/api/amazon_warehousing_and_distribu/amazon_warehousing_and_distribu_2024_05_09.py +457 -0
  104. sp_api/asyncio/api/aplus_content/aplus_content.py +176 -125
  105. sp_api/asyncio/api/application_integrations/application_integrations.py +59 -68
  106. sp_api/asyncio/api/application_management/application_management.py +20 -13
  107. sp_api/asyncio/api/authorization/authorization.py +8 -26
  108. sp_api/asyncio/api/catalog/catalog.py +27 -61
  109. sp_api/asyncio/api/catalog_items/catalog_items.py +94 -71
  110. sp_api/asyncio/api/catalog_items/catalog_items_2020_12_01.py +87 -0
  111. sp_api/asyncio/api/catalog_items/catalog_items_2022_04_01.py +90 -0
  112. sp_api/asyncio/api/customer_feedback/customer_feedback.py +100 -0
  113. sp_api/asyncio/api/data_kiosk/data_kiosk.py +80 -75
  114. sp_api/asyncio/api/delivery_by_amazon/__init__.py +0 -0
  115. sp_api/asyncio/api/delivery_by_amazon/delivery_by_amazon.py +92 -0
  116. sp_api/asyncio/api/delivery_by_amazon/delivery_by_amazon_2022_07_01.py +82 -0
  117. sp_api/asyncio/api/easy_ship/easy_ship.py +121 -111
  118. sp_api/asyncio/api/external_fulfillment/external_fulfillment.py +212 -435
  119. sp_api/asyncio/api/external_fulfillment/inventory.py +126 -0
  120. sp_api/asyncio/api/external_fulfillment/inventory_2021_01_06.py +73 -0
  121. sp_api/asyncio/api/external_fulfillment/inventory_2024_09_11.py +98 -0
  122. sp_api/asyncio/api/external_fulfillment/returns.py +124 -0
  123. sp_api/asyncio/api/external_fulfillment/returns_2021_08_19.py +90 -0
  124. sp_api/asyncio/api/external_fulfillment/returns_2024_09_11.py +143 -0
  125. sp_api/asyncio/api/external_fulfillment/shipping.py +124 -0
  126. sp_api/asyncio/api/external_fulfillment/shipping_2021_01_06.py +258 -0
  127. sp_api/asyncio/api/external_fulfillment/shipping_2024_09_11.py +235 -0
  128. sp_api/asyncio/api/fba_inbound_eligibility/fba_inbound_eligibility.py +31 -25
  129. sp_api/asyncio/api/fba_small_and_light/fba_small_and_light.py +61 -100
  130. sp_api/asyncio/api/feeds/feeds.py +75 -243
  131. sp_api/asyncio/api/feeds/feeds_2021_06_30.py +318 -0
  132. sp_api/asyncio/api/finances/finances.py +123 -91
  133. sp_api/asyncio/api/finances/finances_2024_06_01.py +72 -0
  134. sp_api/asyncio/api/finances/finances_2024_06_19.py +115 -0
  135. sp_api/asyncio/api/finances/finances_v0.py +117 -0
  136. sp_api/asyncio/api/fulfillment_inbound/fulfillment_inbound.py +107 -1785
  137. sp_api/asyncio/api/fulfillment_inbound/fulfillment_inbound_2024_03_20.py +1723 -0
  138. sp_api/asyncio/api/fulfillment_inbound/fulfillment_inbound_v0.py +1385 -0
  139. sp_api/asyncio/api/fulfillment_outbound/fulfillment_outbound.py +257 -481
  140. sp_api/asyncio/api/inventories/inventories.py +79 -42
  141. sp_api/asyncio/api/invoices/__init__.py +0 -0
  142. sp_api/asyncio/api/invoices/invoices.py +92 -0
  143. sp_api/asyncio/api/invoices/invoices_2024_06_19.py +345 -0
  144. sp_api/asyncio/api/listings_items/listings_items.py +109 -163
  145. sp_api/asyncio/api/listings_items/listings_items_2020_09_01.py +190 -0
  146. sp_api/asyncio/api/listings_items/listings_items_2021_08_01.py +233 -0
  147. sp_api/asyncio/api/listings_restrictions/listings_restrictions.py +23 -10
  148. sp_api/asyncio/api/merchant_fulfillment/merchant_fulfillment.py +110 -222
  149. sp_api/asyncio/api/messaging/messaging.py +185 -199
  150. sp_api/asyncio/api/notifications/notifications.py +145 -107
  151. sp_api/asyncio/api/orders/orders.py +9 -46
  152. sp_api/asyncio/api/orders/orders_2026_01_01.py +19 -65
  153. sp_api/asyncio/api/orders/orders_v0.py +152 -184
  154. sp_api/asyncio/api/product_fees/product_fees.py +101 -75
  155. sp_api/asyncio/api/product_type_definitions/product_type_definitions.py +47 -36
  156. sp_api/asyncio/api/products/products.py +94 -387
  157. sp_api/asyncio/api/products/products_2022_05_01.py +109 -0
  158. sp_api/asyncio/api/products/products_v0.py +388 -0
  159. sp_api/asyncio/api/replenishment/replenishment.py +59 -70
  160. sp_api/asyncio/api/reports/reports.py +124 -157
  161. sp_api/asyncio/api/sales/sales.py +22 -39
  162. sp_api/asyncio/api/seller_wallet/__init__.py +0 -0
  163. sp_api/asyncio/api/seller_wallet/seller_wallet.py +92 -0
  164. sp_api/asyncio/api/seller_wallet/seller_wallet_2024_03_01.py +301 -0
  165. sp_api/asyncio/api/sellers/sellers.py +16 -36
  166. sp_api/asyncio/api/services/services.py +479 -82
  167. sp_api/asyncio/api/shipment_invoicing/__init__.py +0 -0
  168. sp_api/asyncio/api/shipment_invoicing/shipment_invoicing.py +92 -0
  169. sp_api/asyncio/api/shipment_invoicing/shipment_invoicing_v0.py +102 -0
  170. sp_api/asyncio/api/shipping/shipping.py +94 -441
  171. sp_api/asyncio/api/shipping/shippingV2.py +181 -472
  172. sp_api/asyncio/api/shipping/shipping_v1.py +331 -0
  173. sp_api/asyncio/api/shipping/shipping_v2.py +717 -0
  174. sp_api/asyncio/api/solicitations/solicitations.py +29 -19
  175. sp_api/asyncio/api/supply_sources/supply_sources.py +67 -57
  176. sp_api/asyncio/api/tokens/tokens.py +14 -35
  177. sp_api/asyncio/api/vehicles/__init__.py +0 -0
  178. sp_api/asyncio/api/vehicles/vehicles.py +92 -0
  179. sp_api/asyncio/api/vehicles/vehicles_2024_11_01.py +34 -0
  180. sp_api/asyncio/api/vendor_direct_fulfillment_inventory/vendor_direct_fulfillment_inventory.py +16 -29
  181. sp_api/asyncio/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders.py +120 -192
  182. sp_api/asyncio/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders_2021_12_28.py +116 -0
  183. sp_api/asyncio/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders_v1.py +115 -0
  184. sp_api/asyncio/api/vendor_direct_fulfillment_payments/vendor_direct_fulfillment_payments.py +15 -225
  185. sp_api/asyncio/api/vendor_direct_fulfillment_sandbox_test_data/__init__.py +0 -0
  186. sp_api/asyncio/api/vendor_direct_fulfillment_sandbox_test_data/vendor_direct_fulfillment_sandbox_test_data.py +92 -0
  187. sp_api/asyncio/api/vendor_direct_fulfillment_sandbox_test_data/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.py +51 -0
  188. sp_api/asyncio/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping.py +120 -623
  189. sp_api/asyncio/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping_2021_12_28.py +392 -0
  190. sp_api/asyncio/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping_v1.py +321 -0
  191. sp_api/asyncio/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions.py +112 -29
  192. sp_api/asyncio/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions_2021_12_28.py +49 -0
  193. sp_api/asyncio/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions_v1.py +48 -0
  194. sp_api/asyncio/api/vendor_invoices/vendor_invoices.py +16 -265
  195. sp_api/asyncio/api/vendor_orders/vendor_orders.py +84 -132
  196. sp_api/asyncio/api/vendor_shipments/vendor_shipments.py +150 -69
  197. sp_api/asyncio/api/vendor_transaction_status/vendor_transaction_status.py +17 -12
  198. sp_api/asyncio/base/client.py +2 -2
  199. sp_api/asyncio/util/load_date_bound.py +1 -1
  200. sp_api/base/__init__.py +10 -0
  201. sp_api/base/_core.py +2 -2
  202. sp_api/base/client.py +3 -3
  203. sp_api/base/helpers.py +12 -1
  204. sp_api/base/marketplaces.py +6 -3
  205. sp_api/util/__init__.py +2 -0
  206. sp_api/util/load_date_bound.py +1 -1
  207. sp_api/util/versioned_client.py +45 -0
  208. python_amazon_sp_api-2.0.15.dist-info/RECORD +0 -255
  209. sp_api/asyncio/api/models/__init__.py +0 -4
  210. sp_api/asyncio/api/overrides/__init__.py +0 -1
  211. {python_amazon_sp_api-2.0.15.data → python_amazon_sp_api-2.1.3.data}/scripts/make_endpoint +0 -0
  212. {python_amazon_sp_api-2.0.15.dist-info → python_amazon_sp_api-2.1.3.dist-info}/WHEEL +0 -0
  213. {python_amazon_sp_api-2.0.15.dist-info → python_amazon_sp_api-2.1.3.dist-info}/licenses/LICENSE +0 -0
  214. {python_amazon_sp_api-2.0.15.dist-info → python_amazon_sp_api-2.1.3.dist-info}/top_level.txt +0 -0
@@ -1,10 +1,13 @@
1
+ from __future__ import annotations
2
+
1
3
  import enum
4
+ from typing import Any, Literal, TYPE_CHECKING, overload
5
+ from sp_api.util.versioned_client import VersionedClientMeta
2
6
 
3
- from sp_api.base import Client, Marketplaces, ApiResponse
4
- from sp_api.base import sp_endpoint, fill_query_params
7
+ from sp_api.base import Client
5
8
 
6
- import urllib.parse
7
- from sp_api.util import ensure_csv
9
+ from .fulfillment_inbound_2024_03_20 import FulfillmentInboundV20240320
10
+ from .fulfillment_inbound_v0 import FulfillmentInboundV0
8
11
 
9
12
 
10
13
  class FulfillmentInboundVersion(str, enum.Enum):
@@ -13,1785 +16,105 @@ class FulfillmentInboundVersion(str, enum.Enum):
13
16
  LATEST = "2024-03-20"
14
17
 
15
18
 
16
- class FulfillmentInbound(Client):
17
- """
18
- FulfillmentInbound SP-API Client
19
- :link:
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.
19
+ if TYPE_CHECKING:
20
+
21
+ class _FulfillmentInboundMeta(VersionedClientMeta):
22
+ @overload
23
+ def __call__(
24
+ cls,
25
+ *args: Any,
26
+ version: Literal[
27
+ FulfillmentInboundVersion.V_2024_03_20,
28
+ FulfillmentInboundVersion.LATEST,
29
+ "2024-03-20",
30
+ ],
31
+ **kwargs: Any,
32
+ ) -> FulfillmentInboundV20240320: ...
33
+
34
+ @overload
35
+ def __call__(
36
+ cls,
37
+ *args: Any,
38
+ version: Literal[FulfillmentInboundVersion.V_v0, "v0"],
39
+ **kwargs: Any,
40
+ ) -> FulfillmentInboundV0: ...
41
+
42
+ @overload
43
+ def __call__(
44
+ cls,
45
+ *args: Any,
46
+ version: None = None,
47
+ **kwargs: Any,
48
+ ) -> FulfillmentInboundV0: ...
49
+
50
+ @overload
51
+ def __call__(
52
+ cls,
53
+ *args: Any,
54
+ version: str | FulfillmentInboundVersion,
55
+ **kwargs: Any,
56
+ ) -> Client: ...
57
+
58
+
59
+ else:
60
+ _FulfillmentInboundMeta = VersionedClientMeta
61
+
62
+
63
+ class FulfillmentInbound(Client, metaclass=_FulfillmentInboundMeta):
64
+ """Fulfillment Inbound API client.
65
+
66
+ This class dispatches to a versioned Fulfillment Inbound API client.
67
+
68
+ If you do not pass a version, the constructor returns the oldest supported implementation ("v0").
22
69
  """
23
70
 
24
- version: FulfillmentInboundVersion = FulfillmentInboundVersion.V_v0
25
-
26
- def __init__(self, *args, **kwargs):
27
- if "version" in kwargs:
28
- self.version = kwargs.get("version", FulfillmentInboundVersion.V_v0)
29
- super().__init__(*args, **{**kwargs, "version": self.version})
30
-
31
- @sp_endpoint("/fba/inbound/<version>/itemsGuidance")
32
- def item_guidance(self, **kwargs):
33
- """
34
- item_guidance(self, **kwargs) -> ApiResponse
35
-
36
- Examples:
37
- literal blocks::
38
-
39
- FulfillmentInbound().item_guidance(**{"MarkeplaceId": "US", "ASINList": ["ASIN1"]})
40
-
41
- Args:
42
- **kwargs:
43
-
44
- Returns:
45
- ApiResponse
46
- """
47
- return self._request(kwargs.pop("path"), params=kwargs)
48
-
49
- @sp_endpoint("/fba/inbound/<version>/plans", method="POST")
50
- def plans(self, data, **kwargs):
51
- """
52
- plans(self, data, **kwargs) -> ApiResponse
53
-
54
- Examples:
55
- literal blocks::
56
-
57
- res = FulfillmentInbound().plans({
58
- "ShipFromAddress": {
59
- "Name": "Name",
60
- "AddressLine1": "123 any st",
61
- "AddressLine2": "AddressLine2",
62
- "DistrictOrCounty": "Washtenaw",
63
- "City": "Ann Arbor",
64
- "StateOrProvinceCode": "MI",
65
- "CountryCode": "US",
66
- "PostalCode": "48188"
67
- },
68
- "LabelPrepPreference": "SELLER_LABEL",
69
- "ShipToCountryCode": "ShipToCountryCode",
70
- "ShipToCountrySubdivisionCode": "ShipToCountrySubdivisionCode",
71
- "InboundShipmentPlanRequestItems": [
72
- {
73
- "SellerSKU": "SellerSKU",
74
- "ASIN": "ASIN",
75
- "Condition": "NewItem",
76
- "Quantity": 1,
77
- "QuantityInCase": 1,
78
- "PrepDetailsList": [
79
- {
80
- "PrepInstruction": "Polybagging",
81
- "PrepOwner": "AMAZON"
82
- }
83
- ]
84
- }
85
- ]
86
- })
87
-
88
- Args:
89
- data:
90
- **kwargs:
91
-
92
- Returns:
93
- ApiResponse
94
- """
95
- return self._request(kwargs.pop("path"), data={**data, **kwargs})
96
-
97
- @sp_endpoint("/fba/inbound/<version>/shipments/{}", method="POST")
98
- def create_shipment(self, shipment_id, data, **kwargs):
99
- """
100
- create_shipment(self, shipment_id, data, **kwargs)
101
-
102
- Examples:
103
- literal blocks::
104
-
105
- FulfillmentInbound().create_shipment('123', {
106
- "InboundShipmentHeader": {
107
- "ShipmentName": "43545345",
108
- "ShipFromAddress": {
109
- "Name": "35435345",
110
- "AddressLine1": "123 any st",
111
- "DistrictOrCounty": "Washtenaw",
112
- "City": "Ann Arbor",
113
- "StateOrProvinceCode": "Test",
114
- "CountryCode": "US",
115
- "PostalCode": "48103"
116
- },
117
- "DestinationFulfillmentCenterId": "AEB2",
118
- "AreCasesRequired": True,
119
- "ShipmentStatus": "WORKING",
120
- "LabelPrepPreference": "SELLER_LABEL",
121
- "IntendedBoxContentsSource": "NONE"
122
- },
123
- "InboundShipmentItems": [
124
- {
125
- "ShipmentId": "345453",
126
- "SellerSKU": "34534545",
127
- "FulfillmentNetworkSKU": "435435435",
128
- "QuantityShipped": 0,
129
- "QuantityReceived": 0,
130
- "QuantityInCase": 0,
131
- "ReleaseDate": "2020-04-23",
132
- "PrepDetailsList": [
133
- {
134
- "PrepInstruction": "Polybagging",
135
- "PrepOwner": "AMAZON"
136
- }
137
- ]
138
- }
139
- ],
140
- "MarketplaceId": "MarketplaceId"
141
- })
142
-
143
- Args:
144
- shipment_id:
145
- data:
146
- **kwargs:
147
-
148
- Returns:
149
- ApiResponse
150
- """
151
- return self._request(
152
- fill_query_params(kwargs.pop("path"), shipment_id), data={**data, **kwargs}
153
- )
154
-
155
- @sp_endpoint("/fba/inbound/<version>/shipments/{}", method="PUT")
156
- def update_shipment(self, shipment_id, data, **kwargs):
157
- """
158
- update_shipment(self, shipment_id, data, **kwargs) -> ApiResponse
159
-
160
- Examples:
161
- literal blocks::
162
-
163
- FulfillmentInbound().update_shipment('123', {
164
- "MarketplaceId": "ATVPDKIKX0DER",
165
- "InboundShipmentHeader": {
166
- "ShipmentName": "Shipment for FBA15DJCQ1ZF",
167
- "ShipFromAddress": {
168
- "Name": "Uma Test",
169
- "AddressLine1": "123 any st",
170
- "AddressLine2": "",
171
- "DistrictOrCounty": "Washtenaw",
172
- "City": "Ann Arbor",
173
- "StateOrProvinceCode": "CO",
174
- "CountryCode": "US",
175
- "PostalCode": "48104"
176
- },
177
- "DestinationFulfillmentCenterId": "ABE2",
178
- "ShipmentStatus": "WORKING",
179
- "LabelPrepPreference": "SELLER_LABEL"
180
- },
181
- "InboundShipmentItems": [
182
- {
183
- "SellerSKU": "PSMM-TEST-SKU-Apr-03_21_17_20-0379",
184
- "QuantityShipped": 1
185
- }
186
- ]
187
- })
188
-
189
- Args:
190
- shipment_id:
191
- data:
192
- **kwargs:
193
-
194
- Returns:
195
- ApiResponse
196
- """
197
- return self._request(
198
- fill_query_params(kwargs.pop("path"), shipment_id), data={**data, **kwargs}
199
- )
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
-
234
- @sp_endpoint("/fba/inbound/<version>/shipments/{}/preorder")
235
- def preorder(self, shipment_id, **kwargs):
236
- """
237
- preorder(self, shipment_id, **kwargs) -> ApiResponse
238
-
239
- Examples:
240
- literal blocks::
241
-
242
- FulfillmentInbound().preorder('shipmentId1', MarketplaceId='MarketplaceId1')
243
-
244
- Args:
245
- shipment_id:
246
- **kwargs:
247
-
248
- Returns:
249
- ApiResponse
250
- """
251
- return self._request(
252
- fill_query_params(kwargs.pop("path"), shipment_id), params=kwargs
253
- )
254
-
255
- @sp_endpoint("/fba/inbound/<version>/shipments/{}/preorder/confirm", method="PUT")
256
- def confirm_preorder(self, shipment_id, **kwargs):
257
- """
258
- confirm_preorder(self, shipment_id, **kwargs)
259
-
260
- Args:
261
- shipment_id:
262
- **kwargs:
263
-
264
- Returns:
265
-
266
- """
267
- return self._request(
268
- fill_query_params(kwargs.pop("path"), shipment_id), params=kwargs
269
- )
270
-
271
- @sp_endpoint("/fba/inbound/<version>/prepInstructions")
272
- def prep_instruction(self, data, **kwargs):
273
- """
274
- prep_instruction(self, data, **kwargs) -> ApiResponse
275
-
276
- Examples:
277
- literal blocks::
278
-
279
- FulfillmentInbound().prep_instruction({"ShipToCountryCode": "US", "ASINList": ["ASIN1"]})
280
-
281
- Args:
282
- data:
283
- **kwargs:
284
-
285
- Returns:
286
- ApiResponse
287
- """
288
- return self._request(kwargs.pop("path"), params={**data, **kwargs})
289
-
290
- @sp_endpoint("/fba/inbound/<version>/shipments/{}/transport")
291
- def get_transport_information(self, shipment_id, **kwargs):
292
- """
293
- get_transport_information(self, shipment_id, **kwargs) -> ApiResponse
294
-
295
- Examples:
296
- literal blocks::
297
-
298
- FulfillmentInbound().get_transport_information('shipmentId1')
299
-
300
- Args:
301
- shipment_id:
302
- **kwargs:
303
-
304
- Returns:
305
- ApiResponse
306
- """
307
- return self._request(
308
- fill_query_params(kwargs.pop("path"), shipment_id), params=kwargs
309
- )
310
-
311
- @sp_endpoint("/fba/inbound/<version>/shipments/{}/transport", method="PUT")
312
- def update_transport_information(self, shipment_id, **kwargs):
313
- """
314
- update_transport_information(self, shipment_id, **kwargs) -> ApiResponse
315
-
316
- putTransportDetails
317
-
318
- Args:
319
- shipment_id:
320
- **kwargs:
321
-
322
- Returns:
323
- ApiResponse
324
- """
325
- return self._request(
326
- fill_query_params(kwargs.pop("path"), shipment_id), data=kwargs
327
- )
328
-
329
- @sp_endpoint("/fba/inbound/<version>/shipments/{}/transport/void", method="POST")
330
- def void_transport(self, shipment_id, **kwargs):
331
- """
332
- void_transport(self, shipment_id, **kwargs) -> ApiResponse
333
-
334
- Examples:
335
- literal blocks::
336
-
337
- FulfillmentInbound().void_transport('shipmentId1')
338
-
339
- Args:
340
- shipment_id:
341
- **kwargs:
342
-
343
- Returns:
344
- ApiResponse
345
- """
346
- return self._request(
347
- fill_query_params(kwargs.pop("path"), shipment_id),
348
- data=kwargs,
349
- add_marketplace=False,
350
- )
351
-
352
- @sp_endpoint(
353
- "/fba/inbound/<version>/shipments/{}/transport/estimate", method="POST"
354
- )
355
- def estimate_transport(self, shipment_id, **kwargs):
356
- """
357
- estimate_transport(self, shipment_id, **kwargs) -> ApiResponse
358
-
359
- Examples:
360
- literal blocks::
361
-
362
- FulfillmentInbound().estimate_transport('shipmentId1')
363
-
364
- Args:
365
- shipment_id:
366
- **kwargs:
367
-
368
- Returns:
369
- ApiResponse
370
- """
371
- return self._request(
372
- fill_query_params(kwargs.pop("path"), shipment_id),
373
- data=kwargs,
374
- add_marketplace=False,
375
- )
376
-
377
- @sp_endpoint("/fba/inbound/<version>/shipments/{}/transport/confirm", method="POST")
378
- def confirm_transport(self, shipment_id, **kwargs):
379
- return self._request(
380
- fill_query_params(kwargs.pop("path"), shipment_id),
381
- data=kwargs,
382
- add_marketplace=False,
383
- )
384
-
385
- @sp_endpoint("/fba/inbound/<version>/shipments/{}/labels")
386
- def get_labels(self, shipment_id, **kwargs):
387
- """
388
- get_labels(self, shipment_id, **kwargs)
389
-
390
- Args:
391
- shipment_id:
392
- **kwargs:
393
-
394
- Returns:
395
-
396
- """
397
- return self._request(
398
- fill_query_params(kwargs.pop("path"), shipment_id),
399
- params=kwargs,
400
- add_marketplace=False,
401
- )
402
-
403
- @sp_endpoint("/fba/inbound/<version>/shipments/{}/billOfLading")
404
- def bill_of_lading(self, shipment_id, **kwargs):
405
- """
406
- bill_of_lading(self, shipment_id, **kwargs) -> ApiResponse
407
-
408
- Examples:
409
- literal blocks::
410
-
411
- FulfillmentInbound().bill_of_lading('shipmentId')
412
-
413
- Args:
414
- shipment_id:
415
- **kwargs:
416
-
417
- Returns:
418
- ApiResponse
419
- """
420
- return self._request(
421
- fill_query_params(kwargs.pop("path"), shipment_id), params=kwargs
422
- )
423
-
424
- @sp_endpoint("/fba/inbound/<version>/shipments")
425
- def get_shipments(self, **kwargs):
426
- """
427
- get_shipments(self, **kwargs) -> ApiResponse
428
-
429
- Examples:
430
- literal blocks::
431
-
432
- FulfillmentInbound().get_shipments(QueryType='SHIPMENT', MarketplaceId="ATVPDKIKX0DER")
433
-
434
- Args:
435
- **kwargs:
436
-
437
- Returns:
438
- ApiResponse
439
- """
440
- return self._request(kwargs.pop("path"), params=kwargs)
441
-
442
- @sp_endpoint("/fba/inbound/<version>/shipments/{}/items")
443
- def shipment_items_by_shipment(self, shipment_id, **kwargs):
444
- """
445
- shipment_items_by_shipment(self, shipment_id, **kwargs) -> ApiResponse
446
-
447
- Examples:
448
- literal blocks::
449
-
450
- FulfillmentInbound().shipment_items_by_shipment('FBA15DJ9SVVD', MarketplaceId="ATVPDKIKX0DER")
451
-
452
- Args:
453
- shipment_id:
454
- **kwargs:
455
-
456
- Returns:
457
- ApiResponse
458
- """
459
- return self._request(
460
- fill_query_params(kwargs.pop("path"), shipment_id), params=kwargs
461
- )
462
-
463
- @sp_endpoint("/fba/inbound/<version>/shipmentItems")
464
- def shipment_items(self, **kwargs):
465
- """
466
- shipment_items(self, **kwargs) -> ApiResponse
467
-
468
- Examples:
469
- literal blocks::
470
-
471
- FulfillmentInbound().shipment_items(QueryType='SHIPMENT', MarketplaceId="ATVPDKIKX0DER", NextToken='NextToken')
472
-
473
- Args:
474
- **kwargs:
475
-
476
- Returns:
477
- ApiResponse
478
- """
479
- return self._request(kwargs.pop("path"), params=kwargs)
480
-
481
- def get_shipments_by_id(self, shipment_id_list, **kwargs) -> ApiResponse:
482
- """
483
- get_shipments_by_id(self, shipment_id_list, **kwargs) -> ApiResponse
484
-
485
- FulfillmentInbound().get_shipments_by_id('FBA16TBYQ6J6')
486
- Args:
487
- shipment_id_list: str or [str]
488
- **kwargs:
489
-
490
- Returns:
491
- ApiResponse
492
- """
493
- shipment_id_list = ensure_csv(shipment_id_list)
494
- return self.get_shipments(
495
- QueryType="SHIPMENT", ShipmentIdList=shipment_id_list, **kwargs
496
- )
497
-
498
- # 2024-03-20 API
499
- @sp_endpoint("/inbound/fba/<version>/inboundPlans", method="GET")
500
- def list_inbound_plans(self, **kwargs) -> ApiResponse:
501
- """
502
- list_inbound_plans(self, **kwargs) -> ApiResponse
503
-
504
- Provides a list of inbound plans with minimal information.
505
-
506
- **Usage Plan:**
507
-
508
- | Rate (requests per second) | Burst |
509
- | ---- | ---- |
510
- | 1 | 1 |
511
-
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).
513
-
514
- Args:
515
-
516
- key pageSize:integer | The number of inbound plans to return in the response matching the given query.
517
-
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.
519
-
520
- key status:string | The status of an inbound plan.
521
-
522
- key sortBy:string | Sort by field.
523
-
524
- key sortOrder:string | The sort order.
525
-
526
-
527
- Returns:
528
- ApiResponse:
529
- """
530
-
531
- return self._request(kwargs.pop("path"), params=kwargs)
532
-
533
- @sp_endpoint("/inbound/fba/<version>/inboundPlans", method="POST")
534
- def create_inbound_plan(self, **kwargs) -> ApiResponse:
535
- """
536
- create_inbound_plan(self, **kwargs) -> ApiResponse
537
-
538
- Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon's fufillment network.
539
-
540
- **Usage Plan:**
541
-
542
- | Rate (requests per second) | Burst |
543
- | ---- | ---- |
544
- | 0.05 | 1 |
545
-
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).
547
-
548
- Args:
549
-
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'}
570
-
571
-
572
- Returns:
573
- ApiResponse:
574
- """
575
-
576
- return self._request(kwargs.pop("path"), data=kwargs)
577
-
578
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}", method="GET")
579
- def get_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse:
580
- """
581
- get_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse
582
-
583
- Fetches the top level information about an inbound plan.
584
-
585
- **Usage Plan:**
586
-
587
- | Rate (requests per second) | Burst |
588
- | ---- | ---- |
589
- | 1 | 1 |
590
-
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).
592
-
593
- Args:
594
-
595
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
596
-
597
-
598
- Returns:
599
- ApiResponse:
600
- """
601
-
602
- return self._request(
603
- fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
604
- )
605
-
606
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/boxes", method="GET")
607
- def list_inbound_plan_boxes(self, inboundPlanId, **kwargs) -> ApiResponse:
608
- """
609
- list_inbound_plan_boxes(self, inboundPlanId, **kwargs) -> ApiResponse
610
-
611
- Provides a paginated list of box packages in an inbound plan.
612
-
613
- **Usage Plan:**
614
-
615
- | Rate (requests per second) | Burst |
616
- | ---- | ---- |
617
- | 1 | 1 |
618
-
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).
620
-
621
- Args:
622
-
623
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
624
-
625
- key pageSize:integer | The number of boxes to return in the response matching the given query.
626
-
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.
628
-
629
-
630
- Returns:
631
- ApiResponse:
632
- """
633
-
634
- return self._request(
635
- fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
636
- )
637
-
638
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/cancellation", method="PUT")
639
- def cancel_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse:
640
- """
641
- cancel_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse
642
-
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.
645
-
646
- **Usage Plan:**
647
-
648
- | Rate (requests per second) | Burst |
649
- | ---- | ---- |
650
- | 0.05 | 1 |
651
-
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).
653
-
654
- Args:
655
-
656
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
657
-
658
-
659
- Returns:
660
- ApiResponse:
661
- """
662
-
663
- return self._request(
664
- fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
665
- )
666
-
667
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/items", method="GET")
668
- def list_inbound_plan_items(self, inboundPlanId, **kwargs) -> ApiResponse:
669
- """
670
- list_inbound_plan_items(self, inboundPlanId, **kwargs) -> ApiResponse
671
-
672
- Provides a paginated list of item packages in an inbound plan.
673
-
674
- **Usage Plan:**
675
-
676
- | Rate (requests per second) | Burst |
677
- | ---- | ---- |
678
- | 1 | 1 |
679
-
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).
681
-
682
- Args:
683
-
684
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
685
-
686
- key pageSize:integer | The number of items to return in the response matching the given query.
687
-
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.
689
-
690
-
691
- Returns:
692
- ApiResponse:
693
- """
694
-
695
- return self._request(
696
- fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
697
- )
698
-
699
- @sp_endpoint(
700
- "/inbound/fba/<version>/inboundPlans/{}/packingInformation", method="POST"
701
- )
702
- def set_packing_information(self, inboundPlanId, **kwargs) -> ApiResponse:
703
- """
704
- set_packing_information(self, inboundPlanId, **kwargs) -> ApiResponse
705
-
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.
708
-
709
- **Usage Plan:**
710
-
711
- | Rate (requests per second) | Burst |
712
- | ---- | ---- |
713
- | 0.05 | 1 |
714
-
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).
716
-
717
- Args:
718
-
719
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
720
-
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'}
733
-
734
-
735
- Returns:
736
- ApiResponse:
737
- """
738
-
739
- return self._request(
740
- fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
741
- )
742
-
743
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/packingOptions", method="GET")
744
- def list_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse:
745
- """
746
- list_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse
747
-
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.
749
-
750
- **Usage Plan:**
751
-
752
- | Rate (requests per second) | Burst |
753
- | ---- | ---- |
754
- | 1 | 1 |
755
-
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).
757
-
758
- Args:
759
-
760
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
761
-
762
- key pageSize:integer | The number of packing options to return in the response matching the given query.
763
-
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.
765
-
766
-
767
- Returns:
768
- ApiResponse:
769
- """
770
-
771
- return self._request(
772
- fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
773
- )
774
-
775
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/packingOptions", method="POST")
776
- def generate_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse:
777
- """
778
- generate_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse
779
-
780
- Generates available packing options for the inbound plan.
781
-
782
- **Usage Plan:**
783
-
784
- | Rate (requests per second) | Burst |
785
- | ---- | ---- |
786
- | 0.05 | 1 |
787
-
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).
789
-
790
- Args:
791
-
792
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
793
-
794
-
795
- Returns:
796
- ApiResponse:
797
- """
798
-
799
- return self._request(
800
- fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
801
- )
802
-
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:
810
- """
811
- confirm_packing_option(self, inboundPlanId, **kwargs) -> ApiResponse
812
-
813
- Confirms the packing option for an inbound plan.
814
-
815
- **Usage Plan:**
816
-
817
- | Rate (requests per second) | Burst |
818
- | ---- | ---- |
819
- | 0.05 | 1 |
820
-
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).
822
-
823
- Args:
824
-
825
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
826
-
827
- packingOptionId:string | * REQUIRED Identifier to a packing option.
828
-
829
-
830
- Returns:
831
- ApiResponse:
832
- """
833
-
834
- return self._request(
835
- fill_query_params(kwargs.pop("path"), inboundPlanId, packingOptionId),
836
- data=kwargs,
837
- )
838
-
839
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/packingGroups/{}/items", method="GET")
840
- def list_packing_group_items(self, inboundPlanId, packingGroupId, **kwargs) -> ApiResponse:
841
- """
842
- list_packing_group_items(self, inboundPlanId, **kwargs) -> ApiResponse
843
-
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.
845
-
846
- **Usage Plan:**
847
-
848
- | Rate (requests per second) | Burst |
849
- | ---- | ---- |
850
- | 1 | 1 |
851
-
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).
853
-
854
- Args:
855
-
856
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
857
-
858
- packingGroupId:string | * REQUIRED Identifier to a packing group.
859
-
860
- key pageSize:integer | The number of packing group items to return in the response matching the given query.
861
-
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.
863
-
864
-
865
- Returns:
866
- ApiResponse:
867
- """
868
-
869
- return self._request(
870
- fill_query_params(kwargs.pop("path"), inboundPlanId, packingGroupId), params=kwargs
871
- )
872
-
873
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/pallets", method="GET")
874
- def list_inbound_plan_pallets(self, inboundPlanId, **kwargs) -> ApiResponse:
875
- """
876
- list_inbound_plan_pallets(self, inboundPlanId, **kwargs) -> ApiResponse
877
-
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.
879
-
880
- **Usage Plan:**
881
-
882
- | Rate (requests per second) | Burst |
883
- | ---- | ---- |
884
- | 1 | 1 |
885
-
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).
887
-
888
- Args:
889
-
890
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
891
-
892
- key pageSize:integer | The number of pallets to return in the response matching the given query.
893
-
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.
895
-
896
-
897
- Returns:
898
- ApiResponse:
899
- """
900
-
901
- return self._request(
902
- fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
903
- )
904
-
905
- @sp_endpoint(
906
- "/inbound/fba/<version>/inboundPlans/{}/placementOptions", method="GET"
907
- )
908
- def list_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse:
909
- """
910
- list_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse
911
-
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.
913
-
914
- **Usage Plan:**
915
-
916
- | Rate (requests per second) | Burst |
917
- | ---- | ---- |
918
- | 1 | 1 |
919
-
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).
921
-
922
- Args:
923
-
924
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
925
-
926
- key pageSize:integer | The number of placement options to return in the response matching the given query.
927
-
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.
929
-
930
-
931
- Returns:
932
- ApiResponse:
933
- """
934
-
935
- return self._request(
936
- fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
937
- )
938
-
939
- @sp_endpoint(
940
- "/inbound/fba/<version>/inboundPlans/{}/placementOptions", method="POST"
941
- )
942
- def generate_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse:
943
- """
944
- generate_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse
945
-
946
- Generates placement options for the inbound plan.
947
-
948
- **Usage Plan:**
949
-
950
- | Rate (requests per second) | Burst |
951
- | ---- | ---- |
952
- | 0.05 | 1 |
953
-
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).
955
-
956
- Args:
957
-
958
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
959
-
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'}
964
-
965
-
966
- Returns:
967
- ApiResponse:
968
- """
969
-
970
- return self._request(
971
- fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
972
- )
973
-
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:
981
- """
982
- confirm_placement_option(self, inboundPlanId, **kwargs) -> ApiResponse
983
-
984
- Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
985
-
986
- **Usage Plan:**
987
-
988
- | Rate (requests per second) | Burst |
989
- | ---- | ---- |
990
- | 0.05 | 1 |
991
-
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).
993
-
994
- Args:
995
-
996
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
997
-
998
- placementOptionId:string | * REQUIRED Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs.
999
-
1000
-
1001
- Returns:
1002
- ApiResponse:
1003
- """
1004
-
1005
- return self._request(
1006
- fill_query_params(kwargs.pop("path"), inboundPlanId, placementOptionId),
1007
- data=kwargs,
1008
- )
1009
-
1010
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/shipments/{}", method="GET")
1011
- def get_shipment(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1012
- """
1013
- get_shipment(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
1014
-
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.
1016
-
1017
- **Usage Plan:**
1018
-
1019
- | Rate (requests per second) | Burst |
1020
- | ---- | ---- |
1021
- | 1 | 1 |
1022
-
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).
1024
-
1025
- Args:
1026
-
1027
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1028
-
1029
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1030
-
1031
-
1032
- Returns:
1033
- ApiResponse:
1034
- """
1035
-
1036
- return self._request(
1037
- fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1038
- params=kwargs,
1039
- )
1040
-
1041
- @sp_endpoint(
1042
- "/inbound/fba/<version>/inboundPlans/{}/deliveryChallanDocument", method="GET"
1043
- )
1044
- def get_delivery_challan_document(self, inboundPlanId, **kwargs) -> ApiResponse:
1045
- """
1046
- get_delivery_challan_document(self, inboundPlanId, **kwargs) -> ApiResponse
1047
-
1048
- Provide delivery challan document for PCP transportation in IN marketplace.
1049
-
1050
- **Usage Plan:**
1051
-
1052
- | Rate (requests per second) | Burst |
1053
- | ---- | ---- |
1054
- | 1 | 1 |
1055
-
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).
1057
-
1058
- Args:
1059
-
1060
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1061
-
1062
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1063
-
1064
-
1065
- Returns:
1066
- ApiResponse:
1067
- """
1068
-
1069
- return self._request(
1070
- fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
1071
- )
1072
-
1073
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/deliveryWindow", method="POST")
1074
- def update_shipment_delivery_window(self, inboundPlanId, **kwargs) -> ApiResponse:
1075
- """
1076
- update_shipment_delivery_window(self, inboundPlanId, **kwargs) -> ApiResponse
1077
-
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.
1079
-
1080
- **Usage Plan:**
1081
-
1082
- | Rate (requests per second) | Burst |
1083
- | ---- | ---- |
1084
- | 1 | 1 |
1085
-
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).
1087
-
1088
- Args:
1089
-
1090
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1091
-
1092
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1093
-
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'}
1099
-
1100
-
1101
- Returns:
1102
- ApiResponse:
1103
- """
1104
-
1105
- return self._request(
1106
- fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1107
- )
1108
-
1109
- @sp_endpoint(
1110
- "/inbound/fba/<version>/inboundPlans/{}/selfShipAppointmentSlots", method="GET"
1111
- )
1112
- def get_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse:
1113
- """
1114
- get_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse
1115
-
1116
- Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse.
1117
-
1118
- **Usage Plan:**
1119
-
1120
- | Rate (requests per second) | Burst |
1121
- | ---- | ---- |
1122
- | 1 | 1 |
1123
-
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).
1125
-
1126
- Args:
1127
-
1128
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1129
-
1130
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1131
-
1132
- key pageSize:integer | The number of self ship appointment slots to return in the response matching the given query.
1133
-
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.
1135
-
1136
-
1137
- Returns:
1138
- ApiResponse:
1139
- """
1140
-
1141
- return self._request(
1142
- fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
1143
- )
1144
-
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:
1151
- """
1152
- generate_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse
1153
-
1154
- Initiates the process of generating the appointment slots list.
1155
-
1156
- **Usage Plan:**
1157
-
1158
- | Rate (requests per second) | Burst |
1159
- | ---- | ---- |
1160
- | 1 | 1 |
1161
-
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).
1163
-
1164
- Args:
1165
-
1166
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1167
-
1168
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1169
-
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'}
1175
-
1176
-
1177
- Returns:
1178
- ApiResponse:
1179
- """
1180
-
1181
- return self._request(
1182
- fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1183
- )
1184
-
1185
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/cancellation", method="PUT")
1186
- def cancel_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse:
1187
- """
1188
- cancel_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse
1189
-
1190
- Cancels a self-ship appointment slot against a shipment.
1191
-
1192
- **Usage Plan:**
1193
-
1194
- | Rate (requests per second) | Burst |
1195
- | ---- | ---- |
1196
- | 1 | 1 |
1197
-
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).
1199
-
1200
- Args:
1201
-
1202
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1203
-
1204
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1205
-
1206
- slotId:string | * REQUIRED Identifier to a self-ship appointment slot.
1207
-
1208
- body: | * REQUIRED {'description': 'The `cancelSelfShipAppointment` request.', 'example': {'reasonComment': 'OTHER'}, 'properties': {'reasonComment': {'$ref': '#/definitions/ReasonComment'}}, 'type': 'object'}
1209
-
1210
-
1211
- Returns:
1212
- ApiResponse:
1213
- """
1214
-
1215
- return self._request(
1216
- fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1217
- )
1218
-
1219
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/schedule", method="POST")
1220
- def schedule_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse:
1221
- """
1222
- schedule_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse
1223
-
1224
- Confirms or reschedules a self-ship appointment slot against a shipment.
1225
-
1226
- **Usage Plan:**
1227
-
1228
- | Rate (requests per second) | Burst |
1229
- | ---- | ---- |
1230
- | 1 | 1 |
1231
-
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).
1233
-
1234
- Args:
1235
-
1236
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1237
-
1238
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1239
-
1240
- slotId:string | * REQUIRED Identifier to a self-ship appointment slot.
1241
-
1242
- body: | * REQUIRED {'description': '`scheduleSelfShipAppointment` request.', 'example': {'reasonComment': 'OTHER'}, 'properties': {'reasonComment': {'$ref': '#/definitions/ReasonComment'}}, 'type': 'object'}
1243
-
1244
-
1245
- Returns:
1246
- ApiResponse:
1247
- """
1248
-
1249
- return self._request(
1250
- fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1251
- )
1252
-
1253
- @sp_endpoint("/inbound/fba/<version>/inboundPlans/{}/trackingDetails", method="PUT")
1254
- def update_shipment_tracking_details(self, inboundPlanId, **kwargs) -> ApiResponse:
1255
- """
1256
- update_shipment_tracking_details(self, inboundPlanId, **kwargs) -> ApiResponse
1257
-
1258
- Updates a shipment's tracking details.
1259
-
1260
- **Usage Plan:**
1261
-
1262
- | Rate (requests per second) | Burst |
1263
- | ---- | ---- |
1264
- | 1 | 1 |
1265
-
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).
1267
-
1268
- Args:
1269
-
1270
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1271
-
1272
- shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1273
-
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'}
1279
-
1280
-
1281
- Returns:
1282
- ApiResponse:
1283
- """
1284
-
1285
- return self._request(
1286
- fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1287
- )
1288
-
1289
- @sp_endpoint(
1290
- "/inbound/fba/<version>/inboundPlans/{}/transportationOptions", method="GET"
1291
- )
1292
- def list_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse:
1293
- """
1294
- list_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1295
-
1296
- Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available.
1297
-
1298
- **Usage Plan:**
1299
-
1300
- | Rate (requests per second) | Burst |
1301
- | ---- | ---- |
1302
- | 1 | 1 |
1303
-
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).
1305
-
1306
- Args:
1307
-
1308
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1309
-
1310
- key pageSize:integer | The number of transportation options to return in the response matching the given query.
1311
-
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.
1313
-
1314
- key placementOptionId:string | The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.
1315
-
1316
- key shipmentId:string | The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.
1317
-
1318
-
1319
- Returns:
1320
- ApiResponse:
1321
- """
1322
-
1323
- return self._request(
1324
- fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
1325
- )
1326
-
1327
- @sp_endpoint(
1328
- "/inbound/fba/<version>/inboundPlans/{}/transportationOptions", method="POST"
1329
- )
1330
- def generate_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse:
1331
- """
1332
- generate_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1333
-
1334
- Generates available transportation options for a given placement option.
1335
-
1336
- **Usage Plan:**
1337
-
1338
- | Rate (requests per second) | Burst |
1339
- | ---- | ---- |
1340
- | 0.05 | 1 |
1341
-
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).
1343
-
1344
- Args:
1345
-
1346
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
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'}
1363
-
1364
-
1365
- Returns:
1366
- ApiResponse:
1367
- """
1368
-
1369
- return self._request(
1370
- fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1371
- )
1372
-
1373
- @sp_endpoint(
1374
- "/inbound/fba/<version>/inboundPlans/{}/transportationOptions/confirmation",
1375
- method="POST",
1376
- )
1377
- def confirm_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse:
1378
- """
1379
- confirm_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1380
-
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.
1382
-
1383
- **Usage Plan:**
1384
-
1385
- | Rate (requests per second) | Burst |
1386
- | ---- | ---- |
1387
- | 0.05 | 1 |
1388
-
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).
1390
-
1391
- Args:
1392
-
1393
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1394
-
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'}
1403
-
1404
-
1405
- Returns:
1406
- ApiResponse:
1407
- """
1408
-
1409
- return self._request(
1410
- fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1411
- )
1412
-
1413
- @sp_endpoint("/inbound/fba/<version>/items/compliance", method="GET")
1414
- def list_item_compliance_details(self, **kwargs) -> ApiResponse:
1415
- """
1416
- list_item_compliance_details(self, **kwargs) -> ApiResponse
1417
-
1418
- List the inbound compliance details for MSKUs in a given marketplace.
1419
-
1420
- **Usage Plan:**
1421
-
1422
- | Rate (requests per second) | Burst |
1423
- | ---- | ---- |
1424
- | 1 | 1 |
1425
-
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).
1427
-
1428
- Args:
1429
-
1430
- key mskus:array | * REQUIRED List of merchant SKUs, a merchant-supplied identifier for a specific SKU.
1431
-
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.
1433
-
1434
-
1435
- Returns:
1436
- ApiResponse:
1437
- """
1438
-
1439
- return self._request(kwargs.pop("path"), params=kwargs)
1440
-
1441
- @sp_endpoint("/inbound/fba/<version>/items/compliance", method="PUT")
1442
- def update_item_compliance_details(self, **kwargs) -> ApiResponse:
1443
- """
1444
- update_item_compliance_details(self, **kwargs) -> ApiResponse
1445
-
1446
- Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation.
1447
-
1448
- **Usage Plan:**
1449
-
1450
- | Rate (requests per second) | Burst |
1451
- | ---- | ---- |
1452
- | 1 | 1 |
1453
-
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).
1455
-
1456
- Args:
1457
-
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.
1459
-
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'}
1465
-
1466
-
1467
- Returns:
1468
- ApiResponse:
1469
- """
1470
-
1471
- return self._request(kwargs.pop("path"), data=kwargs)
1472
-
1473
- @sp_endpoint("/inbound/fba/<version>/operations/{}", method="GET")
1474
- def get_inbound_operation_status(self, operationId, **kwargs) -> ApiResponse:
1475
- """
1476
- get_inbound_operation_status(self, operationId, **kwargs) -> ApiResponse
1477
-
1478
- Gets the status of the processing of an asynchronous API call.
1479
-
1480
- **Usage Plan:**
1481
-
1482
- | Rate (requests per second) | Burst |
1483
- | ---- | ---- |
1484
- | 1 | 1 |
1485
-
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).
1487
-
1488
- Args:
1489
-
1490
- operationId:string | * REQUIRED Identifier to an asynchronous operation.
1491
-
1492
-
1493
- Returns:
1494
- ApiResponse:
1495
- """
1496
-
1497
- return self._request(
1498
- fill_query_params(kwargs.pop("path"), operationId), params=kwargs
1499
- )
1500
-
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:
1508
- """
1509
- def generate_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1510
-
1511
- Generates available delivery window options for a given shipment.
1512
-
1513
- **Usage Plan:**
1514
-
1515
- | Rate (requests per second) | Burst |
1516
- | ---- | ---- |
1517
- | 2 | 30 |
1518
-
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).
1520
-
1521
- Args:
1522
-
1523
- inboundPlanId:string | * REQUIRED Identifier of an inbound plan.
1524
- shipmentId:string | * REQUIRED The shipment to generate delivery window options for.
1525
-
1526
-
1527
- Returns:
1528
- ApiResponse:
1529
- """
1530
-
1531
- return self._request(
1532
- fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1533
- params=kwargs,
1534
- )
1535
-
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:
1543
- """
1544
- def generate_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1545
-
1546
- Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the generateDeliveryWindowOptions operation before becoming available.
1547
-
1548
- **Usage Plan:**
1549
-
1550
- | Rate (requests per second) | Burst |
1551
- | ---- | ---- |
1552
- | 2 | 30 |
1553
-
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).
1555
-
1556
- Args:
1557
-
1558
- inboundPlanId:string | * REQUIRED Identifier of an inbound plan.
1559
- shipmentId:string | * REQUIRED The shipment to generate delivery window options for.
1560
-
1561
-
1562
- Returns:
1563
- ApiResponse:
1564
- """
1565
-
1566
- return self._request(
1567
- fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1568
- params=kwargs,
1569
- )
1570
-
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:
1578
- """
1579
- def confirm_delivery_window_options(self, inboundPlanId, shipmentId, deliveryWindowOptionId, **kwargs) -> ApiResponse:
1580
-
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.
1582
-
1583
- **Usage Plan:**
1584
-
1585
- | Rate (requests per second) | Burst |
1586
- | ---- | ---- |
1587
- | 2 | 30 |
1588
-
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).
1590
-
1591
- Args:
1592
-
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.
1596
-
1597
-
1598
- Returns:
1599
- ApiResponse:
1600
- """
1601
-
1602
- return self._request(
1603
- fill_query_params(
1604
- kwargs.pop("path"), inboundPlanId, shipmentId, deliveryWindowOptionId
1605
- ),
1606
- params=kwargs,
1607
- )
1608
-
1609
- @sp_endpoint(
1610
- "/inbound/fba/<version>/inboundPlans/{}/shipments/{}/items", method="GET"
1611
- )
1612
- def list_shipment_items(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1613
- """
1614
- list_shipment_items(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
1615
-
1616
- Provides a paginated list of item packages in a shipment.
1617
-
1618
- **Usage Plan:**
1619
-
1620
- | Rate (requests per second) | Burst |
1621
- | ---- | ---- |
1622
- | 2 | 30 |
1623
-
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).
1625
-
1626
- Args:
1627
-
1628
- inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
1629
-
1630
- shipmentId:string | * REQUIRED Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1631
-
1632
- key pageSize:integer | The number of items to return in the response matching the given query.
1633
-
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.
1635
-
1636
-
1637
- Returns:
1638
- ApiResponse:
1639
- """
1640
- return self._request(
1641
- fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1642
- params=kwargs,
1643
- )
1644
-
1645
- @sp_endpoint("/inbound/fba/<version>/items/labels", method="POST")
1646
- def create_marketplace_item_labels(self, **kwargs) -> ApiResponse:
1647
- """
1648
- create_marketplace_item_labels(self, **kwargs) -> ApiResponse
1649
-
1650
- For a given marketplace - creates labels for a list of MSKUs.
1651
-
1652
- **Usage Plan:**
1653
-
1654
- | Rate (requests per second) | Burst |
1655
- | ---- | ---- |
1656
- | 2 | 30 |
1657
-
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:
1660
-
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.
1668
-
1669
- Returns:
1670
- ApiResponse:
1671
- """
1672
-
1673
- return self._request(kwargs.pop("path"), data=kwargs)
1674
-
1675
- @sp_endpoint("/inbound/fba/<version>/items/prepDetails", method="GET")
1676
- def list_prep_details(self, **kwargs) -> ApiResponse:
1677
- """
1678
- list_prep_details(self, **kwargs) -> ApiResponse:
1679
-
1680
- Get preparation details for a list of MSKUs in a specified marketplace.
1681
-
1682
- **Usage Plan:**
1683
-
1684
- | Rate (requests per second) | Burst |
1685
- | ---- | ---- |
1686
- | 2 | 30 |
1687
-
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.
1692
-
1693
- Returns:
1694
- ApiResponse:
1695
- """
1696
-
1697
- return self._request(kwargs.pop("path"), params=kwargs)
1698
-
1699
- @sp_endpoint("/inbound/fba/<version>/items/prepDetails", method="POST")
1700
- def set_prep_details(self, **kwargs) -> ApiResponse:
1701
- """
1702
- set_prep_details(self, **kwargs) -> ApiResponse:
1703
-
1704
- Set the preparation details for a list of MSKUs in a specified marketplace.
1705
-
1706
- **Usage Plan:**
1707
-
1708
- | Rate (requests per second) | Burst |
1709
- | ---- | ---- |
1710
- | 2 | 30 |
1711
-
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:
1714
-
1715
- marketplaceId:string | *REQUIRED The marketplace ID.
1716
- mskuPrepDetails:array | *REQUIRED A list of MSKUs and related prep details.
1717
-
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:
1747
- """
1748
-
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
- }
1789
-
1790
- Returns:
1791
- ApiResponse:
1792
- """
1793
-
1794
- return self._request(
1795
- fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1796
- data=kwargs,
1797
- )
71
+ if TYPE_CHECKING:
72
+ @overload
73
+ def __new__(
74
+ cls,
75
+ *args: Any,
76
+ version: Literal[
77
+ FulfillmentInboundVersion.V_2024_03_20,
78
+ FulfillmentInboundVersion.LATEST,
79
+ "2024-03-20",
80
+ ],
81
+ **kwargs: Any,
82
+ ) -> FulfillmentInboundV20240320: ...
83
+
84
+ @overload
85
+ def __new__(
86
+ cls,
87
+ *args: Any,
88
+ version: Literal[FulfillmentInboundVersion.V_v0, "v0"],
89
+ **kwargs: Any,
90
+ ) -> FulfillmentInboundV0: ...
91
+
92
+ @overload
93
+ def __new__(
94
+ cls,
95
+ *args: Any,
96
+ version: None = None,
97
+ **kwargs: Any,
98
+ ) -> FulfillmentInboundV0: ...
99
+
100
+ @overload
101
+ def __new__(
102
+ cls,
103
+ *args: Any,
104
+ version: str | FulfillmentInboundVersion,
105
+ **kwargs: Any,
106
+ ) -> Client: ...
107
+
108
+ _DISPATCH = True
109
+
110
+ _DEFAULT_VERSION = "v0"
111
+
112
+ _VERSION_MAP = {
113
+ "v0": FulfillmentInboundV0,
114
+ "2024-03-20": FulfillmentInboundV20240320,
115
+ }
116
+
117
+ _VERSION_ALIASES = {
118
+ "v0": "v0",
119
+ "2024-03-20": "2024-03-20",
120
+ }