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
@@ -0,0 +1,1384 @@
1
+ from sp_api.base import Client, ApiResponse
2
+ from sp_api.base import sp_endpoint, fill_query_params
3
+
4
+ import urllib.parse
5
+ from sp_api.util import ensure_csv
6
+
7
+
8
+ class FulfillmentInboundV0(Client):
9
+ """
10
+ FulfillmentInbound SP-API Client
11
+ :link:
12
+
13
+ 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.
14
+ """
15
+
16
+ @sp_endpoint("/fba/inbound/v0/itemsGuidance")
17
+ def item_guidance(self, **kwargs):
18
+ """
19
+ item_guidance(self, **kwargs) -> ApiResponse
20
+
21
+
22
+
23
+ Examples:
24
+ literal blocks::
25
+
26
+ FulfillmentInboundV0().item_guidance()
27
+
28
+ Args:
29
+ **kwargs:
30
+
31
+ Returns:
32
+ ApiResponse
33
+ """
34
+ return self._request(kwargs.pop("path"), params=kwargs)
35
+
36
+ @sp_endpoint("/fba/inbound/v0/plans", method="POST")
37
+ def plans(self, data, **kwargs):
38
+ """
39
+ plans(self, data, **kwargs) -> ApiResponse
40
+
41
+
42
+
43
+ Examples:
44
+ literal blocks::
45
+
46
+ FulfillmentInboundV0().plans("value")
47
+
48
+ Args:
49
+ data: | required
50
+ **kwargs:
51
+
52
+ Returns:
53
+ ApiResponse
54
+ """
55
+ return self._request(kwargs.pop("path"), data={**data, **kwargs})
56
+
57
+ @sp_endpoint("/fba/inbound/v0/shipments/{}", method="POST")
58
+ def create_shipment(self, shipment_id, data, **kwargs):
59
+ """
60
+ create_shipment(self, shipment_id, data, **kwargs) -> ApiResponse
61
+
62
+ create_shipment(self, shipment_id, data, **kwargs)
63
+
64
+ Examples:
65
+ literal blocks::
66
+
67
+ FulfillmentInboundV0().create_shipment("value", "value")
68
+
69
+ Args:
70
+ shipment_id: | required
71
+ data: | required
72
+ **kwargs:
73
+
74
+ Returns:
75
+ ApiResponse
76
+ """
77
+ return self._request(
78
+ fill_query_params(kwargs.pop("path"), shipment_id), data={**data, **kwargs}
79
+ )
80
+
81
+ @sp_endpoint("/fba/inbound/v0/shipments/{}", method="PUT")
82
+ def update_shipment(self, shipment_id, data, **kwargs):
83
+ """
84
+ update_shipment(self, shipment_id, data, **kwargs) -> ApiResponse
85
+
86
+
87
+
88
+ Examples:
89
+ literal blocks::
90
+
91
+ FulfillmentInboundV0().update_shipment("value", "value")
92
+
93
+ Args:
94
+ shipment_id: | required
95
+ data: | required
96
+ **kwargs:
97
+
98
+ Returns:
99
+ ApiResponse
100
+ """
101
+ return self._request(
102
+ fill_query_params(kwargs.pop("path"), shipment_id), data={**data, **kwargs}
103
+ )
104
+
105
+ @sp_endpoint(
106
+ "/inbound/fba/v0/inboundPlans/{}/shipments/{}/name", method="PUT"
107
+ )
108
+ def update_shipment_name(self, inboundPlanId, shipmentId, **kwargs):
109
+ """
110
+ update_shipment_name(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
111
+
112
+ Updates the name of an existing shipment.
113
+
114
+ Examples:
115
+ literal blocks::
116
+
117
+ FulfillmentInboundV0().update_shipment_name("value", "value")
118
+
119
+ Args:
120
+ inboundPlanId: | required
121
+ shipmentId: | required
122
+ **kwargs:
123
+
124
+ Returns:
125
+ ApiResponse
126
+ """
127
+ return self._request(
128
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
129
+ data=kwargs,
130
+ )
131
+
132
+ @sp_endpoint("/fba/inbound/v0/shipments/{}/preorder")
133
+ def preorder(self, shipment_id, **kwargs):
134
+ """
135
+ preorder(self, shipment_id, **kwargs) -> ApiResponse
136
+
137
+
138
+
139
+ Examples:
140
+ literal blocks::
141
+
142
+ FulfillmentInboundV0().preorder("value")
143
+
144
+ Args:
145
+ shipment_id: | required
146
+ **kwargs:
147
+
148
+ Returns:
149
+ ApiResponse
150
+ """
151
+ return self._request(
152
+ fill_query_params(kwargs.pop("path"), shipment_id), params=kwargs
153
+ )
154
+
155
+ @sp_endpoint("/fba/inbound/v0/shipments/{}/preorder/confirm", method="PUT")
156
+ def confirm_preorder(self, shipment_id, **kwargs):
157
+ """
158
+ confirm_preorder(self, shipment_id, **kwargs) -> ApiResponse
159
+
160
+ confirm_preorder(self, shipment_id, **kwargs)
161
+
162
+ Examples:
163
+ literal blocks::
164
+
165
+ FulfillmentInboundV0().confirm_preorder("value")
166
+
167
+ Args:
168
+ shipment_id: | required
169
+ **kwargs:
170
+
171
+ Returns:
172
+ ApiResponse
173
+ """
174
+ return self._request(
175
+ fill_query_params(kwargs.pop("path"), shipment_id), params=kwargs
176
+ )
177
+
178
+ @sp_endpoint("/fba/inbound/v0/prepInstructions")
179
+ def prep_instruction(self, data, **kwargs):
180
+ """
181
+ prep_instruction(self, data, **kwargs) -> ApiResponse
182
+
183
+ Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network.
184
+
185
+ Examples:
186
+ literal blocks::
187
+
188
+ FulfillmentInboundV0().prep_instruction("value")
189
+
190
+ Args:
191
+ data: | required
192
+ **kwargs:
193
+
194
+ Returns:
195
+ ApiResponse
196
+ """
197
+ return self._request(kwargs.pop("path"), params={**data, **kwargs})
198
+
199
+ @sp_endpoint("/fba/inbound/v0/shipments/{}/transport")
200
+ def get_transport_information(self, shipment_id, **kwargs):
201
+ """
202
+ get_transport_information(self, shipment_id, **kwargs) -> ApiResponse
203
+
204
+
205
+
206
+ Examples:
207
+ literal blocks::
208
+
209
+ FulfillmentInboundV0().get_transport_information("value")
210
+
211
+ Args:
212
+ shipment_id: | required
213
+ **kwargs:
214
+
215
+ Returns:
216
+ ApiResponse
217
+ """
218
+ return self._request(
219
+ fill_query_params(kwargs.pop("path"), shipment_id), params=kwargs
220
+ )
221
+
222
+ @sp_endpoint("/fba/inbound/v0/shipments/{}/transport", method="PUT")
223
+ def update_transport_information(self, shipment_id, **kwargs):
224
+ """
225
+ update_transport_information(self, shipment_id, **kwargs) -> ApiResponse
226
+
227
+ putTransportDetails
228
+
229
+ Examples:
230
+ literal blocks::
231
+
232
+ FulfillmentInboundV0().update_transport_information("value")
233
+
234
+ Args:
235
+ shipment_id: | required
236
+ **kwargs:
237
+
238
+ Returns:
239
+ ApiResponse
240
+ """
241
+ return self._request(
242
+ fill_query_params(kwargs.pop("path"), shipment_id), data=kwargs
243
+ )
244
+
245
+ @sp_endpoint("/fba/inbound/v0/shipments/{}/transport/void", method="POST")
246
+ def void_transport(self, shipment_id, **kwargs):
247
+ """
248
+ void_transport(self, shipment_id, **kwargs) -> ApiResponse
249
+
250
+
251
+
252
+ Examples:
253
+ literal blocks::
254
+
255
+ FulfillmentInboundV0().void_transport("value")
256
+
257
+ Args:
258
+ shipment_id: | required
259
+ **kwargs:
260
+
261
+ Returns:
262
+ ApiResponse
263
+ """
264
+ return self._request(
265
+ fill_query_params(kwargs.pop("path"), shipment_id),
266
+ data=kwargs,
267
+ add_marketplace=False,
268
+ )
269
+
270
+ @sp_endpoint(
271
+ "/fba/inbound/v0/shipments/{}/transport/estimate", method="POST"
272
+ )
273
+ def estimate_transport(self, shipment_id, **kwargs):
274
+ """
275
+ estimate_transport(self, shipment_id, **kwargs) -> ApiResponse
276
+
277
+
278
+
279
+ Examples:
280
+ literal blocks::
281
+
282
+ FulfillmentInboundV0().estimate_transport("value")
283
+
284
+ Args:
285
+ shipment_id: | required
286
+ **kwargs:
287
+
288
+ Returns:
289
+ ApiResponse
290
+ """
291
+ return self._request(
292
+ fill_query_params(kwargs.pop("path"), shipment_id),
293
+ data=kwargs,
294
+ add_marketplace=False,
295
+ )
296
+
297
+ @sp_endpoint("/fba/inbound/v0/shipments/{}/transport/confirm", method="POST")
298
+ def confirm_transport(self, shipment_id, **kwargs):
299
+ return self._request(
300
+ fill_query_params(kwargs.pop("path"), shipment_id),
301
+ data=kwargs,
302
+ add_marketplace=False,
303
+ )
304
+
305
+ @sp_endpoint("/fba/inbound/v0/shipments/{}/labels")
306
+ def get_labels(self, shipment_id, **kwargs):
307
+ """
308
+ get_labels(self, shipment_id, **kwargs) -> ApiResponse
309
+
310
+ Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.
311
+
312
+ Examples:
313
+ literal blocks::
314
+
315
+ FulfillmentInboundV0().get_labels("value")
316
+
317
+ Args:
318
+ shipment_id: | required
319
+ **kwargs:
320
+
321
+ Returns:
322
+ ApiResponse
323
+ """
324
+ return self._request(
325
+ fill_query_params(kwargs.pop("path"), shipment_id),
326
+ params=kwargs,
327
+ add_marketplace=False,
328
+ )
329
+
330
+ @sp_endpoint("/fba/inbound/v0/shipments/{}/billOfLading")
331
+ def bill_of_lading(self, shipment_id, **kwargs):
332
+ """
333
+ bill_of_lading(self, shipment_id, **kwargs) -> ApiResponse
334
+
335
+ Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment.
336
+
337
+ Examples:
338
+ literal blocks::
339
+
340
+ FulfillmentInboundV0().bill_of_lading("value")
341
+
342
+ Args:
343
+ shipment_id: | required
344
+ **kwargs:
345
+
346
+ Returns:
347
+ ApiResponse
348
+ """
349
+ return self._request(
350
+ fill_query_params(kwargs.pop("path"), shipment_id), params=kwargs
351
+ )
352
+
353
+ @sp_endpoint("/fba/inbound/v0/shipments")
354
+ def get_shipments(self, **kwargs):
355
+ """
356
+ get_shipments(self, **kwargs) -> ApiResponse
357
+
358
+ Returns a list of inbound shipments based on criteria that you specify.
359
+
360
+ Examples:
361
+ literal blocks::
362
+
363
+ FulfillmentInboundV0().get_shipments()
364
+
365
+ Args:
366
+ **kwargs:
367
+
368
+ Returns:
369
+ ApiResponse
370
+ """
371
+ return self._request(kwargs.pop("path"), params=kwargs)
372
+
373
+ @sp_endpoint("/fba/inbound/v0/shipments/{}/items")
374
+ def shipment_items_by_shipment(self, shipment_id, **kwargs):
375
+ """
376
+ shipment_items_by_shipment(self, shipment_id, **kwargs) -> ApiResponse
377
+
378
+ Returns a list of items in a specified inbound shipment.
379
+
380
+ Examples:
381
+ literal blocks::
382
+
383
+ FulfillmentInboundV0().shipment_items_by_shipment("value")
384
+
385
+ Args:
386
+ shipment_id: | required
387
+ **kwargs:
388
+
389
+ Returns:
390
+ ApiResponse
391
+ """
392
+ return self._request(
393
+ fill_query_params(kwargs.pop("path"), shipment_id), params=kwargs
394
+ )
395
+
396
+ @sp_endpoint("/fba/inbound/v0/shipmentItems")
397
+ def shipment_items(self, **kwargs):
398
+ """
399
+ shipment_items(self, **kwargs) -> ApiResponse
400
+
401
+ Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame.
402
+
403
+ Examples:
404
+ literal blocks::
405
+
406
+ FulfillmentInboundV0().shipment_items()
407
+
408
+ Args:
409
+ **kwargs:
410
+
411
+ Returns:
412
+ ApiResponse
413
+ """
414
+ return self._request(kwargs.pop("path"), params=kwargs)
415
+
416
+ def get_shipments_by_id(self, shipment_id_list, **kwargs) -> ApiResponse:
417
+ """
418
+ get_shipments_by_id(self, shipment_id_list, **kwargs) -> ApiResponse
419
+
420
+ FulfillmentInbound().get_shipments_by_id('FBA16TBYQ6J6')
421
+
422
+ Examples:
423
+ literal blocks::
424
+
425
+ FulfillmentInboundV0().get_shipments_by_id("value")
426
+
427
+ Args:
428
+ shipment_id_list: | required
429
+ **kwargs:
430
+
431
+ Returns:
432
+ ApiResponse
433
+ """
434
+ shipment_id_list = ensure_csv(shipment_id_list)
435
+ return self.get_shipments(
436
+ QueryType="SHIPMENT", ShipmentIdList=shipment_id_list, **kwargs
437
+ )
438
+
439
+ # 2024-03-20 API
440
+ @sp_endpoint("/inbound/fba/v0/inboundPlans", method="GET")
441
+ def list_inbound_plans(self, **kwargs) -> ApiResponse:
442
+ """
443
+ list_inbound_plans(self, **kwargs) -> ApiResponse
444
+
445
+ Provides a list of inbound plans with minimal information.
446
+
447
+ Examples:
448
+ literal blocks::
449
+
450
+ FulfillmentInboundV0().list_inbound_plans()
451
+
452
+ Args:
453
+ **kwargs:
454
+
455
+ Returns:
456
+ ApiResponse
457
+ """
458
+
459
+ return self._request(kwargs.pop("path"), params=kwargs)
460
+
461
+ @sp_endpoint("/inbound/fba/v0/inboundPlans", method="POST")
462
+ def create_inbound_plan(self, **kwargs) -> ApiResponse:
463
+ """
464
+ create_inbound_plan(self, **kwargs) -> ApiResponse
465
+
466
+ Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon's fufillment network.
467
+
468
+ Examples:
469
+ literal blocks::
470
+
471
+ FulfillmentInboundV0().create_inbound_plan()
472
+
473
+ Args:
474
+ **kwargs:
475
+
476
+ Returns:
477
+ ApiResponse
478
+ """
479
+
480
+ return self._request(kwargs.pop("path"), data=kwargs)
481
+
482
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}", method="GET")
483
+ def get_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse:
484
+ """
485
+ get_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse
486
+
487
+ Fetches the top level information about an inbound plan.
488
+
489
+ Examples:
490
+ literal blocks::
491
+
492
+ FulfillmentInboundV0().get_inbound_plan("value")
493
+
494
+ Args:
495
+ inboundPlanId: | required
496
+ **kwargs:
497
+
498
+ Returns:
499
+ ApiResponse
500
+ """
501
+
502
+ return self._request(
503
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
504
+ )
505
+
506
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}/boxes", method="GET")
507
+ def list_inbound_plan_boxes(self, inboundPlanId, **kwargs) -> ApiResponse:
508
+ """
509
+ list_inbound_plan_boxes(self, inboundPlanId, **kwargs) -> ApiResponse
510
+
511
+ Provides a paginated list of box packages in an inbound plan.
512
+
513
+ Examples:
514
+ literal blocks::
515
+
516
+ FulfillmentInboundV0().list_inbound_plan_boxes("value")
517
+
518
+ Args:
519
+ inboundPlanId: | required
520
+ **kwargs:
521
+
522
+ Returns:
523
+ ApiResponse
524
+ """
525
+
526
+ return self._request(
527
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
528
+ )
529
+
530
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}/cancellation", method="PUT")
531
+ def cancel_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse:
532
+ """
533
+ cancel_inbound_plan(self, inboundPlanId, **kwargs) -> ApiResponse
534
+
535
+ Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window
536
+ for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments.
537
+
538
+ Examples:
539
+ literal blocks::
540
+
541
+ FulfillmentInboundV0().cancel_inbound_plan("value")
542
+
543
+ Args:
544
+ inboundPlanId: | required
545
+ **kwargs:
546
+
547
+ Returns:
548
+ ApiResponse
549
+ """
550
+
551
+ return self._request(
552
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
553
+ )
554
+
555
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}/items", method="GET")
556
+ def list_inbound_plan_items(self, inboundPlanId, **kwargs) -> ApiResponse:
557
+ """
558
+ list_inbound_plan_items(self, inboundPlanId, **kwargs) -> ApiResponse
559
+
560
+ Provides a paginated list of item packages in an inbound plan.
561
+
562
+ Examples:
563
+ literal blocks::
564
+
565
+ FulfillmentInboundV0().list_inbound_plan_items("value")
566
+
567
+ Args:
568
+ inboundPlanId: | required
569
+ **kwargs:
570
+
571
+ Returns:
572
+ ApiResponse
573
+ """
574
+
575
+ return self._request(
576
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
577
+ )
578
+
579
+ @sp_endpoint(
580
+ "/inbound/fba/v0/inboundPlans/{}/packingInformation", method="POST"
581
+ )
582
+ def set_packing_information(self, inboundPlanId, **kwargs) -> ApiResponse:
583
+ """
584
+ set_packing_information(self, inboundPlanId, **kwargs) -> ApiResponse
585
+
586
+ Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate
587
+ the box level information required for planning and transportation estimates.
588
+
589
+ Examples:
590
+ literal blocks::
591
+
592
+ FulfillmentInboundV0().set_packing_information("value")
593
+
594
+ Args:
595
+ inboundPlanId: | required
596
+ **kwargs:
597
+
598
+ Returns:
599
+ ApiResponse
600
+ """
601
+
602
+ return self._request(
603
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
604
+ )
605
+
606
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}/packingOptions", method="GET")
607
+ def list_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse:
608
+ """
609
+ list_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse
610
+
611
+ Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available.
612
+
613
+ Examples:
614
+ literal blocks::
615
+
616
+ FulfillmentInboundV0().list_packing_options("value")
617
+
618
+ Args:
619
+ inboundPlanId: | required
620
+ **kwargs:
621
+
622
+ Returns:
623
+ ApiResponse
624
+ """
625
+
626
+ return self._request(
627
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
628
+ )
629
+
630
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}/packingOptions", method="POST")
631
+ def generate_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse:
632
+ """
633
+ generate_packing_options(self, inboundPlanId, **kwargs) -> ApiResponse
634
+
635
+ Generates available packing options for the inbound plan.
636
+
637
+ Examples:
638
+ literal blocks::
639
+
640
+ FulfillmentInboundV0().generate_packing_options("value")
641
+
642
+ Args:
643
+ inboundPlanId: | required
644
+ **kwargs:
645
+
646
+ Returns:
647
+ ApiResponse
648
+ """
649
+
650
+ return self._request(
651
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
652
+ )
653
+
654
+ @sp_endpoint(
655
+ "/inbound/fba/v0/inboundPlans/{}/packingOptions/{}/confirmation",
656
+ method="POST",
657
+ )
658
+ def confirm_packing_option(
659
+ self, inboundPlanId, packingOptionId, **kwargs
660
+ ) -> ApiResponse:
661
+ """
662
+ confirm_packing_option(self, inboundPlanId, packingOptionId, **kwargs) -> ApiResponse
663
+
664
+ Confirms the packing option for an inbound plan.
665
+
666
+ Examples:
667
+ literal blocks::
668
+
669
+ FulfillmentInboundV0().confirm_packing_option("value", "value")
670
+
671
+ Args:
672
+ inboundPlanId: | required
673
+ packingOptionId: | required
674
+ **kwargs:
675
+
676
+ Returns:
677
+ ApiResponse
678
+ """
679
+
680
+ return self._request(
681
+ fill_query_params(kwargs.pop("path"), inboundPlanId, packingOptionId),
682
+ data=kwargs,
683
+ )
684
+
685
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}/packingGroups/{}/items", method="GET")
686
+ def list_packing_group_items(self, inboundPlanId, packingGroupId, **kwargs) -> ApiResponse:
687
+ """
688
+ list_packing_group_items(self, inboundPlanId, packingGroupId, **kwargs) -> ApiResponse
689
+
690
+ 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.
691
+
692
+ Examples:
693
+ literal blocks::
694
+
695
+ FulfillmentInboundV0().list_packing_group_items("value", "value")
696
+
697
+ Args:
698
+ inboundPlanId: | required
699
+ packingGroupId: | required
700
+ **kwargs:
701
+
702
+ Returns:
703
+ ApiResponse
704
+ """
705
+
706
+ return self._request(
707
+ fill_query_params(kwargs.pop("path"), inboundPlanId, packingGroupId), params=kwargs
708
+ )
709
+
710
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}/pallets", method="GET")
711
+ def list_inbound_plan_pallets(self, inboundPlanId, **kwargs) -> ApiResponse:
712
+ """
713
+ list_inbound_plan_pallets(self, inboundPlanId, **kwargs) -> ApiResponse
714
+
715
+ 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.
716
+
717
+ Examples:
718
+ literal blocks::
719
+
720
+ FulfillmentInboundV0().list_inbound_plan_pallets("value")
721
+
722
+ Args:
723
+ inboundPlanId: | required
724
+ **kwargs:
725
+
726
+ Returns:
727
+ ApiResponse
728
+ """
729
+
730
+ return self._request(
731
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
732
+ )
733
+
734
+ @sp_endpoint(
735
+ "/inbound/fba/v0/inboundPlans/{}/placementOptions", method="GET"
736
+ )
737
+ def list_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse:
738
+ """
739
+ list_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse
740
+
741
+ Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available.
742
+
743
+ Examples:
744
+ literal blocks::
745
+
746
+ FulfillmentInboundV0().list_placement_options("value")
747
+
748
+ Args:
749
+ inboundPlanId: | required
750
+ **kwargs:
751
+
752
+ Returns:
753
+ ApiResponse
754
+ """
755
+
756
+ return self._request(
757
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
758
+ )
759
+
760
+ @sp_endpoint(
761
+ "/inbound/fba/v0/inboundPlans/{}/placementOptions", method="POST"
762
+ )
763
+ def generate_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse:
764
+ """
765
+ generate_placement_options(self, inboundPlanId, **kwargs) -> ApiResponse
766
+
767
+ Generates placement options for the inbound plan.
768
+
769
+ Examples:
770
+ literal blocks::
771
+
772
+ FulfillmentInboundV0().generate_placement_options("value")
773
+
774
+ Args:
775
+ inboundPlanId: | required
776
+ **kwargs:
777
+
778
+ Returns:
779
+ ApiResponse
780
+ """
781
+
782
+ return self._request(
783
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
784
+ )
785
+
786
+ @sp_endpoint(
787
+ "/inbound/fba/v0/inboundPlans/{}/placementOptions/{}/confirmation",
788
+ method="POST",
789
+ )
790
+ def confirm_placement_option(
791
+ self, inboundPlanId, placementOptionId, **kwargs
792
+ ) -> ApiResponse:
793
+ """
794
+ confirm_placement_option(self, inboundPlanId, placementOptionId, **kwargs) -> ApiResponse
795
+
796
+ Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
797
+
798
+ Examples:
799
+ literal blocks::
800
+
801
+ FulfillmentInboundV0().confirm_placement_option("value", "value")
802
+
803
+ Args:
804
+ inboundPlanId: | required
805
+ placementOptionId: | required
806
+ **kwargs:
807
+
808
+ Returns:
809
+ ApiResponse
810
+ """
811
+
812
+ return self._request(
813
+ fill_query_params(kwargs.pop("path"), inboundPlanId, placementOptionId),
814
+ data=kwargs,
815
+ )
816
+
817
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}/shipments/{}", method="GET")
818
+ def get_shipment(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
819
+ """
820
+ get_shipment(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
821
+
822
+ 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.
823
+
824
+ Examples:
825
+ literal blocks::
826
+
827
+ FulfillmentInboundV0().get_shipment("value", "value")
828
+
829
+ Args:
830
+ inboundPlanId: | required
831
+ shipmentId: | required
832
+ **kwargs:
833
+
834
+ Returns:
835
+ ApiResponse
836
+ """
837
+
838
+ return self._request(
839
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
840
+ params=kwargs,
841
+ )
842
+
843
+ @sp_endpoint(
844
+ "/inbound/fba/v0/inboundPlans/{}/deliveryChallanDocument", method="GET"
845
+ )
846
+ def get_delivery_challan_document(self, inboundPlanId, **kwargs) -> ApiResponse:
847
+ """
848
+ get_delivery_challan_document(self, inboundPlanId, **kwargs) -> ApiResponse
849
+
850
+ Provide delivery challan document for PCP transportation in IN marketplace.
851
+
852
+ Examples:
853
+ literal blocks::
854
+
855
+ FulfillmentInboundV0().get_delivery_challan_document("value")
856
+
857
+ Args:
858
+ inboundPlanId: | required
859
+ **kwargs:
860
+
861
+ Returns:
862
+ ApiResponse
863
+ """
864
+
865
+ return self._request(
866
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
867
+ )
868
+
869
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}/deliveryWindow", method="POST")
870
+ def update_shipment_delivery_window(self, inboundPlanId, **kwargs) -> ApiResponse:
871
+ """
872
+ update_shipment_delivery_window(self, inboundPlanId, **kwargs) -> ApiResponse
873
+
874
+ 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.
875
+
876
+ Examples:
877
+ literal blocks::
878
+
879
+ FulfillmentInboundV0().update_shipment_delivery_window("value")
880
+
881
+ Args:
882
+ inboundPlanId: | required
883
+ **kwargs:
884
+
885
+ Returns:
886
+ ApiResponse
887
+ """
888
+
889
+ return self._request(
890
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
891
+ )
892
+
893
+ @sp_endpoint(
894
+ "/inbound/fba/v0/inboundPlans/{}/selfShipAppointmentSlots", method="GET"
895
+ )
896
+ def get_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse:
897
+ """
898
+ get_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse
899
+
900
+ Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse.
901
+
902
+ Examples:
903
+ literal blocks::
904
+
905
+ FulfillmentInboundV0().get_self_ship_appointment_slots("value")
906
+
907
+ Args:
908
+ inboundPlanId: | required
909
+ **kwargs:
910
+
911
+ Returns:
912
+ ApiResponse
913
+ """
914
+
915
+ return self._request(
916
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
917
+ )
918
+
919
+ @sp_endpoint(
920
+ "/inbound/fba/v0/inboundPlans/{}/selfShipAppointmentSlots", method="POST"
921
+ )
922
+ def generate_self_ship_appointment_slots(
923
+ self, inboundPlanId, **kwargs
924
+ ) -> ApiResponse:
925
+ """
926
+ generate_self_ship_appointment_slots(self, inboundPlanId, **kwargs) -> ApiResponse
927
+
928
+ Initiates the process of generating the appointment slots list.
929
+
930
+ Examples:
931
+ literal blocks::
932
+
933
+ FulfillmentInboundV0().generate_self_ship_appointment_slots("value")
934
+
935
+ Args:
936
+ inboundPlanId: | required
937
+ **kwargs:
938
+
939
+ Returns:
940
+ ApiResponse
941
+ """
942
+
943
+ return self._request(
944
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
945
+ )
946
+
947
+
948
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}/schedule", method="POST")
949
+ def schedule_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse:
950
+ """
951
+ schedule_self_ship_appointment(self, inboundPlanId, **kwargs) -> ApiResponse
952
+
953
+ Confirms or reschedules a self-ship appointment slot against a shipment.
954
+
955
+ Examples:
956
+ literal blocks::
957
+
958
+ FulfillmentInboundV0().schedule_self_ship_appointment("value")
959
+
960
+ Args:
961
+ inboundPlanId: | required
962
+ **kwargs:
963
+
964
+ Returns:
965
+ ApiResponse
966
+ """
967
+
968
+ return self._request(
969
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
970
+ )
971
+
972
+ @sp_endpoint("/inbound/fba/v0/inboundPlans/{}/trackingDetails", method="PUT")
973
+ def update_shipment_tracking_details(self, inboundPlanId, **kwargs) -> ApiResponse:
974
+ """
975
+ update_shipment_tracking_details(self, inboundPlanId, **kwargs) -> ApiResponse
976
+
977
+ Updates a shipment's tracking details.
978
+
979
+ Examples:
980
+ literal blocks::
981
+
982
+ FulfillmentInboundV0().update_shipment_tracking_details("value")
983
+
984
+ Args:
985
+ inboundPlanId: | required
986
+ **kwargs:
987
+
988
+ Returns:
989
+ ApiResponse
990
+ """
991
+
992
+ return self._request(
993
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
994
+ )
995
+
996
+ @sp_endpoint(
997
+ "/inbound/fba/v0/inboundPlans/{}/transportationOptions", method="GET"
998
+ )
999
+ def list_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse:
1000
+ """
1001
+ list_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1002
+
1003
+ Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available.
1004
+
1005
+ Examples:
1006
+ literal blocks::
1007
+
1008
+ FulfillmentInboundV0().list_transportation_options("value")
1009
+
1010
+ Args:
1011
+ inboundPlanId: | required
1012
+ **kwargs:
1013
+
1014
+ Returns:
1015
+ ApiResponse
1016
+ """
1017
+
1018
+ return self._request(
1019
+ fill_query_params(kwargs.pop("path"), inboundPlanId), params=kwargs
1020
+ )
1021
+
1022
+ @sp_endpoint(
1023
+ "/inbound/fba/v0/inboundPlans/{}/transportationOptions", method="POST"
1024
+ )
1025
+ def generate_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse:
1026
+ """
1027
+ generate_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1028
+
1029
+ Generates available transportation options for a given placement option.
1030
+
1031
+ Examples:
1032
+ literal blocks::
1033
+
1034
+ FulfillmentInboundV0().generate_transportation_options("value")
1035
+
1036
+ Args:
1037
+ inboundPlanId: | required
1038
+ **kwargs:
1039
+
1040
+ Returns:
1041
+ ApiResponse
1042
+ """
1043
+
1044
+ return self._request(
1045
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1046
+ )
1047
+
1048
+ @sp_endpoint(
1049
+ "/inbound/fba/v0/inboundPlans/{}/transportationOptions/confirmation",
1050
+ method="POST",
1051
+ )
1052
+ def confirm_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse:
1053
+ """
1054
+ confirm_transportation_options(self, inboundPlanId, **kwargs) -> ApiResponse
1055
+
1056
+ 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.
1057
+
1058
+ Examples:
1059
+ literal blocks::
1060
+
1061
+ FulfillmentInboundV0().confirm_transportation_options("value")
1062
+
1063
+ Args:
1064
+ inboundPlanId: | required
1065
+ **kwargs:
1066
+
1067
+ Returns:
1068
+ ApiResponse
1069
+ """
1070
+
1071
+ return self._request(
1072
+ fill_query_params(kwargs.pop("path"), inboundPlanId), data=kwargs
1073
+ )
1074
+
1075
+ @sp_endpoint("/inbound/fba/v0/items/compliance", method="GET")
1076
+ def list_item_compliance_details(self, **kwargs) -> ApiResponse:
1077
+ """
1078
+ list_item_compliance_details(self, **kwargs) -> ApiResponse
1079
+
1080
+ List the inbound compliance details for MSKUs in a given marketplace.
1081
+
1082
+ Examples:
1083
+ literal blocks::
1084
+
1085
+ FulfillmentInboundV0().list_item_compliance_details()
1086
+
1087
+ Args:
1088
+ **kwargs:
1089
+
1090
+ Returns:
1091
+ ApiResponse
1092
+ """
1093
+
1094
+ return self._request(kwargs.pop("path"), params=kwargs)
1095
+
1096
+ @sp_endpoint("/inbound/fba/v0/items/compliance", method="PUT")
1097
+ def update_item_compliance_details(self, **kwargs) -> ApiResponse:
1098
+ """
1099
+ update_item_compliance_details(self, **kwargs) -> ApiResponse
1100
+
1101
+ Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation.
1102
+
1103
+ Examples:
1104
+ literal blocks::
1105
+
1106
+ FulfillmentInboundV0().update_item_compliance_details()
1107
+
1108
+ Args:
1109
+ **kwargs:
1110
+
1111
+ Returns:
1112
+ ApiResponse
1113
+ """
1114
+
1115
+ return self._request(kwargs.pop("path"), data=kwargs)
1116
+
1117
+ @sp_endpoint("/inbound/fba/v0/operations/{}", method="GET")
1118
+ def get_inbound_operation_status(self, operationId, **kwargs) -> ApiResponse:
1119
+ """
1120
+ get_inbound_operation_status(self, operationId, **kwargs) -> ApiResponse
1121
+
1122
+ Gets the status of the processing of an asynchronous API call.
1123
+
1124
+ Examples:
1125
+ literal blocks::
1126
+
1127
+ FulfillmentInboundV0().get_inbound_operation_status("value")
1128
+
1129
+ Args:
1130
+ operationId: | required
1131
+ **kwargs:
1132
+
1133
+ Returns:
1134
+ ApiResponse
1135
+ """
1136
+
1137
+ return self._request(
1138
+ fill_query_params(kwargs.pop("path"), operationId), params=kwargs
1139
+ )
1140
+
1141
+ @sp_endpoint(
1142
+ "/inbound/fba/v0/inboundPlans/{}/shipments/{}/deliveryWindowOptions",
1143
+ method="POST",
1144
+ )
1145
+ def generate_delivery_window_options(
1146
+ self, inboundPlanId, shipmentId, **kwargs
1147
+ ) -> ApiResponse:
1148
+ """
1149
+ generate_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
1150
+
1151
+ Generates available delivery window options for a given shipment.
1152
+
1153
+ Examples:
1154
+ literal blocks::
1155
+
1156
+ FulfillmentInboundV0().generate_delivery_window_options("value", "value")
1157
+
1158
+ Args:
1159
+ inboundPlanId: | required
1160
+ shipmentId: | required
1161
+ **kwargs:
1162
+
1163
+ Returns:
1164
+ ApiResponse
1165
+ """
1166
+
1167
+ return self._request(
1168
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1169
+ params=kwargs,
1170
+ )
1171
+
1172
+ @sp_endpoint(
1173
+ "/inbound/fba/v0/inboundPlans/{}/shipments/{}/deliveryWindowOptions",
1174
+ method="GET",
1175
+ )
1176
+ def list_delivery_window_options(
1177
+ self, inboundPlanId, shipmentId, **kwargs
1178
+ ) -> ApiResponse:
1179
+ """
1180
+ list_delivery_window_options(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
1181
+
1182
+ Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the generateDeliveryWindowOptions operation before becoming available.
1183
+
1184
+ Examples:
1185
+ literal blocks::
1186
+
1187
+ FulfillmentInboundV0().list_delivery_window_options("value", "value")
1188
+
1189
+ Args:
1190
+ inboundPlanId: | required
1191
+ shipmentId: | required
1192
+ **kwargs:
1193
+
1194
+ Returns:
1195
+ ApiResponse
1196
+ """
1197
+
1198
+ return self._request(
1199
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1200
+ params=kwargs,
1201
+ )
1202
+
1203
+ @sp_endpoint(
1204
+ "/inbound/fba/v0/inboundPlans/{}/shipments/{}/deliveryWindowOptions/{}/confirmation",
1205
+ method="POST",
1206
+ )
1207
+ def confirm_delivery_window_options(
1208
+ self, inboundPlanId, shipmentId, deliveryWindowOptionId, **kwargs
1209
+ ) -> ApiResponse:
1210
+ """
1211
+ confirm_delivery_window_options(self, inboundPlanId, shipmentId, deliveryWindowOptionId, **kwargs) -> ApiResponse
1212
+
1213
+ 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.
1214
+
1215
+ Examples:
1216
+ literal blocks::
1217
+
1218
+ FulfillmentInboundV0().confirm_delivery_window_options("value", "value", "value")
1219
+
1220
+ Args:
1221
+ inboundPlanId: | required
1222
+ shipmentId: | required
1223
+ deliveryWindowOptionId: | required
1224
+ **kwargs:
1225
+
1226
+ Returns:
1227
+ ApiResponse
1228
+ """
1229
+
1230
+ return self._request(
1231
+ fill_query_params(
1232
+ kwargs.pop("path"), inboundPlanId, shipmentId, deliveryWindowOptionId
1233
+ ),
1234
+ params=kwargs,
1235
+ )
1236
+
1237
+ @sp_endpoint(
1238
+ "/inbound/fba/v0/inboundPlans/{}/shipments/{}/items", method="GET"
1239
+ )
1240
+ def list_shipment_items(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1241
+ """
1242
+ list_shipment_items(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
1243
+
1244
+ Provides a paginated list of item packages in a shipment.
1245
+
1246
+ Examples:
1247
+ literal blocks::
1248
+
1249
+ FulfillmentInboundV0().list_shipment_items("value", "value")
1250
+
1251
+ Args:
1252
+ inboundPlanId: | required
1253
+ shipmentId: | required
1254
+ **kwargs:
1255
+
1256
+ Returns:
1257
+ ApiResponse
1258
+ """
1259
+ return self._request(
1260
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1261
+ params=kwargs,
1262
+ )
1263
+
1264
+ @sp_endpoint("/inbound/fba/v0/items/labels", method="POST")
1265
+ def create_marketplace_item_labels(self, **kwargs) -> ApiResponse:
1266
+ """
1267
+ create_marketplace_item_labels(self, **kwargs) -> ApiResponse
1268
+
1269
+ For a given marketplace - creates labels for a list of MSKUs.
1270
+
1271
+ Examples:
1272
+ literal blocks::
1273
+
1274
+ FulfillmentInboundV0().create_marketplace_item_labels()
1275
+
1276
+ Args:
1277
+ **kwargs:
1278
+
1279
+ Returns:
1280
+ ApiResponse
1281
+ """
1282
+
1283
+ return self._request(kwargs.pop("path"), data=kwargs)
1284
+
1285
+ @sp_endpoint("/inbound/fba/v0/items/prepDetails", method="GET")
1286
+ def list_prep_details(self, **kwargs) -> ApiResponse:
1287
+ """
1288
+ list_prep_details(self, **kwargs) -> ApiResponse
1289
+
1290
+ Get preparation details for a list of MSKUs in a specified marketplace.
1291
+
1292
+ Examples:
1293
+ literal blocks::
1294
+
1295
+ FulfillmentInboundV0().list_prep_details()
1296
+
1297
+ Args:
1298
+ **kwargs:
1299
+
1300
+ Returns:
1301
+ ApiResponse
1302
+ """
1303
+
1304
+ return self._request(kwargs.pop("path"), params=kwargs)
1305
+
1306
+ @sp_endpoint("/inbound/fba/v0/items/prepDetails", method="POST")
1307
+ def set_prep_details(self, **kwargs) -> ApiResponse:
1308
+ """
1309
+ set_prep_details(self, **kwargs) -> ApiResponse
1310
+
1311
+ Set the preparation details for a list of MSKUs in a specified marketplace.
1312
+
1313
+ Examples:
1314
+ literal blocks::
1315
+
1316
+ FulfillmentInboundV0().set_prep_details()
1317
+
1318
+ Args:
1319
+ **kwargs:
1320
+
1321
+ Returns:
1322
+ ApiResponse
1323
+ """
1324
+
1325
+ return self._request(kwargs.pop("path"), data=kwargs)
1326
+
1327
+ @sp_endpoint(
1328
+ "/inbound/fba/v0/inboundPlans/{}/shipments/{}/boxes", method="GET"
1329
+ )
1330
+ def list_shipment_boxes(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse:
1331
+ """
1332
+ list_shipment_boxes(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
1333
+
1334
+ Provides a paginated list of box packages in a shipment.
1335
+
1336
+ Examples:
1337
+ literal blocks::
1338
+
1339
+ FulfillmentInboundV0().list_shipment_boxes("value", "value")
1340
+
1341
+ Args:
1342
+ inboundPlanId: | required
1343
+ shipmentId: | required
1344
+ **kwargs:
1345
+
1346
+ Returns:
1347
+ ApiResponse
1348
+ """
1349
+
1350
+ return self._request(
1351
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1352
+ params=kwargs,
1353
+ )
1354
+
1355
+ @sp_endpoint(
1356
+ "/inbound/fba/v0/inboundPlans/{}/shipments/{}/trackingDetails",
1357
+ method="PUT",
1358
+ )
1359
+ def update_shipment_tracking_details(
1360
+ self, inboundPlanId, shipmentId, **kwargs
1361
+ ) -> ApiResponse:
1362
+ """
1363
+ update_shipment_tracking_details(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
1364
+
1365
+ Updates a shipment's tracking details.
1366
+
1367
+ Examples:
1368
+ literal blocks::
1369
+
1370
+ FulfillmentInboundV0().update_shipment_tracking_details("value", "value")
1371
+
1372
+ Args:
1373
+ inboundPlanId: | required
1374
+ shipmentId: | required
1375
+ **kwargs:
1376
+
1377
+ Returns:
1378
+ ApiResponse
1379
+ """
1380
+
1381
+ return self._request(
1382
+ fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
1383
+ data=kwargs,
1384
+ )