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
sp_api/asyncio/api/shipping/shippingV2.py CHANGED
@@ -64,179 +64,30 @@ class Shipping(AsyncBaseClient):
64
64
  async def get_rates(self, **kwargs) -> ApiResponse:
65
65
  """
66
66
  get_rates(self, **kwargs) -> ApiResponse
67
-
67
+
68
68
  Returns the available shipping service offerings.
69
-
69
+
70
70
  **Usage Plan:**
71
-
72
- ======================================
73
- Rate (requests per second)
74
- ======================================
75
- 5
76
- ======================================
77
-
71
+
72
+ ====================================== ==============
73
+ Rate (requests per second) Burst
74
+ ====================================== ==============
75
+ 80 100
76
+ ====================================== ==============
77
+
78
78
  For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
79
-
79
+
80
+ Examples:
81
+ literal blocks::
82
+
83
+ await Shipping().get_rates()
84
+
80
85
  Args:
81
- body: {
82
- "shipTo": {
83
- "name": "string",
84
- "addressLine1": "string",
85
- "addressLine2": "string",
86
- "addressLine3": "string",
87
- "companyName": "string",
88
- "stateOrRegion": "string",
89
- "city": "string",
90
- "countryCode": "st",
91
- "postalCode": "string",
92
- "email": "string",
93
- "phoneNumber": "string",
94
- "geocode": {
95
- "latitude": "string",
96
- "longitude": "string"
97
- }
98
- },
99
- "shipFrom": {
100
- "name": "string",
101
- "addressLine1": "string",
102
- "addressLine2": "string",
103
- "addressLine3": "string",
104
- "companyName": "string",
105
- "stateOrRegion": "string",
106
- "city": "string",
107
- "countryCode": "st",
108
- "postalCode": "string",
109
- "email": "string",
110
- "phoneNumber": "string",
111
- "geocode": {
112
- "latitude": "string",
113
- "longitude": "string"
114
- }
115
- },
116
- "returnTo": {
117
- "name": "string",
118
- "addressLine1": "string",
119
- "addressLine2": "string",
120
- "addressLine3": "string",
121
- "companyName": "string",
122
- "stateOrRegion": "string",
123
- "city": "string",
124
- "countryCode": "st",
125
- "postalCode": "string",
126
- "email": "string",
127
- "phoneNumber": "string",
128
- "geocode": {
129
- "latitude": "string",
130
- "longitude": "string"
131
- }
132
- },
133
- "shipDate": "2019-08-24T14:15:22Z",
134
- "shipperInstruction": {
135
- "deliveryNotes": "string"
136
- },
137
- "packages": [
138
- {
139
- "dimensions": {
140
- "length": 0,
141
- "width": 0,
142
- "height": 0,
143
- "unit": "CENTIMETER"
144
- },
145
- "weight": {
146
- "unit": "KILOGRAM",
147
- "value": 0
148
- },
149
- "insuredValue":{
150
- "value": 0.00,
151
- "unit": "EUR",
152
- },
153
- "isHazmat": False,
154
- "sellerDisplayName": "string",
155
- "charges": [
156
- {
157
- "amount": {
158
- "value": 0.00,
159
- "unit": "EUR",
160
- },
161
- "chargeType": "TAX"
162
- }
163
- ],
164
- "packageClientReferenceId": "string",
165
- "items": [
166
- {
167
- "itemValue": {
168
- "value": 0.00,
169
- "unit": "EUR",
170
- },
171
- "description": "string",
172
- "itemIdentifier": "string",
173
- "quantity": 1,
174
- "weight": {
175
- "value": 0.00,
176
- "unit": "KILOGRAM",
177
- },
178
- "liquidVolume": {
179
- "value": 0.00,
180
- "unit": "ML",
181
- },
182
- "isHazmat": False,
183
- "dangerousGoodsDetails": {
184
- "unitedNationsRegulatoryId": "string",
185
- "transportationRegulatoryClass": "string",
186
- "packingGroup": "III",
187
- "packingInstruction": "PI965_SECTION_IA",
188
- },
189
- "productType": "string",
190
- "invoiceDetails": {
191
- "invoiceNumber": "string",
192
- "invoiceDate": "2019-08-24T14:15:22Z"
193
- },
194
- "serialNumbers": ["string"],
195
- "directFulfillmentItemIdentifiers": {
196
- "lineItemID": "string",
197
- "pieceNumber": "string"
198
- }
199
- }
200
- ]
201
- }
202
- ],
203
- "valueAddedServicesDetails": {
204
- "collectOnDelivery": {
205
- "amount": {
206
- "value": 0.00,
207
- "unit": "EUR",
208
- }
209
- }
210
- },
211
- "taxDetails": [
212
- {
213
- "taxType": "GST",
214
- "taxRegistrationNumber": "string"
215
- }
216
- ],
217
- "channelDetails": {
218
- "channelType": "EXTERNAL",
219
- "amazonOrderDetails": {
220
- "orderId": "string"
221
- },
222
- "amazonShipmentDetails": {
223
- "shipmentId": "string"
224
- }
225
- },
226
- "clientReferenceDetails": [
227
- {
228
- "clientReferenceType": "IntegratorShipperId",
229
- "clientReferenceId": "string"
230
- }
231
- ],
232
- "shipmentType": "FORWARD",
233
- "destinationAccessPointDetails": {
234
- "accessPointId": "string",
235
- }
236
- }
237
-
86
+ body: GetRatesRequest | required GetRatesRequest body
87
+ x-amzn-shipping-business-id: object | Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
88
+
238
89
  Returns:
239
- ApiResponse:
90
+ ApiResponse
240
91
  """
241
92
 
242
93
  return await self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
@@ -245,47 +96,33 @@ class Shipping(AsyncBaseClient):
245
96
  async def purchase_shipment(self, **kwargs) -> ApiResponse:
246
97
  """
247
98
  purchase_shipment(self, **kwargs) -> ApiResponse
248
-
99
+
249
100
  Purchases a shipping service and returns purchase related details and documents.
250
-
251
- Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider for channelType as EXTERNAL which is for OFF-Amazon volume. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to "TOKEN_EXPIRED". If you receive this error response, you must get the rates for the shipment again.
252
-
101
+
102
+ Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to "TOKEN_EXPIRED". If you receive this error response, you must get the rates for the shipment again.
103
+
253
104
  **Usage Plan:**
254
-
255
- ======================================
256
- Rate (requests per second)
257
- ======================================
258
- 5
259
- ======================================
260
-
105
+
106
+ ====================================== ==============
107
+ Rate (requests per second) Burst
108
+ ====================================== ==============
109
+ 80 100
110
+ ====================================== ==============
111
+
261
112
  For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
262
-
113
+
114
+ Examples:
115
+ literal blocks::
116
+
117
+ await Shipping().purchase_shipment()
118
+
263
119
  Args:
264
- body: {
265
- "requestToken": "string",
266
- "rateId": "string",
267
- "requestedDocumentSpecification": {
268
- "format": "ZPL",
269
- "size": {
270
- "width": 4,
271
- "length": 6,
272
- "unit": "INCH"
273
- },
274
- "dpi": 203,
275
- "pageLayout": "DEFAULT",
276
- "needFileJoining": False,
277
- "requestedDocumentTypes": ["LABEL"]
278
- },
279
- "requestedValueAddedServices": [
280
- {
281
- "id": "string"
282
- }
283
- ],
284
- "additionalInputs": {}
285
- }
286
-
120
+ body: PurchaseShipmentRequest | required PurchaseShipmentRequest body
121
+ x-amzn-IdempotencyKey: object | A unique value which the server uses to recognize subsequent retries of the same request.
122
+ x-amzn-shipping-business-id: object | Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
123
+
287
124
  Returns:
288
- ApiResponse:
125
+ ApiResponse
289
126
  """
290
127
  return await self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
291
128
 
@@ -293,187 +130,30 @@ class Shipping(AsyncBaseClient):
293
130
  async def one_click_shipment(self, **kwargs) -> ApiResponse:
294
131
  """
295
132
  one_click_shipment(self, **kwargs) -> ApiResponse
296
-
133
+
297
134
  Purchases a shipping service identifier and returns purchase-related details and documents.
298
-
135
+
299
136
  **Usage Plan:**
300
-
301
- ======================================
302
- Rate (requests per second)
303
- ======================================
304
- 5
305
- ======================================
306
-
137
+
138
+ ====================================== ==============
139
+ Rate (requests per second) Burst
140
+ ====================================== ==============
141
+ 80 100
142
+ ====================================== ==============
143
+
307
144
  For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
308
-
145
+
146
+ Examples:
147
+ literal blocks::
148
+
149
+ await Shipping().one_click_shipment()
150
+
309
151
  Args:
310
- body: {
311
- "shipTo": {
312
- "name": "string",
313
- "addressLine1": "string",
314
- "addressLine2": "string",
315
- "addressLine3": "string",
316
- "companyName": "string",
317
- "stateOrRegion": "string",
318
- "city": "string",
319
- "countryCode": "st",
320
- "postalCode": "string",
321
- "email": "string",
322
- "phoneNumber": "string",
323
- "geocode": {
324
- "latitude": "string",
325
- "longitude": "string"
326
- }
327
- },
328
- "shipFrom": {
329
- "name": "string",
330
- "addressLine1": "string",
331
- "addressLine2": "string",
332
- "addressLine3": "string",
333
- "companyName": "string",
334
- "stateOrRegion": "string",
335
- "city": "string",
336
- "countryCode": "st",
337
- "postalCode": "string",
338
- "email": "string",
339
- "phoneNumber": "string",
340
- "geocode": {
341
- "latitude": "string",
342
- "longitude": "string"
343
- }
344
- },
345
- "returnTo": {
346
- "name": "string",
347
- "addressLine1": "string",
348
- "addressLine2": "string",
349
- "addressLine3": "string",
350
- "companyName": "string",
351
- "stateOrRegion": "string",
352
- "city": "string",
353
- "countryCode": "st",
354
- "postalCode": "string",
355
- "email": "string",
356
- "phoneNumber": "string",
357
- "geocode": {
358
- "latitude": "string",
359
- "longitude": "string"
360
- }
361
- },
362
- "shipDate": "2019-08-24T14:15:22Z",
363
- "packages": [
364
- {
365
- "dimensions": {
366
- "length": 0,
367
- "width": 0,
368
- "height": 0,
369
- "unit": "CENTIMETER"
370
- },
371
- "weight": {
372
- "unit": "KILOGRAM",
373
- "value": 0
374
- },
375
- "insuredValue":{
376
- "value": 0.00,
377
- "unit": "EUR",
378
- },
379
- "isHazmat": False,
380
- "sellerDisplayName": "string",
381
- "charges": [
382
- {
383
- "amount": {
384
- "value": 0.00,
385
- "unit": "EUR",
386
- },
387
- "chargeType": "TAX"
388
- }
389
- ],
390
- "packageClientReferenceId": "string",
391
- "items": [
392
- {
393
- "itemValue": {
394
- "value": 0.00,
395
- "unit": "EUR",
396
- },
397
- "description": "string",
398
- "itemIdentifier": "string",
399
- "quantity": 1,
400
- "weight": {
401
- "value": 0.00,
402
- "unit": "KILOGRAM",
403
- },
404
- "liquidVolume": {
405
- "value": 0.00,
406
- "unit": "ML",
407
- },
408
- "isHazmat": False,
409
- "dangerousGoodsDetails": {
410
- "unitedNationsRegulatoryId": "string",
411
- "transportationRegulatoryClass": "string",
412
- "packingGroup": "III",
413
- "packingInstruction": "PI965_SECTION_IA",
414
- },
415
- "productType": "string",
416
- "invoiceDetails": {
417
- "invoiceNumber": "string",
418
- "invoiceDate": "2019-08-24T14:15:22Z"
419
- },
420
- "serialNumbers": ["string"],
421
- "directFulfillmentItemIdentifiers": {
422
- "lineItemID": "string",
423
- "pieceNumber": "string"
424
- }
425
- }
426
- ]
427
- }
428
- ],
429
- "valueAddedServicesDetails": [
430
- "id": "string",
431
- "amount": {
432
- "value": 0.00,
433
- "unit": "EUR",
434
- },
435
- ],
436
- "taxDetails": [
437
- {
438
- "taxType": "GST",
439
- "taxRegistrationNumber": "string"
440
- }
441
- ],
442
- "channelDetails": {
443
- "channelType": "EXTERNAL",
444
- "amazonOrderDetails": {
445
- "orderId": "string"
446
- },
447
- "amazonShipmentDetails": {
448
- "shipmentId": "string"
449
- }
450
- },
451
- "labelSpecifications": {
452
- "format": "ZPL",
453
- "size": {
454
- "width": 4,
455
- "length": 6,
456
- "unit": "INCH"
457
- },
458
- "dpi": 203,
459
- "pageLayout": "DEFAULT",
460
- "needFileJoining": False,
461
- "requestedDocumentTypes": ["LABEL"]
462
- },
463
- "serviceSelection": {
464
- "serviceId": ["prime-premium-uk-mfn", "std-uk-mfn", "econ-uk-mfn"]
465
- },
466
- "shipperInstruction": {
467
- "deliveryNotes": "string"
468
- },
469
- "destinationAccessPointDetails": {
470
- "accessPointId": "string"
471
- }
472
-
473
- }
474
-
152
+ body: OneClickShipmentRequest | required OneClickShipmentRequest body
153
+ x-amzn-shipping-business-id: object | Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
154
+
475
155
  Returns:
476
- ApiResponse:
156
+ ApiResponse
477
157
  """
478
158
  return await self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
479
159
 
@@ -481,25 +161,31 @@ class Shipping(AsyncBaseClient):
481
161
  async def get_tracking(self, **kwargs) -> ApiResponse:
482
162
  """
483
163
  get_tracking(self, **kwargs) -> ApiResponse
484
-
164
+
485
165
  Returns tracking information for a purchased shipment.
486
-
166
+
487
167
  **Usage Plan:**
488
-
489
- ======================================
490
- Rate (requests per second)
491
- ======================================
492
- 5
493
- ======================================
494
-
168
+
169
+ ====================================== ==============
170
+ Rate (requests per second) Burst
171
+ ====================================== ==============
172
+ 80 100
173
+ ====================================== ==============
174
+
495
175
  For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
496
-
176
+
177
+ Examples:
178
+ literal blocks::
179
+
180
+ await Shipping().get_tracking()
181
+
497
182
  Args:
498
- key trackingId:string | * REQUIRED A carrier-generated tracking identifier originally returned by the purchaseShipment operation.
499
- key carrierId:string | * REQUIRED A carrier identifier originally returned by the getRates operation for the selected rate.
500
-
183
+ key trackingId: object | required A carrier-generated tracking identifier originally returned by the purchaseShipment operation.
184
+ key carrierId: object | required A carrier identifier originally returned by the getRates operation for the selected rate.
185
+ x-amzn-shipping-business-id: object | Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
186
+
501
187
  Returns:
502
- ApiResponse:
188
+ ApiResponse
503
189
  """
504
190
  return await self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)
505
191
 
@@ -507,27 +193,33 @@ class Shipping(AsyncBaseClient):
507
193
  async def get_shipment_documents(self, shipmentId, **kwargs) -> ApiResponse:
508
194
  """
509
195
  get_shipment_documents(self, shipmentId, **kwargs) -> ApiResponse
510
-
196
+
511
197
  Returns the shipping documents associated with a package in a shipment.
512
-
198
+
513
199
  **Usage Plan:**
514
-
515
- ======================================
516
- Rate (requests per second)
517
- ======================================
518
- 5
519
- ======================================
520
-
200
+
201
+ ====================================== ==============
202
+ Rate (requests per second) Burst
203
+ ====================================== ==============
204
+ 80 100
205
+ ====================================== ==============
206
+
521
207
  For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
522
-
208
+
209
+ Examples:
210
+ literal blocks::
211
+
212
+ await Shipping().get_shipment_documents("value")
213
+
523
214
  Args:
524
- shipmentId:string | * REQUIRED The shipment identifier originally returned by the purchaseShipment operation.
525
- key packageClientReferenceId:string | * REQUIRED The shipment identifier originally returned by the purchaseShipment operation.
526
- key format:string | The file format of the document. Must be one of the supported formats returned by the getRates operation.
527
- key dpi:number | The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.
528
-
215
+ shipmentId: object | required The shipment identifier originally returned by the purchaseShipment operation.
216
+ key packageClientReferenceId: object | required The package client reference identifier originally provided in the request body parameter for the getRates operation.
217
+ key format: object | The file format of the document. Must be one of the supported formats returned by the getRates operation.
218
+ key dpi: object | The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.
219
+ x-amzn-shipping-business-id: object | Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
220
+
529
221
  Returns:
530
- ApiResponse:
222
+ ApiResponse
531
223
  """
532
224
 
533
225
  return await self._request(
@@ -540,24 +232,30 @@ class Shipping(AsyncBaseClient):
540
232
  async def cancel_shipment(self, shipmentId, **kwargs) -> ApiResponse:
541
233
  """
542
234
  cancel_shipment(self, shipmentId, **kwargs) -> ApiResponse
543
-
235
+
544
236
  Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled.
545
-
237
+
546
238
  **Usage Plan:**
547
-
548
- ======================================
549
- Rate (requests per second)
550
- ======================================
551
- 5
552
- ======================================
553
-
239
+
240
+ ====================================== ==============
241
+ Rate (requests per second) Burst
242
+ ====================================== ==============
243
+ 80 100
244
+ ====================================== ==============
245
+
554
246
  For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
555
-
247
+
248
+ Examples:
249
+ literal blocks::
250
+
251
+ await Shipping().cancel_shipment("value")
252
+
556
253
  Args:
557
- shipmentId:string | * REQUIRED The shipment identifier originally returned by the purchaseShipment operation.
558
-
254
+ shipmentId: object | required The shipment identifier originally returned by the purchaseShipment operation.
255
+ x-amzn-shipping-business-id: object | Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
256
+
559
257
  Returns:
560
- ApiResponse:
258
+ ApiResponse
561
259
  """
562
260
  return await self._request(
563
261
  fill_query_params(kwargs.pop("path"), shipmentId),
@@ -569,26 +267,32 @@ class Shipping(AsyncBaseClient):
569
267
  async def get_access_points(self, **kwargs) -> ApiResponse:
570
268
  """
571
269
  get_access_points(self, **kwargs) -> ApiResponse
572
-
270
+
573
271
  Returns a list of access points in proximity of input postal code.
574
-
272
+
575
273
  **Usage Plan:**
576
-
577
- ======================================
578
- Rate (requests per second)
579
- ======================================
580
- 5
581
- ======================================
582
-
274
+
275
+ ====================================== ==============
276
+ Rate (requests per second) Burst
277
+ ====================================== ==============
278
+ 80 100
279
+ ====================================== ==============
280
+
583
281
  For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
584
-
282
+
283
+ Examples:
284
+ literal blocks::
285
+
286
+ await Shipping().get_access_points()
287
+
585
288
  Args:
586
- key accessPointTypes:string | * REQUIRED
587
- key countryCode:string | * REQUIRED
588
- key postalCode:string | * REQUIRED
589
-
289
+ key accessPointTypes: object | required Access point types
290
+ key countryCode: object | required Country code for access point
291
+ key postalCode: object | required postal code for access point
292
+ x-amzn-shipping-business-id: object | Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
293
+
590
294
  Returns:
591
- ApiResponse:
295
+ ApiResponse
592
296
  """
593
297
  return await self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)
594
298
 
@@ -596,31 +300,30 @@ class Shipping(AsyncBaseClient):
596
300
  async def submit_ndr_feedback(self, **kwargs) -> ApiResponse:
597
301
  """
598
302
  submit_ndr_feedback(self, **kwargs) -> ApiResponse
599
-
303
+
600
304
  This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment.
601
-
305
+
602
306
  **Usage Plan:**
603
-
604
- ======================================
605
- Rate (requests per second)
606
- ======================================
607
- 5
608
- ======================================
609
-
307
+
308
+ ====================================== ==============
309
+ Rate (requests per second) Burst
310
+ ====================================== ==============
311
+ 80 100
312
+ ====================================== ==============
313
+
610
314
  For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
611
-
315
+
316
+ Examples:
317
+ literal blocks::
318
+
319
+ await Shipping().submit_ndr_feedback()
320
+
612
321
  Args:
613
- body: {
614
- "trackingId": "string",
615
- "ndrAction": "RTO",
616
- "ndrRequestData": {
617
- "rescheduleDate": "2024-12-12T05:24:00.00Z",
618
- "additionalAddressNotes": "string"
619
- }
620
- }
621
-
322
+ body: SubmitNdrFeedbackRequest | required Request body for ndrFeedback operation
323
+ x-amzn-shipping-business-id: object | Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
324
+
622
325
  Returns:
623
- ApiResponse:
326
+ ApiResponse
624
327
  """
625
328
  return await self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
626
329
 
@@ -628,24 +331,30 @@ class Shipping(AsyncBaseClient):
628
331
  async def get_additional_inputs(self, **kwargs) -> ApiResponse:
629
332
  """
630
333
  get_additional_inputs(self, **kwargs) -> ApiResponse
631
-
334
+
632
335
  Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase.
633
-
336
+
634
337
  **Usage Plan:**
635
-
636
- ======================================
637
- Rate (requests per second)
638
- ======================================
639
- 5
640
- ======================================
641
-
338
+
339
+ ====================================== ==============
340
+ Rate (requests per second) Burst
341
+ ====================================== ==============
342
+ 80 100
343
+ ====================================== ==============
344
+
642
345
  For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
643
-
346
+
347
+ Examples:
348
+ literal blocks::
349
+
350
+ await Shipping().get_additional_inputs()
351
+
644
352
  Args:
645
- key requestToken:string | * REQUIRED The request token returned in the response to the getRates operation.
646
- key rateId:string | * REQUIRED The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.
647
-
353
+ key requestToken: object | required The request token returned in the response to the getRates operation.
354
+ key rateId: object | required The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.
355
+ x-amzn-shipping-business-id: object | Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
356
+
648
357
  Returns:
649
- ApiResponse:
358
+ ApiResponse
650
359
  """
651
360
  return await self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)