@sp-api-sdk/fulfillment-inbound-api-2024-03-20 3.3.9 → 4.0.0

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 (455) hide show
  1. package/README.md +4 -4
  2. package/dist/index.cjs +3287 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +5981 -0
  5. package/dist/index.d.ts +5981 -0
  6. package/dist/index.js +3228 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +23 -12
  9. package/dist/cjs/api-model/api/fulfillment-inbound-api.js +0 -3131
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/address-input.js +0 -15
  16. package/dist/cjs/api-model/models/address.js +0 -15
  17. package/dist/cjs/api-model/models/all-owners-constraint.js +0 -22
  18. package/dist/cjs/api-model/models/appointment-slot-time.js +0 -15
  19. package/dist/cjs/api-model/models/appointment-slot.js +0 -15
  20. package/dist/cjs/api-model/models/box-content-information-source.js +0 -24
  21. package/dist/cjs/api-model/models/box-input.js +0 -15
  22. package/dist/cjs/api-model/models/box-requirements.js +0 -15
  23. package/dist/cjs/api-model/models/box-update-input.js +0 -15
  24. package/dist/cjs/api-model/models/box.js +0 -15
  25. package/dist/cjs/api-model/models/cancel-inbound-plan-response.js +0 -15
  26. package/dist/cjs/api-model/models/cancel-self-ship-appointment-request.js +0 -15
  27. package/dist/cjs/api-model/models/cancel-self-ship-appointment-response.js +0 -15
  28. package/dist/cjs/api-model/models/carrier-appointment.js +0 -15
  29. package/dist/cjs/api-model/models/carrier.js +0 -15
  30. package/dist/cjs/api-model/models/compliance-detail.js +0 -15
  31. package/dist/cjs/api-model/models/confirm-delivery-window-options-response.js +0 -15
  32. package/dist/cjs/api-model/models/confirm-packing-option-response.js +0 -15
  33. package/dist/cjs/api-model/models/confirm-placement-option-response.js +0 -15
  34. package/dist/cjs/api-model/models/confirm-shipment-content-update-preview-response.js +0 -15
  35. package/dist/cjs/api-model/models/confirm-transportation-options-request.js +0 -15
  36. package/dist/cjs/api-model/models/confirm-transportation-options-response.js +0 -15
  37. package/dist/cjs/api-model/models/contact-information.js +0 -15
  38. package/dist/cjs/api-model/models/content-update-preview.js +0 -15
  39. package/dist/cjs/api-model/models/create-inbound-plan-request.js +0 -15
  40. package/dist/cjs/api-model/models/create-inbound-plan-response.js +0 -15
  41. package/dist/cjs/api-model/models/create-marketplace-item-labels-request.js +0 -15
  42. package/dist/cjs/api-model/models/create-marketplace-item-labels-response.js +0 -15
  43. package/dist/cjs/api-model/models/currency.js +0 -15
  44. package/dist/cjs/api-model/models/custom-placement-input.js +0 -15
  45. package/dist/cjs/api-model/models/dates.js +0 -15
  46. package/dist/cjs/api-model/models/delivery-window-option.js +0 -15
  47. package/dist/cjs/api-model/models/dimensions.js +0 -15
  48. package/dist/cjs/api-model/models/document-download.js +0 -15
  49. package/dist/cjs/api-model/models/error-list.js +0 -15
  50. package/dist/cjs/api-model/models/freight-information.js +0 -15
  51. package/dist/cjs/api-model/models/generate-delivery-window-options-response.js +0 -15
  52. package/dist/cjs/api-model/models/generate-packing-options-response.js +0 -15
  53. package/dist/cjs/api-model/models/generate-placement-options-request.js +0 -15
  54. package/dist/cjs/api-model/models/generate-placement-options-response.js +0 -15
  55. package/dist/cjs/api-model/models/generate-self-ship-appointment-slots-request.js +0 -15
  56. package/dist/cjs/api-model/models/generate-self-ship-appointment-slots-response.js +0 -15
  57. package/dist/cjs/api-model/models/generate-shipment-content-update-previews-request.js +0 -15
  58. package/dist/cjs/api-model/models/generate-shipment-content-update-previews-response.js +0 -15
  59. package/dist/cjs/api-model/models/generate-transportation-options-request.js +0 -15
  60. package/dist/cjs/api-model/models/generate-transportation-options-response.js +0 -15
  61. package/dist/cjs/api-model/models/get-delivery-challan-document-response.js +0 -15
  62. package/dist/cjs/api-model/models/get-self-ship-appointment-slots-response.js +0 -15
  63. package/dist/cjs/api-model/models/inbound-operation-status.js +0 -15
  64. package/dist/cjs/api-model/models/inbound-plan-summary.js +0 -15
  65. package/dist/cjs/api-model/models/inbound-plan.js +0 -15
  66. package/dist/cjs/api-model/models/incentive.js +0 -15
  67. package/dist/cjs/api-model/models/index.js +0 -156
  68. package/dist/cjs/api-model/models/item-input.js +0 -15
  69. package/dist/cjs/api-model/models/item-label-page-type.js +0 -32
  70. package/dist/cjs/api-model/models/item.js +0 -15
  71. package/dist/cjs/api-model/models/label-owner.js +0 -24
  72. package/dist/cjs/api-model/models/label-print-type.js +0 -23
  73. package/dist/cjs/api-model/models/list-delivery-window-options-response.js +0 -15
  74. package/dist/cjs/api-model/models/list-inbound-plan-boxes-response.js +0 -15
  75. package/dist/cjs/api-model/models/list-inbound-plan-items-response.js +0 -15
  76. package/dist/cjs/api-model/models/list-inbound-plan-pallets-response.js +0 -15
  77. package/dist/cjs/api-model/models/list-inbound-plans-response.js +0 -15
  78. package/dist/cjs/api-model/models/list-item-compliance-details-response.js +0 -15
  79. package/dist/cjs/api-model/models/list-packing-group-boxes-response.js +0 -15
  80. package/dist/cjs/api-model/models/list-packing-group-items-response.js +0 -15
  81. package/dist/cjs/api-model/models/list-packing-options-response.js +0 -15
  82. package/dist/cjs/api-model/models/list-placement-options-response.js +0 -15
  83. package/dist/cjs/api-model/models/list-prep-details-response.js +0 -15
  84. package/dist/cjs/api-model/models/list-shipment-boxes-response.js +0 -15
  85. package/dist/cjs/api-model/models/list-shipment-content-update-previews-response.js +0 -15
  86. package/dist/cjs/api-model/models/list-shipment-items-response.js +0 -15
  87. package/dist/cjs/api-model/models/list-shipment-pallets-response.js +0 -15
  88. package/dist/cjs/api-model/models/list-transportation-options-response.js +0 -15
  89. package/dist/cjs/api-model/models/ltl-tracking-detail-input.js +0 -15
  90. package/dist/cjs/api-model/models/ltl-tracking-detail.js +0 -15
  91. package/dist/cjs/api-model/models/model-error.js +0 -15
  92. package/dist/cjs/api-model/models/msku-prep-detail-input.js +0 -15
  93. package/dist/cjs/api-model/models/msku-prep-detail.js +0 -15
  94. package/dist/cjs/api-model/models/msku-quantity.js +0 -15
  95. package/dist/cjs/api-model/models/operation-problem.js +0 -15
  96. package/dist/cjs/api-model/models/operation-status.js +0 -24
  97. package/dist/cjs/api-model/models/owner-constraint.js +0 -24
  98. package/dist/cjs/api-model/models/package-grouping-input.js +0 -15
  99. package/dist/cjs/api-model/models/packing-configuration.js +0 -15
  100. package/dist/cjs/api-model/models/packing-option-summary.js +0 -15
  101. package/dist/cjs/api-model/models/packing-option.js +0 -15
  102. package/dist/cjs/api-model/models/pagination.js +0 -15
  103. package/dist/cjs/api-model/models/pallet-input.js +0 -15
  104. package/dist/cjs/api-model/models/pallet.js +0 -15
  105. package/dist/cjs/api-model/models/placement-option-summary.js +0 -15
  106. package/dist/cjs/api-model/models/placement-option.js +0 -15
  107. package/dist/cjs/api-model/models/prep-category.js +0 -35
  108. package/dist/cjs/api-model/models/prep-instruction.js +0 -15
  109. package/dist/cjs/api-model/models/prep-owner.js +0 -24
  110. package/dist/cjs/api-model/models/prep-type.js +0 -37
  111. package/dist/cjs/api-model/models/quote.js +0 -15
  112. package/dist/cjs/api-model/models/reason-comment.js +0 -30
  113. package/dist/cjs/api-model/models/region.js +0 -15
  114. package/dist/cjs/api-model/models/requested-updates.js +0 -15
  115. package/dist/cjs/api-model/models/schedule-self-ship-appointment-request.js +0 -15
  116. package/dist/cjs/api-model/models/schedule-self-ship-appointment-response.js +0 -15
  117. package/dist/cjs/api-model/models/selected-delivery-window.js +0 -15
  118. package/dist/cjs/api-model/models/self-ship-appointment-details.js +0 -15
  119. package/dist/cjs/api-model/models/self-ship-appointment-slots-availability.js +0 -15
  120. package/dist/cjs/api-model/models/set-packing-information-request.js +0 -15
  121. package/dist/cjs/api-model/models/set-packing-information-response.js +0 -15
  122. package/dist/cjs/api-model/models/set-prep-details-request.js +0 -15
  123. package/dist/cjs/api-model/models/set-prep-details-response.js +0 -15
  124. package/dist/cjs/api-model/models/shipment-destination.js +0 -15
  125. package/dist/cjs/api-model/models/shipment-source.js +0 -15
  126. package/dist/cjs/api-model/models/shipment-summary.js +0 -15
  127. package/dist/cjs/api-model/models/shipment-transportation-configuration.js +0 -15
  128. package/dist/cjs/api-model/models/shipment.js +0 -15
  129. package/dist/cjs/api-model/models/shipping-configuration.js +0 -15
  130. package/dist/cjs/api-model/models/shipping-requirements.js +0 -15
  131. package/dist/cjs/api-model/models/spd-tracking-detail-input.js +0 -15
  132. package/dist/cjs/api-model/models/spd-tracking-detail.js +0 -15
  133. package/dist/cjs/api-model/models/spd-tracking-item-input.js +0 -15
  134. package/dist/cjs/api-model/models/spd-tracking-item.js +0 -15
  135. package/dist/cjs/api-model/models/stackability.js +0 -23
  136. package/dist/cjs/api-model/models/tax-details.js +0 -15
  137. package/dist/cjs/api-model/models/tax-rate.js +0 -15
  138. package/dist/cjs/api-model/models/tracking-details-input.js +0 -15
  139. package/dist/cjs/api-model/models/tracking-details.js +0 -15
  140. package/dist/cjs/api-model/models/transportation-option.js +0 -15
  141. package/dist/cjs/api-model/models/transportation-selection.js +0 -15
  142. package/dist/cjs/api-model/models/unit-of-measurement.js +0 -23
  143. package/dist/cjs/api-model/models/unit-of-weight.js +0 -23
  144. package/dist/cjs/api-model/models/update-inbound-plan-name-request.js +0 -15
  145. package/dist/cjs/api-model/models/update-item-compliance-details-request.js +0 -15
  146. package/dist/cjs/api-model/models/update-item-compliance-details-response.js +0 -15
  147. package/dist/cjs/api-model/models/update-shipment-name-request.js +0 -15
  148. package/dist/cjs/api-model/models/update-shipment-source-address-request.js +0 -15
  149. package/dist/cjs/api-model/models/update-shipment-source-address-response.js +0 -15
  150. package/dist/cjs/api-model/models/update-shipment-tracking-details-request.js +0 -15
  151. package/dist/cjs/api-model/models/update-shipment-tracking-details-response.js +0 -15
  152. package/dist/cjs/api-model/models/weight-range.js +0 -15
  153. package/dist/cjs/api-model/models/weight.js +0 -15
  154. package/dist/cjs/api-model/models/window-input.js +0 -15
  155. package/dist/cjs/api-model/models/window.js +0 -15
  156. package/dist/cjs/client.js +0 -13
  157. package/dist/cjs/index.js +0 -19
  158. package/dist/es/api-model/api/fulfillment-inbound-api.js +0 -3121
  159. package/dist/es/api-model/api.js +0 -14
  160. package/dist/es/api-model/base.js +0 -44
  161. package/dist/es/api-model/common.js +0 -110
  162. package/dist/es/api-model/configuration.js +0 -94
  163. package/dist/es/api-model/index.js +0 -16
  164. package/dist/es/api-model/models/address-input.js +0 -14
  165. package/dist/es/api-model/models/address.js +0 -14
  166. package/dist/es/api-model/models/all-owners-constraint.js +0 -19
  167. package/dist/es/api-model/models/appointment-slot-time.js +0 -14
  168. package/dist/es/api-model/models/appointment-slot.js +0 -14
  169. package/dist/es/api-model/models/box-content-information-source.js +0 -21
  170. package/dist/es/api-model/models/box-input.js +0 -14
  171. package/dist/es/api-model/models/box-requirements.js +0 -14
  172. package/dist/es/api-model/models/box-update-input.js +0 -14
  173. package/dist/es/api-model/models/box.js +0 -14
  174. package/dist/es/api-model/models/cancel-inbound-plan-response.js +0 -14
  175. package/dist/es/api-model/models/cancel-self-ship-appointment-request.js +0 -14
  176. package/dist/es/api-model/models/cancel-self-ship-appointment-response.js +0 -14
  177. package/dist/es/api-model/models/carrier-appointment.js +0 -14
  178. package/dist/es/api-model/models/carrier.js +0 -14
  179. package/dist/es/api-model/models/compliance-detail.js +0 -14
  180. package/dist/es/api-model/models/confirm-delivery-window-options-response.js +0 -14
  181. package/dist/es/api-model/models/confirm-packing-option-response.js +0 -14
  182. package/dist/es/api-model/models/confirm-placement-option-response.js +0 -14
  183. package/dist/es/api-model/models/confirm-shipment-content-update-preview-response.js +0 -14
  184. package/dist/es/api-model/models/confirm-transportation-options-request.js +0 -14
  185. package/dist/es/api-model/models/confirm-transportation-options-response.js +0 -14
  186. package/dist/es/api-model/models/contact-information.js +0 -14
  187. package/dist/es/api-model/models/content-update-preview.js +0 -14
  188. package/dist/es/api-model/models/create-inbound-plan-request.js +0 -14
  189. package/dist/es/api-model/models/create-inbound-plan-response.js +0 -14
  190. package/dist/es/api-model/models/create-marketplace-item-labels-request.js +0 -14
  191. package/dist/es/api-model/models/create-marketplace-item-labels-response.js +0 -14
  192. package/dist/es/api-model/models/currency.js +0 -14
  193. package/dist/es/api-model/models/custom-placement-input.js +0 -14
  194. package/dist/es/api-model/models/dates.js +0 -14
  195. package/dist/es/api-model/models/delivery-window-option.js +0 -14
  196. package/dist/es/api-model/models/dimensions.js +0 -14
  197. package/dist/es/api-model/models/document-download.js +0 -14
  198. package/dist/es/api-model/models/error-list.js +0 -14
  199. package/dist/es/api-model/models/freight-information.js +0 -14
  200. package/dist/es/api-model/models/generate-delivery-window-options-response.js +0 -14
  201. package/dist/es/api-model/models/generate-packing-options-response.js +0 -14
  202. package/dist/es/api-model/models/generate-placement-options-request.js +0 -14
  203. package/dist/es/api-model/models/generate-placement-options-response.js +0 -14
  204. package/dist/es/api-model/models/generate-self-ship-appointment-slots-request.js +0 -14
  205. package/dist/es/api-model/models/generate-self-ship-appointment-slots-response.js +0 -14
  206. package/dist/es/api-model/models/generate-shipment-content-update-previews-request.js +0 -14
  207. package/dist/es/api-model/models/generate-shipment-content-update-previews-response.js +0 -14
  208. package/dist/es/api-model/models/generate-transportation-options-request.js +0 -14
  209. package/dist/es/api-model/models/generate-transportation-options-response.js +0 -14
  210. package/dist/es/api-model/models/get-delivery-challan-document-response.js +0 -14
  211. package/dist/es/api-model/models/get-self-ship-appointment-slots-response.js +0 -14
  212. package/dist/es/api-model/models/inbound-operation-status.js +0 -14
  213. package/dist/es/api-model/models/inbound-plan-summary.js +0 -14
  214. package/dist/es/api-model/models/inbound-plan.js +0 -14
  215. package/dist/es/api-model/models/incentive.js +0 -14
  216. package/dist/es/api-model/models/index.js +0 -140
  217. package/dist/es/api-model/models/item-input.js +0 -14
  218. package/dist/es/api-model/models/item-label-page-type.js +0 -29
  219. package/dist/es/api-model/models/item.js +0 -14
  220. package/dist/es/api-model/models/label-owner.js +0 -21
  221. package/dist/es/api-model/models/label-print-type.js +0 -20
  222. package/dist/es/api-model/models/list-delivery-window-options-response.js +0 -14
  223. package/dist/es/api-model/models/list-inbound-plan-boxes-response.js +0 -14
  224. package/dist/es/api-model/models/list-inbound-plan-items-response.js +0 -14
  225. package/dist/es/api-model/models/list-inbound-plan-pallets-response.js +0 -14
  226. package/dist/es/api-model/models/list-inbound-plans-response.js +0 -14
  227. package/dist/es/api-model/models/list-item-compliance-details-response.js +0 -14
  228. package/dist/es/api-model/models/list-packing-group-boxes-response.js +0 -14
  229. package/dist/es/api-model/models/list-packing-group-items-response.js +0 -14
  230. package/dist/es/api-model/models/list-packing-options-response.js +0 -14
  231. package/dist/es/api-model/models/list-placement-options-response.js +0 -14
  232. package/dist/es/api-model/models/list-prep-details-response.js +0 -14
  233. package/dist/es/api-model/models/list-shipment-boxes-response.js +0 -14
  234. package/dist/es/api-model/models/list-shipment-content-update-previews-response.js +0 -14
  235. package/dist/es/api-model/models/list-shipment-items-response.js +0 -14
  236. package/dist/es/api-model/models/list-shipment-pallets-response.js +0 -14
  237. package/dist/es/api-model/models/list-transportation-options-response.js +0 -14
  238. package/dist/es/api-model/models/ltl-tracking-detail-input.js +0 -14
  239. package/dist/es/api-model/models/ltl-tracking-detail.js +0 -14
  240. package/dist/es/api-model/models/model-error.js +0 -14
  241. package/dist/es/api-model/models/msku-prep-detail-input.js +0 -14
  242. package/dist/es/api-model/models/msku-prep-detail.js +0 -14
  243. package/dist/es/api-model/models/msku-quantity.js +0 -14
  244. package/dist/es/api-model/models/operation-problem.js +0 -14
  245. package/dist/es/api-model/models/operation-status.js +0 -21
  246. package/dist/es/api-model/models/owner-constraint.js +0 -21
  247. package/dist/es/api-model/models/package-grouping-input.js +0 -14
  248. package/dist/es/api-model/models/packing-configuration.js +0 -14
  249. package/dist/es/api-model/models/packing-option-summary.js +0 -14
  250. package/dist/es/api-model/models/packing-option.js +0 -14
  251. package/dist/es/api-model/models/pagination.js +0 -14
  252. package/dist/es/api-model/models/pallet-input.js +0 -14
  253. package/dist/es/api-model/models/pallet.js +0 -14
  254. package/dist/es/api-model/models/placement-option-summary.js +0 -14
  255. package/dist/es/api-model/models/placement-option.js +0 -14
  256. package/dist/es/api-model/models/prep-category.js +0 -32
  257. package/dist/es/api-model/models/prep-instruction.js +0 -14
  258. package/dist/es/api-model/models/prep-owner.js +0 -21
  259. package/dist/es/api-model/models/prep-type.js +0 -34
  260. package/dist/es/api-model/models/quote.js +0 -14
  261. package/dist/es/api-model/models/reason-comment.js +0 -27
  262. package/dist/es/api-model/models/region.js +0 -14
  263. package/dist/es/api-model/models/requested-updates.js +0 -14
  264. package/dist/es/api-model/models/schedule-self-ship-appointment-request.js +0 -14
  265. package/dist/es/api-model/models/schedule-self-ship-appointment-response.js +0 -14
  266. package/dist/es/api-model/models/selected-delivery-window.js +0 -14
  267. package/dist/es/api-model/models/self-ship-appointment-details.js +0 -14
  268. package/dist/es/api-model/models/self-ship-appointment-slots-availability.js +0 -14
  269. package/dist/es/api-model/models/set-packing-information-request.js +0 -14
  270. package/dist/es/api-model/models/set-packing-information-response.js +0 -14
  271. package/dist/es/api-model/models/set-prep-details-request.js +0 -14
  272. package/dist/es/api-model/models/set-prep-details-response.js +0 -14
  273. package/dist/es/api-model/models/shipment-destination.js +0 -14
  274. package/dist/es/api-model/models/shipment-source.js +0 -14
  275. package/dist/es/api-model/models/shipment-summary.js +0 -14
  276. package/dist/es/api-model/models/shipment-transportation-configuration.js +0 -14
  277. package/dist/es/api-model/models/shipment.js +0 -14
  278. package/dist/es/api-model/models/shipping-configuration.js +0 -14
  279. package/dist/es/api-model/models/shipping-requirements.js +0 -14
  280. package/dist/es/api-model/models/spd-tracking-detail-input.js +0 -14
  281. package/dist/es/api-model/models/spd-tracking-detail.js +0 -14
  282. package/dist/es/api-model/models/spd-tracking-item-input.js +0 -14
  283. package/dist/es/api-model/models/spd-tracking-item.js +0 -14
  284. package/dist/es/api-model/models/stackability.js +0 -20
  285. package/dist/es/api-model/models/tax-details.js +0 -14
  286. package/dist/es/api-model/models/tax-rate.js +0 -14
  287. package/dist/es/api-model/models/tracking-details-input.js +0 -14
  288. package/dist/es/api-model/models/tracking-details.js +0 -14
  289. package/dist/es/api-model/models/transportation-option.js +0 -14
  290. package/dist/es/api-model/models/transportation-selection.js +0 -14
  291. package/dist/es/api-model/models/unit-of-measurement.js +0 -20
  292. package/dist/es/api-model/models/unit-of-weight.js +0 -20
  293. package/dist/es/api-model/models/update-inbound-plan-name-request.js +0 -14
  294. package/dist/es/api-model/models/update-item-compliance-details-request.js +0 -14
  295. package/dist/es/api-model/models/update-item-compliance-details-response.js +0 -14
  296. package/dist/es/api-model/models/update-shipment-name-request.js +0 -14
  297. package/dist/es/api-model/models/update-shipment-source-address-request.js +0 -14
  298. package/dist/es/api-model/models/update-shipment-source-address-response.js +0 -14
  299. package/dist/es/api-model/models/update-shipment-tracking-details-request.js +0 -14
  300. package/dist/es/api-model/models/update-shipment-tracking-details-response.js +0 -14
  301. package/dist/es/api-model/models/weight-range.js +0 -14
  302. package/dist/es/api-model/models/weight.js +0 -14
  303. package/dist/es/api-model/models/window-input.js +0 -14
  304. package/dist/es/api-model/models/window.js +0 -14
  305. package/dist/es/client.js +0 -9
  306. package/dist/es/index.js +0 -3
  307. package/dist/types/api-model/api/fulfillment-inbound-api.d.ts +0 -2231
  308. package/dist/types/api-model/api.d.ts +0 -12
  309. package/dist/types/api-model/base.d.ts +0 -42
  310. package/dist/types/api-model/common.d.ts +0 -34
  311. package/dist/types/api-model/configuration.d.ts +0 -98
  312. package/dist/types/api-model/index.d.ts +0 -14
  313. package/dist/types/api-model/models/address-input.d.ts +0 -60
  314. package/dist/types/api-model/models/address.d.ts +0 -60
  315. package/dist/types/api-model/models/all-owners-constraint.d.ts +0 -18
  316. package/dist/types/api-model/models/appointment-slot-time.d.ts +0 -24
  317. package/dist/types/api-model/models/appointment-slot.d.ts +0 -22
  318. package/dist/types/api-model/models/box-content-information-source.d.ts +0 -20
  319. package/dist/types/api-model/models/box-input.d.ts +0 -31
  320. package/dist/types/api-model/models/box-requirements.d.ts +0 -18
  321. package/dist/types/api-model/models/box-update-input.d.ts +0 -35
  322. package/dist/types/api-model/models/box.d.ts +0 -53
  323. package/dist/types/api-model/models/cancel-inbound-plan-response.d.ts +0 -20
  324. package/dist/types/api-model/models/cancel-self-ship-appointment-request.d.ts +0 -18
  325. package/dist/types/api-model/models/cancel-self-ship-appointment-response.d.ts +0 -20
  326. package/dist/types/api-model/models/carrier-appointment.d.ts +0 -24
  327. package/dist/types/api-model/models/carrier.d.ts +0 -24
  328. package/dist/types/api-model/models/compliance-detail.d.ts +0 -30
  329. package/dist/types/api-model/models/confirm-delivery-window-options-response.d.ts +0 -20
  330. package/dist/types/api-model/models/confirm-packing-option-response.d.ts +0 -20
  331. package/dist/types/api-model/models/confirm-placement-option-response.d.ts +0 -20
  332. package/dist/types/api-model/models/confirm-shipment-content-update-preview-response.d.ts +0 -20
  333. package/dist/types/api-model/models/confirm-transportation-options-request.d.ts +0 -21
  334. package/dist/types/api-model/models/confirm-transportation-options-response.d.ts +0 -20
  335. package/dist/types/api-model/models/contact-information.d.ts +0 -28
  336. package/dist/types/api-model/models/content-update-preview.d.ts +0 -28
  337. package/dist/types/api-model/models/create-inbound-plan-request.d.ts +0 -31
  338. package/dist/types/api-model/models/create-inbound-plan-response.d.ts +0 -24
  339. package/dist/types/api-model/models/create-marketplace-item-labels-request.d.ts +0 -41
  340. package/dist/types/api-model/models/create-marketplace-item-labels-response.d.ts +0 -21
  341. package/dist/types/api-model/models/currency.d.ts +0 -24
  342. package/dist/types/api-model/models/custom-placement-input.d.ts +0 -25
  343. package/dist/types/api-model/models/dates.d.ts +0 -18
  344. package/dist/types/api-model/models/delivery-window-option.d.ts +0 -36
  345. package/dist/types/api-model/models/dimensions.d.ts +0 -30
  346. package/dist/types/api-model/models/document-download.d.ts +0 -28
  347. package/dist/types/api-model/models/error-list.d.ts +0 -20
  348. package/dist/types/api-model/models/freight-information.d.ts +0 -22
  349. package/dist/types/api-model/models/generate-delivery-window-options-response.d.ts +0 -20
  350. package/dist/types/api-model/models/generate-packing-options-response.d.ts +0 -20
  351. package/dist/types/api-model/models/generate-placement-options-request.d.ts +0 -21
  352. package/dist/types/api-model/models/generate-placement-options-response.d.ts +0 -20
  353. package/dist/types/api-model/models/generate-self-ship-appointment-slots-request.d.ts +0 -24
  354. package/dist/types/api-model/models/generate-self-ship-appointment-slots-response.d.ts +0 -20
  355. package/dist/types/api-model/models/generate-shipment-content-update-previews-request.d.ts +0 -26
  356. package/dist/types/api-model/models/generate-shipment-content-update-previews-response.d.ts +0 -20
  357. package/dist/types/api-model/models/generate-transportation-options-request.d.ts +0 -25
  358. package/dist/types/api-model/models/generate-transportation-options-response.d.ts +0 -20
  359. package/dist/types/api-model/models/get-delivery-challan-document-response.d.ts +0 -18
  360. package/dist/types/api-model/models/get-self-ship-appointment-slots-response.d.ts +0 -20
  361. package/dist/types/api-model/models/inbound-operation-status.d.ts +0 -31
  362. package/dist/types/api-model/models/inbound-plan-summary.d.ts +0 -42
  363. package/dist/types/api-model/models/inbound-plan.d.ts +0 -57
  364. package/dist/types/api-model/models/incentive.d.ts +0 -30
  365. package/dist/types/api-model/models/index.d.ts +0 -140
  366. package/dist/types/api-model/models/item-input.d.ts +0 -36
  367. package/dist/types/api-model/models/item-label-page-type.d.ts +0 -28
  368. package/dist/types/api-model/models/item.d.ts +0 -49
  369. package/dist/types/api-model/models/label-owner.d.ts +0 -20
  370. package/dist/types/api-model/models/label-print-type.d.ts +0 -19
  371. package/dist/types/api-model/models/list-delivery-window-options-response.d.ts +0 -23
  372. package/dist/types/api-model/models/list-inbound-plan-boxes-response.d.ts +0 -23
  373. package/dist/types/api-model/models/list-inbound-plan-items-response.d.ts +0 -23
  374. package/dist/types/api-model/models/list-inbound-plan-pallets-response.d.ts +0 -23
  375. package/dist/types/api-model/models/list-inbound-plans-response.d.ts +0 -23
  376. package/dist/types/api-model/models/list-item-compliance-details-response.d.ts +0 -21
  377. package/dist/types/api-model/models/list-packing-group-boxes-response.d.ts +0 -23
  378. package/dist/types/api-model/models/list-packing-group-items-response.d.ts +0 -23
  379. package/dist/types/api-model/models/list-packing-options-response.d.ts +0 -23
  380. package/dist/types/api-model/models/list-placement-options-response.d.ts +0 -23
  381. package/dist/types/api-model/models/list-prep-details-response.d.ts +0 -21
  382. package/dist/types/api-model/models/list-shipment-boxes-response.d.ts +0 -23
  383. package/dist/types/api-model/models/list-shipment-content-update-previews-response.d.ts +0 -23
  384. package/dist/types/api-model/models/list-shipment-items-response.d.ts +0 -23
  385. package/dist/types/api-model/models/list-shipment-pallets-response.d.ts +0 -23
  386. package/dist/types/api-model/models/list-transportation-options-response.d.ts +0 -23
  387. package/dist/types/api-model/models/ltl-tracking-detail-input.d.ts +0 -24
  388. package/dist/types/api-model/models/ltl-tracking-detail.d.ts +0 -24
  389. package/dist/types/api-model/models/model-error.d.ts +0 -28
  390. package/dist/types/api-model/models/msku-prep-detail-input.d.ts +0 -27
  391. package/dist/types/api-model/models/msku-prep-detail.d.ts +0 -32
  392. package/dist/types/api-model/models/msku-quantity.d.ts +0 -24
  393. package/dist/types/api-model/models/operation-problem.d.ts +0 -32
  394. package/dist/types/api-model/models/operation-status.d.ts +0 -20
  395. package/dist/types/api-model/models/owner-constraint.d.ts +0 -20
  396. package/dist/types/api-model/models/package-grouping-input.d.ts +0 -29
  397. package/dist/types/api-model/models/packing-configuration.d.ts +0 -28
  398. package/dist/types/api-model/models/packing-option-summary.d.ts +0 -24
  399. package/dist/types/api-model/models/packing-option.d.ts +0 -51
  400. package/dist/types/api-model/models/pagination.d.ts +0 -20
  401. package/dist/types/api-model/models/pallet-input.d.ts +0 -26
  402. package/dist/types/api-model/models/pallet.d.ts +0 -30
  403. package/dist/types/api-model/models/placement-option-summary.d.ts +0 -24
  404. package/dist/types/api-model/models/placement-option.d.ts +0 -41
  405. package/dist/types/api-model/models/prep-category.d.ts +0 -31
  406. package/dist/types/api-model/models/prep-instruction.d.ts +0 -26
  407. package/dist/types/api-model/models/prep-owner.d.ts +0 -20
  408. package/dist/types/api-model/models/prep-type.d.ts +0 -33
  409. package/dist/types/api-model/models/quote.d.ts +0 -26
  410. package/dist/types/api-model/models/reason-comment.d.ts +0 -26
  411. package/dist/types/api-model/models/region.d.ts +0 -28
  412. package/dist/types/api-model/models/requested-updates.d.ts +0 -26
  413. package/dist/types/api-model/models/schedule-self-ship-appointment-request.d.ts +0 -18
  414. package/dist/types/api-model/models/schedule-self-ship-appointment-response.d.ts +0 -18
  415. package/dist/types/api-model/models/selected-delivery-window.d.ts +0 -36
  416. package/dist/types/api-model/models/self-ship-appointment-details.d.ts +0 -26
  417. package/dist/types/api-model/models/self-ship-appointment-slots-availability.d.ts +0 -25
  418. package/dist/types/api-model/models/set-packing-information-request.d.ts +0 -21
  419. package/dist/types/api-model/models/set-packing-information-response.d.ts +0 -20
  420. package/dist/types/api-model/models/set-prep-details-request.d.ts +0 -25
  421. package/dist/types/api-model/models/set-prep-details-response.d.ts +0 -20
  422. package/dist/types/api-model/models/shipment-destination.d.ts +0 -26
  423. package/dist/types/api-model/models/shipment-source.d.ts +0 -22
  424. package/dist/types/api-model/models/shipment-summary.d.ts +0 -24
  425. package/dist/types/api-model/models/shipment-transportation-configuration.d.ts +0 -31
  426. package/dist/types/api-model/models/shipment.d.ts +0 -63
  427. package/dist/types/api-model/models/shipping-configuration.d.ts +0 -24
  428. package/dist/types/api-model/models/shipping-requirements.d.ts +0 -24
  429. package/dist/types/api-model/models/spd-tracking-detail-input.d.ts +0 -21
  430. package/dist/types/api-model/models/spd-tracking-detail.d.ts +0 -21
  431. package/dist/types/api-model/models/spd-tracking-item-input.d.ts +0 -24
  432. package/dist/types/api-model/models/spd-tracking-item.d.ts +0 -28
  433. package/dist/types/api-model/models/stackability.d.ts +0 -19
  434. package/dist/types/api-model/models/tax-details.d.ts +0 -27
  435. package/dist/types/api-model/models/tax-rate.d.ts +0 -28
  436. package/dist/types/api-model/models/tracking-details-input.d.ts +0 -20
  437. package/dist/types/api-model/models/tracking-details.d.ts +0 -20
  438. package/dist/types/api-model/models/transportation-option.d.ts +0 -42
  439. package/dist/types/api-model/models/transportation-selection.d.ts +0 -26
  440. package/dist/types/api-model/models/unit-of-measurement.d.ts +0 -19
  441. package/dist/types/api-model/models/unit-of-weight.d.ts +0 -19
  442. package/dist/types/api-model/models/update-inbound-plan-name-request.d.ts +0 -20
  443. package/dist/types/api-model/models/update-item-compliance-details-request.d.ts +0 -22
  444. package/dist/types/api-model/models/update-item-compliance-details-response.d.ts +0 -20
  445. package/dist/types/api-model/models/update-shipment-name-request.d.ts +0 -20
  446. package/dist/types/api-model/models/update-shipment-source-address-request.d.ts +0 -18
  447. package/dist/types/api-model/models/update-shipment-source-address-response.d.ts +0 -20
  448. package/dist/types/api-model/models/update-shipment-tracking-details-request.d.ts +0 -18
  449. package/dist/types/api-model/models/update-shipment-tracking-details-response.d.ts +0 -20
  450. package/dist/types/api-model/models/weight-range.d.ts +0 -26
  451. package/dist/types/api-model/models/weight.d.ts +0 -22
  452. package/dist/types/api-model/models/window-input.d.ts +0 -20
  453. package/dist/types/api-model/models/window.d.ts +0 -28
  454. package/dist/types/client.d.ts +0 -6
  455. package/dist/types/index.d.ts +0 -3
@@ -1,3131 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * The Selling Partner API for FBA inbound operations.
6
- * 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.
7
- *
8
- * The version of the OpenAPI document: 2024-03-20
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- var __importDefault = (this && this.__importDefault) || function (mod) {
16
- return (mod && mod.__esModule) ? mod : { "default": mod };
17
- };
18
- Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.ListInboundPlansSortOrderEnum = exports.ListInboundPlansSortByEnum = exports.ListInboundPlansStatusEnum = exports.FulfillmentInboundApi = exports.FulfillmentInboundApiFactory = exports.FulfillmentInboundApiFp = exports.FulfillmentInboundApiAxiosParamCreator = void 0;
20
- const axios_1 = __importDefault(require("axios"));
21
- // Some imports not used depending on template conditions
22
- // @ts-ignore
23
- const common_1 = require("../common");
24
- // @ts-ignore
25
- const base_1 = require("../base");
26
- /**
27
- * FulfillmentInboundApi - axios parameter creator
28
- */
29
- const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
30
- return {
31
- /**
32
- * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments.
33
- * @param {string} inboundPlanId Identifier of an inbound plan.
34
- * @param {*} [options] Override http request option.
35
- * @throws {RequiredError}
36
- */
37
- cancelInboundPlan: async (inboundPlanId, options = {}) => {
38
- // verify required parameter 'inboundPlanId' is not null or undefined
39
- (0, common_1.assertParamExists)('cancelInboundPlan', 'inboundPlanId', inboundPlanId);
40
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/cancellation`
41
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
42
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
43
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
44
- let baseOptions;
45
- if (configuration) {
46
- baseOptions = configuration.baseOptions;
47
- }
48
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
49
- const localVarHeaderParameter = {};
50
- const localVarQueryParameter = {};
51
- localVarHeaderParameter['Accept'] = 'application/json';
52
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
53
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
54
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
55
- return {
56
- url: (0, common_1.toPathString)(localVarUrlObj),
57
- options: localVarRequestOptions,
58
- };
59
- },
60
- /**
61
- * Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
62
- * @param {string} inboundPlanId Identifier of an inbound plan.
63
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
64
- * @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`.
65
- * @param {*} [options] Override http request option.
66
- * @throws {RequiredError}
67
- */
68
- cancelSelfShipAppointment: async (inboundPlanId, shipmentId, body, options = {}) => {
69
- // verify required parameter 'inboundPlanId' is not null or undefined
70
- (0, common_1.assertParamExists)('cancelSelfShipAppointment', 'inboundPlanId', inboundPlanId);
71
- // verify required parameter 'shipmentId' is not null or undefined
72
- (0, common_1.assertParamExists)('cancelSelfShipAppointment', 'shipmentId', shipmentId);
73
- // verify required parameter 'body' is not null or undefined
74
- (0, common_1.assertParamExists)('cancelSelfShipAppointment', 'body', body);
75
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentCancellation`
76
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
77
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
78
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
79
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
80
- let baseOptions;
81
- if (configuration) {
82
- baseOptions = configuration.baseOptions;
83
- }
84
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
85
- const localVarHeaderParameter = {};
86
- const localVarQueryParameter = {};
87
- localVarHeaderParameter['Content-Type'] = 'application/json';
88
- localVarHeaderParameter['Accept'] = 'application/json';
89
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
90
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
91
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
92
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
93
- return {
94
- url: (0, common_1.toPathString)(localVarUrlObj),
95
- options: localVarRequestOptions,
96
- };
97
- },
98
- /**
99
- * 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.
100
- * @param {string} inboundPlanId Identifier of an inbound plan.
101
- * @param {string} shipmentId The shipment to confirm the delivery window option for.
102
- * @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed.
103
- * @param {*} [options] Override http request option.
104
- * @throws {RequiredError}
105
- */
106
- confirmDeliveryWindowOptions: async (inboundPlanId, shipmentId, deliveryWindowOptionId, options = {}) => {
107
- // verify required parameter 'inboundPlanId' is not null or undefined
108
- (0, common_1.assertParamExists)('confirmDeliveryWindowOptions', 'inboundPlanId', inboundPlanId);
109
- // verify required parameter 'shipmentId' is not null or undefined
110
- (0, common_1.assertParamExists)('confirmDeliveryWindowOptions', 'shipmentId', shipmentId);
111
- // verify required parameter 'deliveryWindowOptionId' is not null or undefined
112
- (0, common_1.assertParamExists)('confirmDeliveryWindowOptions', 'deliveryWindowOptionId', deliveryWindowOptionId);
113
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions/{deliveryWindowOptionId}/confirmation`
114
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
115
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)))
116
- .replace(`{${"deliveryWindowOptionId"}}`, encodeURIComponent(String(deliveryWindowOptionId)));
117
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
118
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
119
- let baseOptions;
120
- if (configuration) {
121
- baseOptions = configuration.baseOptions;
122
- }
123
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
124
- const localVarHeaderParameter = {};
125
- const localVarQueryParameter = {};
126
- localVarHeaderParameter['Accept'] = 'application/json';
127
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
128
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
129
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
130
- return {
131
- url: (0, common_1.toPathString)(localVarUrlObj),
132
- options: localVarRequestOptions,
133
- };
134
- },
135
- /**
136
- * Confirms the packing option for an inbound plan.
137
- * @param {string} inboundPlanId Identifier of an inbound plan.
138
- * @param {string} packingOptionId Identifier of a packing option.
139
- * @param {*} [options] Override http request option.
140
- * @throws {RequiredError}
141
- */
142
- confirmPackingOption: async (inboundPlanId, packingOptionId, options = {}) => {
143
- // verify required parameter 'inboundPlanId' is not null or undefined
144
- (0, common_1.assertParamExists)('confirmPackingOption', 'inboundPlanId', inboundPlanId);
145
- // verify required parameter 'packingOptionId' is not null or undefined
146
- (0, common_1.assertParamExists)('confirmPackingOption', 'packingOptionId', packingOptionId);
147
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions/{packingOptionId}/confirmation`
148
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
149
- .replace(`{${"packingOptionId"}}`, encodeURIComponent(String(packingOptionId)));
150
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
151
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
152
- let baseOptions;
153
- if (configuration) {
154
- baseOptions = configuration.baseOptions;
155
- }
156
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
157
- const localVarHeaderParameter = {};
158
- const localVarQueryParameter = {};
159
- localVarHeaderParameter['Accept'] = 'application/json';
160
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
161
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
162
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
163
- return {
164
- url: (0, common_1.toPathString)(localVarUrlObj),
165
- options: localVarRequestOptions,
166
- };
167
- },
168
- /**
169
- * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
170
- * @param {string} inboundPlanId Identifier of an inbound plan.
171
- * @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
172
- * @param {*} [options] Override http request option.
173
- * @throws {RequiredError}
174
- */
175
- confirmPlacementOption: async (inboundPlanId, placementOptionId, options = {}) => {
176
- // verify required parameter 'inboundPlanId' is not null or undefined
177
- (0, common_1.assertParamExists)('confirmPlacementOption', 'inboundPlanId', inboundPlanId);
178
- // verify required parameter 'placementOptionId' is not null or undefined
179
- (0, common_1.assertParamExists)('confirmPlacementOption', 'placementOptionId', placementOptionId);
180
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions/{placementOptionId}/confirmation`
181
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
182
- .replace(`{${"placementOptionId"}}`, encodeURIComponent(String(placementOptionId)));
183
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
184
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
185
- let baseOptions;
186
- if (configuration) {
187
- baseOptions = configuration.baseOptions;
188
- }
189
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
190
- const localVarHeaderParameter = {};
191
- const localVarQueryParameter = {};
192
- localVarHeaderParameter['Accept'] = 'application/json';
193
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
194
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
195
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
196
- return {
197
- url: (0, common_1.toPathString)(localVarUrlObj),
198
- options: localVarRequestOptions,
199
- };
200
- },
201
- /**
202
- * Confirm a shipment content update preview and accept the changes in transportation cost.
203
- * @param {string} inboundPlanId Identifier of an inbound plan.
204
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
205
- * @param {string} contentUpdatePreviewId Identifier of a content update preview.
206
- * @param {*} [options] Override http request option.
207
- * @throws {RequiredError}
208
- */
209
- confirmShipmentContentUpdatePreview: async (inboundPlanId, shipmentId, contentUpdatePreviewId, options = {}) => {
210
- // verify required parameter 'inboundPlanId' is not null or undefined
211
- (0, common_1.assertParamExists)('confirmShipmentContentUpdatePreview', 'inboundPlanId', inboundPlanId);
212
- // verify required parameter 'shipmentId' is not null or undefined
213
- (0, common_1.assertParamExists)('confirmShipmentContentUpdatePreview', 'shipmentId', shipmentId);
214
- // verify required parameter 'contentUpdatePreviewId' is not null or undefined
215
- (0, common_1.assertParamExists)('confirmShipmentContentUpdatePreview', 'contentUpdatePreviewId', contentUpdatePreviewId);
216
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}/confirmation`
217
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
218
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)))
219
- .replace(`{${"contentUpdatePreviewId"}}`, encodeURIComponent(String(contentUpdatePreviewId)));
220
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
221
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
222
- let baseOptions;
223
- if (configuration) {
224
- baseOptions = configuration.baseOptions;
225
- }
226
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
227
- const localVarHeaderParameter = {};
228
- const localVarQueryParameter = {};
229
- localVarHeaderParameter['Accept'] = 'application/json';
230
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
231
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
232
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
233
- return {
234
- url: (0, common_1.toPathString)(localVarUrlObj),
235
- options: localVarRequestOptions,
236
- };
237
- },
238
- /**
239
- * 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.
240
- * @param {string} inboundPlanId Identifier of an inbound plan.
241
- * @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`.
242
- * @param {*} [options] Override http request option.
243
- * @throws {RequiredError}
244
- */
245
- confirmTransportationOptions: async (inboundPlanId, body, options = {}) => {
246
- // verify required parameter 'inboundPlanId' is not null or undefined
247
- (0, common_1.assertParamExists)('confirmTransportationOptions', 'inboundPlanId', inboundPlanId);
248
- // verify required parameter 'body' is not null or undefined
249
- (0, common_1.assertParamExists)('confirmTransportationOptions', 'body', body);
250
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions/confirmation`
251
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
252
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
253
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
254
- let baseOptions;
255
- if (configuration) {
256
- baseOptions = configuration.baseOptions;
257
- }
258
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
259
- const localVarHeaderParameter = {};
260
- const localVarQueryParameter = {};
261
- localVarHeaderParameter['Content-Type'] = 'application/json';
262
- localVarHeaderParameter['Accept'] = 'application/json';
263
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
264
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
265
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
266
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
267
- return {
268
- url: (0, common_1.toPathString)(localVarUrlObj),
269
- options: localVarRequestOptions,
270
- };
271
- },
272
- /**
273
- * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network.
274
- * @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`.
275
- * @param {*} [options] Override http request option.
276
- * @throws {RequiredError}
277
- */
278
- createInboundPlan: async (body, options = {}) => {
279
- // verify required parameter 'body' is not null or undefined
280
- (0, common_1.assertParamExists)('createInboundPlan', 'body', body);
281
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans`;
282
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
283
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
284
- let baseOptions;
285
- if (configuration) {
286
- baseOptions = configuration.baseOptions;
287
- }
288
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
289
- const localVarHeaderParameter = {};
290
- const localVarQueryParameter = {};
291
- localVarHeaderParameter['Content-Type'] = 'application/json';
292
- localVarHeaderParameter['Accept'] = 'application/json';
293
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
294
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
295
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
296
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
297
- return {
298
- url: (0, common_1.toPathString)(localVarUrlObj),
299
- options: localVarRequestOptions,
300
- };
301
- },
302
- /**
303
- * For a given marketplace - creates labels for a list of MSKUs.
304
- * @param {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`.
305
- * @param {*} [options] Override http request option.
306
- * @throws {RequiredError}
307
- */
308
- createMarketplaceItemLabels: async (body, options = {}) => {
309
- // verify required parameter 'body' is not null or undefined
310
- (0, common_1.assertParamExists)('createMarketplaceItemLabels', 'body', body);
311
- const localVarPath = `/inbound/fba/2024-03-20/items/labels`;
312
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
313
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
314
- let baseOptions;
315
- if (configuration) {
316
- baseOptions = configuration.baseOptions;
317
- }
318
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
319
- const localVarHeaderParameter = {};
320
- const localVarQueryParameter = {};
321
- localVarHeaderParameter['Content-Type'] = 'application/json';
322
- localVarHeaderParameter['Accept'] = 'application/json';
323
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
324
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
325
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
326
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
327
- return {
328
- url: (0, common_1.toPathString)(localVarUrlObj),
329
- options: localVarRequestOptions,
330
- };
331
- },
332
- /**
333
- * Generates available delivery window options for a given shipment.
334
- * @param {string} inboundPlanId Identifier of an inbound plan.
335
- * @param {string} shipmentId The shipment to generate delivery window options for.
336
- * @param {*} [options] Override http request option.
337
- * @throws {RequiredError}
338
- */
339
- generateDeliveryWindowOptions: async (inboundPlanId, shipmentId, options = {}) => {
340
- // verify required parameter 'inboundPlanId' is not null or undefined
341
- (0, common_1.assertParamExists)('generateDeliveryWindowOptions', 'inboundPlanId', inboundPlanId);
342
- // verify required parameter 'shipmentId' is not null or undefined
343
- (0, common_1.assertParamExists)('generateDeliveryWindowOptions', 'shipmentId', shipmentId);
344
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions`
345
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
346
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
347
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
348
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
349
- let baseOptions;
350
- if (configuration) {
351
- baseOptions = configuration.baseOptions;
352
- }
353
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
354
- const localVarHeaderParameter = {};
355
- const localVarQueryParameter = {};
356
- localVarHeaderParameter['Accept'] = 'application/json';
357
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
358
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
359
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
360
- return {
361
- url: (0, common_1.toPathString)(localVarUrlObj),
362
- options: localVarRequestOptions,
363
- };
364
- },
365
- /**
366
- * Generates available packing options for the inbound plan.
367
- * @param {string} inboundPlanId Identifier of an inbound plan.
368
- * @param {*} [options] Override http request option.
369
- * @throws {RequiredError}
370
- */
371
- generatePackingOptions: async (inboundPlanId, options = {}) => {
372
- // verify required parameter 'inboundPlanId' is not null or undefined
373
- (0, common_1.assertParamExists)('generatePackingOptions', 'inboundPlanId', inboundPlanId);
374
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions`
375
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
376
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
377
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
378
- let baseOptions;
379
- if (configuration) {
380
- baseOptions = configuration.baseOptions;
381
- }
382
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
383
- const localVarHeaderParameter = {};
384
- const localVarQueryParameter = {};
385
- localVarHeaderParameter['Accept'] = 'application/json';
386
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
387
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
388
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
389
- return {
390
- url: (0, common_1.toPathString)(localVarUrlObj),
391
- options: localVarRequestOptions,
392
- };
393
- },
394
- /**
395
- * Generates placement options for the inbound plan.
396
- * @param {string} inboundPlanId Identifier of an inbound plan.
397
- * @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`.
398
- * @param {*} [options] Override http request option.
399
- * @throws {RequiredError}
400
- */
401
- generatePlacementOptions: async (inboundPlanId, body, options = {}) => {
402
- // verify required parameter 'inboundPlanId' is not null or undefined
403
- (0, common_1.assertParamExists)('generatePlacementOptions', 'inboundPlanId', inboundPlanId);
404
- // verify required parameter 'body' is not null or undefined
405
- (0, common_1.assertParamExists)('generatePlacementOptions', 'body', body);
406
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions`
407
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
408
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
409
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
410
- let baseOptions;
411
- if (configuration) {
412
- baseOptions = configuration.baseOptions;
413
- }
414
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
415
- const localVarHeaderParameter = {};
416
- const localVarQueryParameter = {};
417
- localVarHeaderParameter['Content-Type'] = 'application/json';
418
- localVarHeaderParameter['Accept'] = 'application/json';
419
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
420
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
421
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
422
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
423
- return {
424
- url: (0, common_1.toPathString)(localVarUrlObj),
425
- options: localVarRequestOptions,
426
- };
427
- },
428
- /**
429
- * Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
430
- * @param {string} inboundPlanId Identifier of an inbound plan.
431
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
432
- * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`.
433
- * @param {*} [options] Override http request option.
434
- * @throws {RequiredError}
435
- */
436
- generateSelfShipAppointmentSlots: async (inboundPlanId, shipmentId, body, options = {}) => {
437
- // verify required parameter 'inboundPlanId' is not null or undefined
438
- (0, common_1.assertParamExists)('generateSelfShipAppointmentSlots', 'inboundPlanId', inboundPlanId);
439
- // verify required parameter 'shipmentId' is not null or undefined
440
- (0, common_1.assertParamExists)('generateSelfShipAppointmentSlots', 'shipmentId', shipmentId);
441
- // verify required parameter 'body' is not null or undefined
442
- (0, common_1.assertParamExists)('generateSelfShipAppointmentSlots', 'body', body);
443
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots`
444
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
445
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
446
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
447
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
448
- let baseOptions;
449
- if (configuration) {
450
- baseOptions = configuration.baseOptions;
451
- }
452
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
453
- const localVarHeaderParameter = {};
454
- const localVarQueryParameter = {};
455
- localVarHeaderParameter['Content-Type'] = 'application/json';
456
- localVarHeaderParameter['Accept'] = 'application/json';
457
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
458
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
459
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
460
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
461
- return {
462
- url: (0, common_1.toPathString)(localVarUrlObj),
463
- options: localVarRequestOptions,
464
- };
465
- },
466
- /**
467
- * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.
468
- * @param {string} inboundPlanId Identifier of an inbound plan.
469
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
470
- * @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to `generateShipmentContentUpdatePreviews`.
471
- * @param {*} [options] Override http request option.
472
- * @throws {RequiredError}
473
- */
474
- generateShipmentContentUpdatePreviews: async (inboundPlanId, shipmentId, body, options = {}) => {
475
- // verify required parameter 'inboundPlanId' is not null or undefined
476
- (0, common_1.assertParamExists)('generateShipmentContentUpdatePreviews', 'inboundPlanId', inboundPlanId);
477
- // verify required parameter 'shipmentId' is not null or undefined
478
- (0, common_1.assertParamExists)('generateShipmentContentUpdatePreviews', 'shipmentId', shipmentId);
479
- // verify required parameter 'body' is not null or undefined
480
- (0, common_1.assertParamExists)('generateShipmentContentUpdatePreviews', 'body', body);
481
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews`
482
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
483
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
484
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
485
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
486
- let baseOptions;
487
- if (configuration) {
488
- baseOptions = configuration.baseOptions;
489
- }
490
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
491
- const localVarHeaderParameter = {};
492
- const localVarQueryParameter = {};
493
- localVarHeaderParameter['Content-Type'] = 'application/json';
494
- localVarHeaderParameter['Accept'] = 'application/json';
495
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
496
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
497
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
498
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
499
- return {
500
- url: (0, common_1.toPathString)(localVarUrlObj),
501
- options: localVarRequestOptions,
502
- };
503
- },
504
- /**
505
- * Generates available transportation options for a given placement option.
506
- * @param {string} inboundPlanId Identifier of an inbound plan.
507
- * @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`.
508
- * @param {*} [options] Override http request option.
509
- * @throws {RequiredError}
510
- */
511
- generateTransportationOptions: async (inboundPlanId, body, options = {}) => {
512
- // verify required parameter 'inboundPlanId' is not null or undefined
513
- (0, common_1.assertParamExists)('generateTransportationOptions', 'inboundPlanId', inboundPlanId);
514
- // verify required parameter 'body' is not null or undefined
515
- (0, common_1.assertParamExists)('generateTransportationOptions', 'body', body);
516
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions`
517
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
518
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
519
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
520
- let baseOptions;
521
- if (configuration) {
522
- baseOptions = configuration.baseOptions;
523
- }
524
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
525
- const localVarHeaderParameter = {};
526
- const localVarQueryParameter = {};
527
- localVarHeaderParameter['Content-Type'] = 'application/json';
528
- localVarHeaderParameter['Accept'] = 'application/json';
529
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
530
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
531
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
532
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
533
- return {
534
- url: (0, common_1.toPathString)(localVarUrlObj),
535
- options: localVarRequestOptions,
536
- };
537
- },
538
- /**
539
- * Provide delivery challan document for PCP transportation in IN marketplace.
540
- * @param {string} inboundPlanId Identifier of an inbound plan.
541
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
542
- * @param {*} [options] Override http request option.
543
- * @throws {RequiredError}
544
- */
545
- getDeliveryChallanDocument: async (inboundPlanId, shipmentId, options = {}) => {
546
- // verify required parameter 'inboundPlanId' is not null or undefined
547
- (0, common_1.assertParamExists)('getDeliveryChallanDocument', 'inboundPlanId', inboundPlanId);
548
- // verify required parameter 'shipmentId' is not null or undefined
549
- (0, common_1.assertParamExists)('getDeliveryChallanDocument', 'shipmentId', shipmentId);
550
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryChallanDocument`
551
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
552
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
553
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
554
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
555
- let baseOptions;
556
- if (configuration) {
557
- baseOptions = configuration.baseOptions;
558
- }
559
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
560
- const localVarHeaderParameter = {};
561
- const localVarQueryParameter = {};
562
- localVarHeaderParameter['Accept'] = 'application/json';
563
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
564
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
565
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
566
- return {
567
- url: (0, common_1.toPathString)(localVarUrlObj),
568
- options: localVarRequestOptions,
569
- };
570
- },
571
- /**
572
- * Gets the status of the processing of an asynchronous API call.
573
- * @param {string} operationId Identifier of an asynchronous operation.
574
- * @param {*} [options] Override http request option.
575
- * @throws {RequiredError}
576
- */
577
- getInboundOperationStatus: async (operationId, options = {}) => {
578
- // verify required parameter 'operationId' is not null or undefined
579
- (0, common_1.assertParamExists)('getInboundOperationStatus', 'operationId', operationId);
580
- const localVarPath = `/inbound/fba/2024-03-20/operations/{operationId}`
581
- .replace(`{${"operationId"}}`, encodeURIComponent(String(operationId)));
582
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
583
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
584
- let baseOptions;
585
- if (configuration) {
586
- baseOptions = configuration.baseOptions;
587
- }
588
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
589
- const localVarHeaderParameter = {};
590
- const localVarQueryParameter = {};
591
- localVarHeaderParameter['Accept'] = 'application/json';
592
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
593
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
594
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
595
- return {
596
- url: (0, common_1.toPathString)(localVarUrlObj),
597
- options: localVarRequestOptions,
598
- };
599
- },
600
- /**
601
- * Fetches the top level information about an inbound plan.
602
- * @param {string} inboundPlanId Identifier of an inbound plan.
603
- * @param {*} [options] Override http request option.
604
- * @throws {RequiredError}
605
- */
606
- getInboundPlan: async (inboundPlanId, options = {}) => {
607
- // verify required parameter 'inboundPlanId' is not null or undefined
608
- (0, common_1.assertParamExists)('getInboundPlan', 'inboundPlanId', inboundPlanId);
609
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}`
610
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
611
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
612
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
613
- let baseOptions;
614
- if (configuration) {
615
- baseOptions = configuration.baseOptions;
616
- }
617
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
618
- const localVarHeaderParameter = {};
619
- const localVarQueryParameter = {};
620
- localVarHeaderParameter['Accept'] = 'application/json';
621
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
622
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
623
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
624
- return {
625
- url: (0, common_1.toPathString)(localVarUrlObj),
626
- options: localVarRequestOptions,
627
- };
628
- },
629
- /**
630
- * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
631
- * @param {string} inboundPlanId Identifier of an inbound plan.
632
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
633
- * @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
634
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
635
- * @param {*} [options] Override http request option.
636
- * @throws {RequiredError}
637
- */
638
- getSelfShipAppointmentSlots: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
639
- // verify required parameter 'inboundPlanId' is not null or undefined
640
- (0, common_1.assertParamExists)('getSelfShipAppointmentSlots', 'inboundPlanId', inboundPlanId);
641
- // verify required parameter 'shipmentId' is not null or undefined
642
- (0, common_1.assertParamExists)('getSelfShipAppointmentSlots', 'shipmentId', shipmentId);
643
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots`
644
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
645
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
646
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
647
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
648
- let baseOptions;
649
- if (configuration) {
650
- baseOptions = configuration.baseOptions;
651
- }
652
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
653
- const localVarHeaderParameter = {};
654
- const localVarQueryParameter = {};
655
- if (pageSize !== undefined) {
656
- localVarQueryParameter['pageSize'] = pageSize;
657
- }
658
- if (paginationToken !== undefined) {
659
- localVarQueryParameter['paginationToken'] = paginationToken;
660
- }
661
- localVarHeaderParameter['Accept'] = 'application/json';
662
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
663
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
664
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
665
- return {
666
- url: (0, common_1.toPathString)(localVarUrlObj),
667
- options: localVarRequestOptions,
668
- };
669
- },
670
- /**
671
- * 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.
672
- * @param {string} inboundPlanId Identifier of an inbound plan.
673
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
674
- * @param {*} [options] Override http request option.
675
- * @throws {RequiredError}
676
- */
677
- getShipment: async (inboundPlanId, shipmentId, options = {}) => {
678
- // verify required parameter 'inboundPlanId' is not null or undefined
679
- (0, common_1.assertParamExists)('getShipment', 'inboundPlanId', inboundPlanId);
680
- // verify required parameter 'shipmentId' is not null or undefined
681
- (0, common_1.assertParamExists)('getShipment', 'shipmentId', shipmentId);
682
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}`
683
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
684
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
685
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
686
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
687
- let baseOptions;
688
- if (configuration) {
689
- baseOptions = configuration.baseOptions;
690
- }
691
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
692
- const localVarHeaderParameter = {};
693
- const localVarQueryParameter = {};
694
- localVarHeaderParameter['Accept'] = 'application/json';
695
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
696
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
697
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
698
- return {
699
- url: (0, common_1.toPathString)(localVarUrlObj),
700
- options: localVarRequestOptions,
701
- };
702
- },
703
- /**
704
- * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
705
- * @param {string} inboundPlanId Identifier of an inbound plan.
706
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
707
- * @param {string} contentUpdatePreviewId Identifier of a content update preview.
708
- * @param {*} [options] Override http request option.
709
- * @throws {RequiredError}
710
- */
711
- getShipmentContentUpdatePreview: async (inboundPlanId, shipmentId, contentUpdatePreviewId, options = {}) => {
712
- // verify required parameter 'inboundPlanId' is not null or undefined
713
- (0, common_1.assertParamExists)('getShipmentContentUpdatePreview', 'inboundPlanId', inboundPlanId);
714
- // verify required parameter 'shipmentId' is not null or undefined
715
- (0, common_1.assertParamExists)('getShipmentContentUpdatePreview', 'shipmentId', shipmentId);
716
- // verify required parameter 'contentUpdatePreviewId' is not null or undefined
717
- (0, common_1.assertParamExists)('getShipmentContentUpdatePreview', 'contentUpdatePreviewId', contentUpdatePreviewId);
718
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}`
719
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
720
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)))
721
- .replace(`{${"contentUpdatePreviewId"}}`, encodeURIComponent(String(contentUpdatePreviewId)));
722
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
723
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
724
- let baseOptions;
725
- if (configuration) {
726
- baseOptions = configuration.baseOptions;
727
- }
728
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
729
- const localVarHeaderParameter = {};
730
- const localVarQueryParameter = {};
731
- localVarHeaderParameter['Accept'] = 'application/json';
732
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
733
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
734
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
735
- return {
736
- url: (0, common_1.toPathString)(localVarUrlObj),
737
- options: localVarRequestOptions,
738
- };
739
- },
740
- /**
741
- * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available.
742
- * @param {string} inboundPlanId Identifier of an inbound plan.
743
- * @param {string} shipmentId The shipment to get delivery window options for.
744
- * @param {number} [pageSize] The number of delivery window options to return in the response matching the given query.
745
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
746
- * @param {*} [options] Override http request option.
747
- * @throws {RequiredError}
748
- */
749
- listDeliveryWindowOptions: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
750
- // verify required parameter 'inboundPlanId' is not null or undefined
751
- (0, common_1.assertParamExists)('listDeliveryWindowOptions', 'inboundPlanId', inboundPlanId);
752
- // verify required parameter 'shipmentId' is not null or undefined
753
- (0, common_1.assertParamExists)('listDeliveryWindowOptions', 'shipmentId', shipmentId);
754
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions`
755
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
756
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
757
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
758
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
759
- let baseOptions;
760
- if (configuration) {
761
- baseOptions = configuration.baseOptions;
762
- }
763
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
764
- const localVarHeaderParameter = {};
765
- const localVarQueryParameter = {};
766
- if (pageSize !== undefined) {
767
- localVarQueryParameter['pageSize'] = pageSize;
768
- }
769
- if (paginationToken !== undefined) {
770
- localVarQueryParameter['paginationToken'] = paginationToken;
771
- }
772
- localVarHeaderParameter['Accept'] = 'application/json';
773
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
774
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
775
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
776
- return {
777
- url: (0, common_1.toPathString)(localVarUrlObj),
778
- options: localVarRequestOptions,
779
- };
780
- },
781
- /**
782
- * Provides a paginated list of box packages in an inbound plan.
783
- * @param {string} inboundPlanId Identifier of an inbound plan.
784
- * @param {number} [pageSize] The number of boxes to return in the response matching the given query.
785
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
786
- * @param {*} [options] Override http request option.
787
- * @throws {RequiredError}
788
- */
789
- listInboundPlanBoxes: async (inboundPlanId, pageSize, paginationToken, options = {}) => {
790
- // verify required parameter 'inboundPlanId' is not null or undefined
791
- (0, common_1.assertParamExists)('listInboundPlanBoxes', 'inboundPlanId', inboundPlanId);
792
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/boxes`
793
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
794
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
795
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
796
- let baseOptions;
797
- if (configuration) {
798
- baseOptions = configuration.baseOptions;
799
- }
800
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
801
- const localVarHeaderParameter = {};
802
- const localVarQueryParameter = {};
803
- if (pageSize !== undefined) {
804
- localVarQueryParameter['pageSize'] = pageSize;
805
- }
806
- if (paginationToken !== undefined) {
807
- localVarQueryParameter['paginationToken'] = paginationToken;
808
- }
809
- localVarHeaderParameter['Accept'] = 'application/json';
810
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
811
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
812
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
813
- return {
814
- url: (0, common_1.toPathString)(localVarUrlObj),
815
- options: localVarRequestOptions,
816
- };
817
- },
818
- /**
819
- * Provides a paginated list of item packages in an inbound plan.
820
- * @param {string} inboundPlanId Identifier of an inbound plan.
821
- * @param {number} [pageSize] The number of items to return in the response matching the given query.
822
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
823
- * @param {*} [options] Override http request option.
824
- * @throws {RequiredError}
825
- */
826
- listInboundPlanItems: async (inboundPlanId, pageSize, paginationToken, options = {}) => {
827
- // verify required parameter 'inboundPlanId' is not null or undefined
828
- (0, common_1.assertParamExists)('listInboundPlanItems', 'inboundPlanId', inboundPlanId);
829
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/items`
830
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
831
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
832
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
833
- let baseOptions;
834
- if (configuration) {
835
- baseOptions = configuration.baseOptions;
836
- }
837
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
838
- const localVarHeaderParameter = {};
839
- const localVarQueryParameter = {};
840
- if (pageSize !== undefined) {
841
- localVarQueryParameter['pageSize'] = pageSize;
842
- }
843
- if (paginationToken !== undefined) {
844
- localVarQueryParameter['paginationToken'] = paginationToken;
845
- }
846
- localVarHeaderParameter['Accept'] = 'application/json';
847
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
848
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
849
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
850
- return {
851
- url: (0, common_1.toPathString)(localVarUrlObj),
852
- options: localVarRequestOptions,
853
- };
854
- },
855
- /**
856
- * 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.
857
- * @param {string} inboundPlanId Identifier of an inbound plan.
858
- * @param {number} [pageSize] The number of pallets to return in the response matching the given query.
859
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
860
- * @param {*} [options] Override http request option.
861
- * @throws {RequiredError}
862
- */
863
- listInboundPlanPallets: async (inboundPlanId, pageSize, paginationToken, options = {}) => {
864
- // verify required parameter 'inboundPlanId' is not null or undefined
865
- (0, common_1.assertParamExists)('listInboundPlanPallets', 'inboundPlanId', inboundPlanId);
866
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/pallets`
867
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
868
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
869
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
870
- let baseOptions;
871
- if (configuration) {
872
- baseOptions = configuration.baseOptions;
873
- }
874
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
875
- const localVarHeaderParameter = {};
876
- const localVarQueryParameter = {};
877
- if (pageSize !== undefined) {
878
- localVarQueryParameter['pageSize'] = pageSize;
879
- }
880
- if (paginationToken !== undefined) {
881
- localVarQueryParameter['paginationToken'] = paginationToken;
882
- }
883
- localVarHeaderParameter['Accept'] = 'application/json';
884
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
885
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
886
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
887
- return {
888
- url: (0, common_1.toPathString)(localVarUrlObj),
889
- options: localVarRequestOptions,
890
- };
891
- },
892
- /**
893
- * Provides a list of inbound plans with minimal information.
894
- * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query.
895
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
896
- * @param {ListInboundPlansStatusEnum} [status] The status of an inbound plan.
897
- * @param {ListInboundPlansSortByEnum} [sortBy] Sort by field.
898
- * @param {ListInboundPlansSortOrderEnum} [sortOrder] The sort order.
899
- * @param {*} [options] Override http request option.
900
- * @throws {RequiredError}
901
- */
902
- listInboundPlans: async (pageSize, paginationToken, status, sortBy, sortOrder, options = {}) => {
903
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans`;
904
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
905
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
906
- let baseOptions;
907
- if (configuration) {
908
- baseOptions = configuration.baseOptions;
909
- }
910
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
911
- const localVarHeaderParameter = {};
912
- const localVarQueryParameter = {};
913
- if (pageSize !== undefined) {
914
- localVarQueryParameter['pageSize'] = pageSize;
915
- }
916
- if (paginationToken !== undefined) {
917
- localVarQueryParameter['paginationToken'] = paginationToken;
918
- }
919
- if (status !== undefined) {
920
- localVarQueryParameter['status'] = status;
921
- }
922
- if (sortBy !== undefined) {
923
- localVarQueryParameter['sortBy'] = sortBy;
924
- }
925
- if (sortOrder !== undefined) {
926
- localVarQueryParameter['sortOrder'] = sortOrder;
927
- }
928
- localVarHeaderParameter['Accept'] = 'application/json';
929
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
930
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
931
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
932
- return {
933
- url: (0, common_1.toPathString)(localVarUrlObj),
934
- options: localVarRequestOptions,
935
- };
936
- },
937
- /**
938
- * List the inbound compliance details for MSKUs in a given marketplace. **Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). The following characters must be double percent encoded: - `%` - `+` - `,` **Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
939
- * @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
940
- * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
941
- * @param {*} [options] Override http request option.
942
- * @throws {RequiredError}
943
- */
944
- listItemComplianceDetails: async (mskus, marketplaceId, options = {}) => {
945
- // verify required parameter 'mskus' is not null or undefined
946
- (0, common_1.assertParamExists)('listItemComplianceDetails', 'mskus', mskus);
947
- // verify required parameter 'marketplaceId' is not null or undefined
948
- (0, common_1.assertParamExists)('listItemComplianceDetails', 'marketplaceId', marketplaceId);
949
- const localVarPath = `/inbound/fba/2024-03-20/items/compliance`;
950
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
951
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
952
- let baseOptions;
953
- if (configuration) {
954
- baseOptions = configuration.baseOptions;
955
- }
956
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
957
- const localVarHeaderParameter = {};
958
- const localVarQueryParameter = {};
959
- if (mskus) {
960
- localVarQueryParameter['mskus'] = mskus;
961
- }
962
- if (marketplaceId !== undefined) {
963
- localVarQueryParameter['marketplaceId'] = marketplaceId;
964
- }
965
- localVarHeaderParameter['Accept'] = 'application/json';
966
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
967
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
968
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
969
- return {
970
- url: (0, common_1.toPathString)(localVarUrlObj),
971
- options: localVarRequestOptions,
972
- };
973
- },
974
- /**
975
- * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.
976
- * @param {string} inboundPlanId Identifier of an inbound plan.
977
- * @param {string} packingGroupId Identifier of a packing group.
978
- * @param {number} [pageSize] The number of packing group boxes to return in the response matching the given query.
979
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
980
- * @param {*} [options] Override http request option.
981
- * @throws {RequiredError}
982
- */
983
- listPackingGroupBoxes: async (inboundPlanId, packingGroupId, pageSize, paginationToken, options = {}) => {
984
- // verify required parameter 'inboundPlanId' is not null or undefined
985
- (0, common_1.assertParamExists)('listPackingGroupBoxes', 'inboundPlanId', inboundPlanId);
986
- // verify required parameter 'packingGroupId' is not null or undefined
987
- (0, common_1.assertParamExists)('listPackingGroupBoxes', 'packingGroupId', packingGroupId);
988
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/boxes`
989
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
990
- .replace(`{${"packingGroupId"}}`, encodeURIComponent(String(packingGroupId)));
991
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
992
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
993
- let baseOptions;
994
- if (configuration) {
995
- baseOptions = configuration.baseOptions;
996
- }
997
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
998
- const localVarHeaderParameter = {};
999
- const localVarQueryParameter = {};
1000
- if (pageSize !== undefined) {
1001
- localVarQueryParameter['pageSize'] = pageSize;
1002
- }
1003
- if (paginationToken !== undefined) {
1004
- localVarQueryParameter['paginationToken'] = paginationToken;
1005
- }
1006
- localVarHeaderParameter['Accept'] = 'application/json';
1007
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1008
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1009
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1010
- return {
1011
- url: (0, common_1.toPathString)(localVarUrlObj),
1012
- options: localVarRequestOptions,
1013
- };
1014
- },
1015
- /**
1016
- * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.
1017
- * @param {string} inboundPlanId Identifier of an inbound plan.
1018
- * @param {string} packingGroupId Identifier of a packing group.
1019
- * @param {number} [pageSize] The number of packing group items to return in the response matching the given query.
1020
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1021
- * @param {*} [options] Override http request option.
1022
- * @throws {RequiredError}
1023
- */
1024
- listPackingGroupItems: async (inboundPlanId, packingGroupId, pageSize, paginationToken, options = {}) => {
1025
- // verify required parameter 'inboundPlanId' is not null or undefined
1026
- (0, common_1.assertParamExists)('listPackingGroupItems', 'inboundPlanId', inboundPlanId);
1027
- // verify required parameter 'packingGroupId' is not null or undefined
1028
- (0, common_1.assertParamExists)('listPackingGroupItems', 'packingGroupId', packingGroupId);
1029
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/items`
1030
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
1031
- .replace(`{${"packingGroupId"}}`, encodeURIComponent(String(packingGroupId)));
1032
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1033
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1034
- let baseOptions;
1035
- if (configuration) {
1036
- baseOptions = configuration.baseOptions;
1037
- }
1038
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1039
- const localVarHeaderParameter = {};
1040
- const localVarQueryParameter = {};
1041
- if (pageSize !== undefined) {
1042
- localVarQueryParameter['pageSize'] = pageSize;
1043
- }
1044
- if (paginationToken !== undefined) {
1045
- localVarQueryParameter['paginationToken'] = paginationToken;
1046
- }
1047
- localVarHeaderParameter['Accept'] = 'application/json';
1048
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1049
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1050
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1051
- return {
1052
- url: (0, common_1.toPathString)(localVarUrlObj),
1053
- options: localVarRequestOptions,
1054
- };
1055
- },
1056
- /**
1057
- * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.
1058
- * @param {string} inboundPlanId Identifier of an inbound plan.
1059
- * @param {number} [pageSize] The number of packing options to return in the response matching the given query.
1060
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1061
- * @param {*} [options] Override http request option.
1062
- * @throws {RequiredError}
1063
- */
1064
- listPackingOptions: async (inboundPlanId, pageSize, paginationToken, options = {}) => {
1065
- // verify required parameter 'inboundPlanId' is not null or undefined
1066
- (0, common_1.assertParamExists)('listPackingOptions', 'inboundPlanId', inboundPlanId);
1067
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions`
1068
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
1069
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1070
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1071
- let baseOptions;
1072
- if (configuration) {
1073
- baseOptions = configuration.baseOptions;
1074
- }
1075
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1076
- const localVarHeaderParameter = {};
1077
- const localVarQueryParameter = {};
1078
- if (pageSize !== undefined) {
1079
- localVarQueryParameter['pageSize'] = pageSize;
1080
- }
1081
- if (paginationToken !== undefined) {
1082
- localVarQueryParameter['paginationToken'] = paginationToken;
1083
- }
1084
- localVarHeaderParameter['Accept'] = 'application/json';
1085
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1086
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1087
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1088
- return {
1089
- url: (0, common_1.toPathString)(localVarUrlObj),
1090
- options: localVarRequestOptions,
1091
- };
1092
- },
1093
- /**
1094
- * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.
1095
- * @param {string} inboundPlanId Identifier of an inbound plan.
1096
- * @param {number} [pageSize] The number of placement options to return in the response matching the given query.
1097
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1098
- * @param {*} [options] Override http request option.
1099
- * @throws {RequiredError}
1100
- */
1101
- listPlacementOptions: async (inboundPlanId, pageSize, paginationToken, options = {}) => {
1102
- // verify required parameter 'inboundPlanId' is not null or undefined
1103
- (0, common_1.assertParamExists)('listPlacementOptions', 'inboundPlanId', inboundPlanId);
1104
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions`
1105
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
1106
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1107
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1108
- let baseOptions;
1109
- if (configuration) {
1110
- baseOptions = configuration.baseOptions;
1111
- }
1112
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1113
- const localVarHeaderParameter = {};
1114
- const localVarQueryParameter = {};
1115
- if (pageSize !== undefined) {
1116
- localVarQueryParameter['pageSize'] = pageSize;
1117
- }
1118
- if (paginationToken !== undefined) {
1119
- localVarQueryParameter['paginationToken'] = paginationToken;
1120
- }
1121
- localVarHeaderParameter['Accept'] = 'application/json';
1122
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1123
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1124
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1125
- return {
1126
- url: (0, common_1.toPathString)(localVarUrlObj),
1127
- options: localVarRequestOptions,
1128
- };
1129
- },
1130
- /**
1131
- * Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
1132
- * @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
1133
- * @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
1134
- * @param {*} [options] Override http request option.
1135
- * @throws {RequiredError}
1136
- */
1137
- listPrepDetails: async (marketplaceId, mskus, options = {}) => {
1138
- // verify required parameter 'marketplaceId' is not null or undefined
1139
- (0, common_1.assertParamExists)('listPrepDetails', 'marketplaceId', marketplaceId);
1140
- // verify required parameter 'mskus' is not null or undefined
1141
- (0, common_1.assertParamExists)('listPrepDetails', 'mskus', mskus);
1142
- const localVarPath = `/inbound/fba/2024-03-20/items/prepDetails`;
1143
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1144
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1145
- let baseOptions;
1146
- if (configuration) {
1147
- baseOptions = configuration.baseOptions;
1148
- }
1149
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1150
- const localVarHeaderParameter = {};
1151
- const localVarQueryParameter = {};
1152
- if (marketplaceId !== undefined) {
1153
- localVarQueryParameter['marketplaceId'] = marketplaceId;
1154
- }
1155
- if (mskus) {
1156
- localVarQueryParameter['mskus'] = mskus;
1157
- }
1158
- localVarHeaderParameter['Accept'] = 'application/json';
1159
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1160
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1161
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1162
- return {
1163
- url: (0, common_1.toPathString)(localVarUrlObj),
1164
- options: localVarRequestOptions,
1165
- };
1166
- },
1167
- /**
1168
- * Provides a paginated list of box packages in a shipment.
1169
- * @param {string} inboundPlanId Identifier of an inbound plan.
1170
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1171
- * @param {number} [pageSize] The number of boxes to return in the response matching the given query.
1172
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1173
- * @param {*} [options] Override http request option.
1174
- * @throws {RequiredError}
1175
- */
1176
- listShipmentBoxes: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
1177
- // verify required parameter 'inboundPlanId' is not null or undefined
1178
- (0, common_1.assertParamExists)('listShipmentBoxes', 'inboundPlanId', inboundPlanId);
1179
- // verify required parameter 'shipmentId' is not null or undefined
1180
- (0, common_1.assertParamExists)('listShipmentBoxes', 'shipmentId', shipmentId);
1181
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxes`
1182
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
1183
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
1184
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1185
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1186
- let baseOptions;
1187
- if (configuration) {
1188
- baseOptions = configuration.baseOptions;
1189
- }
1190
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1191
- const localVarHeaderParameter = {};
1192
- const localVarQueryParameter = {};
1193
- if (pageSize !== undefined) {
1194
- localVarQueryParameter['pageSize'] = pageSize;
1195
- }
1196
- if (paginationToken !== undefined) {
1197
- localVarQueryParameter['paginationToken'] = paginationToken;
1198
- }
1199
- localVarHeaderParameter['Accept'] = 'application/json';
1200
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1201
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1202
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1203
- return {
1204
- url: (0, common_1.toPathString)(localVarUrlObj),
1205
- options: localVarRequestOptions,
1206
- };
1207
- },
1208
- /**
1209
- * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
1210
- * @param {string} inboundPlanId Identifier of an inbound plan.
1211
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1212
- * @param {number} [pageSize] The number of content update previews to return.
1213
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1214
- * @param {*} [options] Override http request option.
1215
- * @throws {RequiredError}
1216
- */
1217
- listShipmentContentUpdatePreviews: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
1218
- // verify required parameter 'inboundPlanId' is not null or undefined
1219
- (0, common_1.assertParamExists)('listShipmentContentUpdatePreviews', 'inboundPlanId', inboundPlanId);
1220
- // verify required parameter 'shipmentId' is not null or undefined
1221
- (0, common_1.assertParamExists)('listShipmentContentUpdatePreviews', 'shipmentId', shipmentId);
1222
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews`
1223
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
1224
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
1225
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1226
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1227
- let baseOptions;
1228
- if (configuration) {
1229
- baseOptions = configuration.baseOptions;
1230
- }
1231
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1232
- const localVarHeaderParameter = {};
1233
- const localVarQueryParameter = {};
1234
- if (pageSize !== undefined) {
1235
- localVarQueryParameter['pageSize'] = pageSize;
1236
- }
1237
- if (paginationToken !== undefined) {
1238
- localVarQueryParameter['paginationToken'] = paginationToken;
1239
- }
1240
- localVarHeaderParameter['Accept'] = 'application/json';
1241
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1242
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1243
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1244
- return {
1245
- url: (0, common_1.toPathString)(localVarUrlObj),
1246
- options: localVarRequestOptions,
1247
- };
1248
- },
1249
- /**
1250
- * Provides a paginated list of item packages in a shipment.
1251
- * @param {string} inboundPlanId Identifier of an inbound plan.
1252
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1253
- * @param {number} [pageSize] The number of items to return in the response matching the given query.
1254
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1255
- * @param {*} [options] Override http request option.
1256
- * @throws {RequiredError}
1257
- */
1258
- listShipmentItems: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
1259
- // verify required parameter 'inboundPlanId' is not null or undefined
1260
- (0, common_1.assertParamExists)('listShipmentItems', 'inboundPlanId', inboundPlanId);
1261
- // verify required parameter 'shipmentId' is not null or undefined
1262
- (0, common_1.assertParamExists)('listShipmentItems', 'shipmentId', shipmentId);
1263
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/items`
1264
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
1265
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
1266
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1267
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1268
- let baseOptions;
1269
- if (configuration) {
1270
- baseOptions = configuration.baseOptions;
1271
- }
1272
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1273
- const localVarHeaderParameter = {};
1274
- const localVarQueryParameter = {};
1275
- if (pageSize !== undefined) {
1276
- localVarQueryParameter['pageSize'] = pageSize;
1277
- }
1278
- if (paginationToken !== undefined) {
1279
- localVarQueryParameter['paginationToken'] = paginationToken;
1280
- }
1281
- localVarHeaderParameter['Accept'] = 'application/json';
1282
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1283
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1284
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1285
- return {
1286
- url: (0, common_1.toPathString)(localVarUrlObj),
1287
- options: localVarRequestOptions,
1288
- };
1289
- },
1290
- /**
1291
- * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
1292
- * @param {string} inboundPlanId Identifier of an inbound plan.
1293
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1294
- * @param {number} [pageSize] The number of pallets to return in the response matching the given query.
1295
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1296
- * @param {*} [options] Override http request option.
1297
- * @throws {RequiredError}
1298
- */
1299
- listShipmentPallets: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
1300
- // verify required parameter 'inboundPlanId' is not null or undefined
1301
- (0, common_1.assertParamExists)('listShipmentPallets', 'inboundPlanId', inboundPlanId);
1302
- // verify required parameter 'shipmentId' is not null or undefined
1303
- (0, common_1.assertParamExists)('listShipmentPallets', 'shipmentId', shipmentId);
1304
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/pallets`
1305
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
1306
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
1307
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1308
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1309
- let baseOptions;
1310
- if (configuration) {
1311
- baseOptions = configuration.baseOptions;
1312
- }
1313
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1314
- const localVarHeaderParameter = {};
1315
- const localVarQueryParameter = {};
1316
- if (pageSize !== undefined) {
1317
- localVarQueryParameter['pageSize'] = pageSize;
1318
- }
1319
- if (paginationToken !== undefined) {
1320
- localVarQueryParameter['paginationToken'] = paginationToken;
1321
- }
1322
- localVarHeaderParameter['Accept'] = 'application/json';
1323
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1324
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1325
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1326
- return {
1327
- url: (0, common_1.toPathString)(localVarUrlObj),
1328
- options: localVarRequestOptions,
1329
- };
1330
- },
1331
- /**
1332
- * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available.
1333
- * @param {string} inboundPlanId Identifier of an inbound plan.
1334
- * @param {number} [pageSize] The number of transportation options to return in the response matching the given query.
1335
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1336
- * @param {string} [placementOptionId] The placement option to get transportation options for. Either &#x60;placementOptionId&#x60; or &#x60;shipmentId&#x60; must be specified.
1337
- * @param {string} [shipmentId] The shipment to get transportation options for. Either &#x60;placementOptionId&#x60; or &#x60;shipmentId&#x60; must be specified.
1338
- * @param {*} [options] Override http request option.
1339
- * @throws {RequiredError}
1340
- */
1341
- listTransportationOptions: async (inboundPlanId, pageSize, paginationToken, placementOptionId, shipmentId, options = {}) => {
1342
- // verify required parameter 'inboundPlanId' is not null or undefined
1343
- (0, common_1.assertParamExists)('listTransportationOptions', 'inboundPlanId', inboundPlanId);
1344
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions`
1345
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
1346
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1347
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1348
- let baseOptions;
1349
- if (configuration) {
1350
- baseOptions = configuration.baseOptions;
1351
- }
1352
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1353
- const localVarHeaderParameter = {};
1354
- const localVarQueryParameter = {};
1355
- if (pageSize !== undefined) {
1356
- localVarQueryParameter['pageSize'] = pageSize;
1357
- }
1358
- if (paginationToken !== undefined) {
1359
- localVarQueryParameter['paginationToken'] = paginationToken;
1360
- }
1361
- if (placementOptionId !== undefined) {
1362
- localVarQueryParameter['placementOptionId'] = placementOptionId;
1363
- }
1364
- if (shipmentId !== undefined) {
1365
- localVarQueryParameter['shipmentId'] = shipmentId;
1366
- }
1367
- localVarHeaderParameter['Accept'] = 'application/json';
1368
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1369
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1370
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1371
- return {
1372
- url: (0, common_1.toPathString)(localVarUrlObj),
1373
- options: localVarRequestOptions,
1374
- };
1375
- },
1376
- /**
1377
- * Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
1378
- * @param {string} inboundPlanId Identifier of an inbound plan.
1379
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1380
- * @param {string} slotId An identifier to a self-ship appointment slot.
1381
- * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to &#x60;scheduleSelfShipAppointment&#x60;.
1382
- * @param {*} [options] Override http request option.
1383
- * @throws {RequiredError}
1384
- */
1385
- scheduleSelfShipAppointment: async (inboundPlanId, shipmentId, slotId, body, options = {}) => {
1386
- // verify required parameter 'inboundPlanId' is not null or undefined
1387
- (0, common_1.assertParamExists)('scheduleSelfShipAppointment', 'inboundPlanId', inboundPlanId);
1388
- // verify required parameter 'shipmentId' is not null or undefined
1389
- (0, common_1.assertParamExists)('scheduleSelfShipAppointment', 'shipmentId', shipmentId);
1390
- // verify required parameter 'slotId' is not null or undefined
1391
- (0, common_1.assertParamExists)('scheduleSelfShipAppointment', 'slotId', slotId);
1392
- // verify required parameter 'body' is not null or undefined
1393
- (0, common_1.assertParamExists)('scheduleSelfShipAppointment', 'body', body);
1394
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots/{slotId}/schedule`
1395
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
1396
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)))
1397
- .replace(`{${"slotId"}}`, encodeURIComponent(String(slotId)));
1398
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1399
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1400
- let baseOptions;
1401
- if (configuration) {
1402
- baseOptions = configuration.baseOptions;
1403
- }
1404
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1405
- const localVarHeaderParameter = {};
1406
- const localVarQueryParameter = {};
1407
- localVarHeaderParameter['Content-Type'] = 'application/json';
1408
- localVarHeaderParameter['Accept'] = 'application/json';
1409
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1410
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1411
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1412
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
1413
- return {
1414
- url: (0, common_1.toPathString)(localVarUrlObj),
1415
- options: localVarRequestOptions,
1416
- };
1417
- },
1418
- /**
1419
- * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates.
1420
- * @param {string} inboundPlanId Identifier of an inbound plan.
1421
- * @param {SetPackingInformationRequest} body The body of the request to &#x60;setPackingInformation&#x60;.
1422
- * @param {*} [options] Override http request option.
1423
- * @throws {RequiredError}
1424
- */
1425
- setPackingInformation: async (inboundPlanId, body, options = {}) => {
1426
- // verify required parameter 'inboundPlanId' is not null or undefined
1427
- (0, common_1.assertParamExists)('setPackingInformation', 'inboundPlanId', inboundPlanId);
1428
- // verify required parameter 'body' is not null or undefined
1429
- (0, common_1.assertParamExists)('setPackingInformation', 'body', body);
1430
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingInformation`
1431
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
1432
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1433
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1434
- let baseOptions;
1435
- if (configuration) {
1436
- baseOptions = configuration.baseOptions;
1437
- }
1438
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1439
- const localVarHeaderParameter = {};
1440
- const localVarQueryParameter = {};
1441
- localVarHeaderParameter['Content-Type'] = 'application/json';
1442
- localVarHeaderParameter['Accept'] = 'application/json';
1443
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1444
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1445
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1446
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
1447
- return {
1448
- url: (0, common_1.toPathString)(localVarUrlObj),
1449
- options: localVarRequestOptions,
1450
- };
1451
- },
1452
- /**
1453
- * Set the preparation details for a list of MSKUs in a specified marketplace.
1454
- * @param {SetPrepDetailsRequest} body The body of the request to &#x60;setPrepDetails&#x60;.
1455
- * @param {*} [options] Override http request option.
1456
- * @throws {RequiredError}
1457
- */
1458
- setPrepDetails: async (body, options = {}) => {
1459
- // verify required parameter 'body' is not null or undefined
1460
- (0, common_1.assertParamExists)('setPrepDetails', 'body', body);
1461
- const localVarPath = `/inbound/fba/2024-03-20/items/prepDetails`;
1462
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1463
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1464
- let baseOptions;
1465
- if (configuration) {
1466
- baseOptions = configuration.baseOptions;
1467
- }
1468
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1469
- const localVarHeaderParameter = {};
1470
- const localVarQueryParameter = {};
1471
- localVarHeaderParameter['Content-Type'] = 'application/json';
1472
- localVarHeaderParameter['Accept'] = 'application/json';
1473
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1474
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1475
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1476
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
1477
- return {
1478
- url: (0, common_1.toPathString)(localVarUrlObj),
1479
- options: localVarRequestOptions,
1480
- };
1481
- },
1482
- /**
1483
- * Updates the name of an existing inbound plan.
1484
- * @param {string} inboundPlanId Identifier of an inbound plan.
1485
- * @param {UpdateInboundPlanNameRequest} body The body of the request to &#x60;updateInboundPlanName&#x60;.
1486
- * @param {*} [options] Override http request option.
1487
- * @throws {RequiredError}
1488
- */
1489
- updateInboundPlanName: async (inboundPlanId, body, options = {}) => {
1490
- // verify required parameter 'inboundPlanId' is not null or undefined
1491
- (0, common_1.assertParamExists)('updateInboundPlanName', 'inboundPlanId', inboundPlanId);
1492
- // verify required parameter 'body' is not null or undefined
1493
- (0, common_1.assertParamExists)('updateInboundPlanName', 'body', body);
1494
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/name`
1495
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
1496
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1497
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1498
- let baseOptions;
1499
- if (configuration) {
1500
- baseOptions = configuration.baseOptions;
1501
- }
1502
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
1503
- const localVarHeaderParameter = {};
1504
- const localVarQueryParameter = {};
1505
- localVarHeaderParameter['Content-Type'] = 'application/json';
1506
- localVarHeaderParameter['Accept'] = 'application/json';
1507
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1508
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1509
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1510
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
1511
- return {
1512
- url: (0, common_1.toPathString)(localVarUrlObj),
1513
- options: localVarRequestOptions,
1514
- };
1515
- },
1516
- /**
1517
- * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.
1518
- * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
1519
- * @param {UpdateItemComplianceDetailsRequest} body The body of the request to &#x60;updateItemComplianceDetails&#x60;.
1520
- * @param {*} [options] Override http request option.
1521
- * @throws {RequiredError}
1522
- */
1523
- updateItemComplianceDetails: async (marketplaceId, body, options = {}) => {
1524
- // verify required parameter 'marketplaceId' is not null or undefined
1525
- (0, common_1.assertParamExists)('updateItemComplianceDetails', 'marketplaceId', marketplaceId);
1526
- // verify required parameter 'body' is not null or undefined
1527
- (0, common_1.assertParamExists)('updateItemComplianceDetails', 'body', body);
1528
- const localVarPath = `/inbound/fba/2024-03-20/items/compliance`;
1529
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1530
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1531
- let baseOptions;
1532
- if (configuration) {
1533
- baseOptions = configuration.baseOptions;
1534
- }
1535
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
1536
- const localVarHeaderParameter = {};
1537
- const localVarQueryParameter = {};
1538
- if (marketplaceId !== undefined) {
1539
- localVarQueryParameter['marketplaceId'] = marketplaceId;
1540
- }
1541
- localVarHeaderParameter['Content-Type'] = 'application/json';
1542
- localVarHeaderParameter['Accept'] = 'application/json';
1543
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1544
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1545
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1546
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
1547
- return {
1548
- url: (0, common_1.toPathString)(localVarUrlObj),
1549
- options: localVarRequestOptions,
1550
- };
1551
- },
1552
- /**
1553
- * Updates the name of an existing shipment.
1554
- * @param {string} inboundPlanId Identifier of an inbound plan.
1555
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1556
- * @param {UpdateShipmentNameRequest} body The body of the request to &#x60;updateShipmentName&#x60;.
1557
- * @param {*} [options] Override http request option.
1558
- * @throws {RequiredError}
1559
- */
1560
- updateShipmentName: async (inboundPlanId, shipmentId, body, options = {}) => {
1561
- // verify required parameter 'inboundPlanId' is not null or undefined
1562
- (0, common_1.assertParamExists)('updateShipmentName', 'inboundPlanId', inboundPlanId);
1563
- // verify required parameter 'shipmentId' is not null or undefined
1564
- (0, common_1.assertParamExists)('updateShipmentName', 'shipmentId', shipmentId);
1565
- // verify required parameter 'body' is not null or undefined
1566
- (0, common_1.assertParamExists)('updateShipmentName', 'body', body);
1567
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/name`
1568
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
1569
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
1570
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1571
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1572
- let baseOptions;
1573
- if (configuration) {
1574
- baseOptions = configuration.baseOptions;
1575
- }
1576
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
1577
- const localVarHeaderParameter = {};
1578
- const localVarQueryParameter = {};
1579
- localVarHeaderParameter['Content-Type'] = 'application/json';
1580
- localVarHeaderParameter['Accept'] = 'application/json';
1581
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1582
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1583
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1584
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
1585
- return {
1586
- url: (0, common_1.toPathString)(localVarUrlObj),
1587
- options: localVarRequestOptions,
1588
- };
1589
- },
1590
- /**
1591
- * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.
1592
- * @param {string} inboundPlanId Identifier of an inbound plan.
1593
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1594
- * @param {UpdateShipmentSourceAddressRequest} body The body of the request to &#x60;updateShipmentSourceAddress&#x60;.
1595
- * @param {*} [options] Override http request option.
1596
- * @throws {RequiredError}
1597
- */
1598
- updateShipmentSourceAddress: async (inboundPlanId, shipmentId, body, options = {}) => {
1599
- // verify required parameter 'inboundPlanId' is not null or undefined
1600
- (0, common_1.assertParamExists)('updateShipmentSourceAddress', 'inboundPlanId', inboundPlanId);
1601
- // verify required parameter 'shipmentId' is not null or undefined
1602
- (0, common_1.assertParamExists)('updateShipmentSourceAddress', 'shipmentId', shipmentId);
1603
- // verify required parameter 'body' is not null or undefined
1604
- (0, common_1.assertParamExists)('updateShipmentSourceAddress', 'body', body);
1605
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/sourceAddress`
1606
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
1607
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
1608
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1609
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1610
- let baseOptions;
1611
- if (configuration) {
1612
- baseOptions = configuration.baseOptions;
1613
- }
1614
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
1615
- const localVarHeaderParameter = {};
1616
- const localVarQueryParameter = {};
1617
- localVarHeaderParameter['Content-Type'] = 'application/json';
1618
- localVarHeaderParameter['Accept'] = 'application/json';
1619
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1620
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1621
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1622
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
1623
- return {
1624
- url: (0, common_1.toPathString)(localVarUrlObj),
1625
- options: localVarRequestOptions,
1626
- };
1627
- },
1628
- /**
1629
- * Updates a shipment\'s tracking details.
1630
- * @param {string} inboundPlanId Identifier of an inbound plan.
1631
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1632
- * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to &#x60;updateShipmentTrackingDetails&#x60;.
1633
- * @param {*} [options] Override http request option.
1634
- * @throws {RequiredError}
1635
- */
1636
- updateShipmentTrackingDetails: async (inboundPlanId, shipmentId, body, options = {}) => {
1637
- // verify required parameter 'inboundPlanId' is not null or undefined
1638
- (0, common_1.assertParamExists)('updateShipmentTrackingDetails', 'inboundPlanId', inboundPlanId);
1639
- // verify required parameter 'shipmentId' is not null or undefined
1640
- (0, common_1.assertParamExists)('updateShipmentTrackingDetails', 'shipmentId', shipmentId);
1641
- // verify required parameter 'body' is not null or undefined
1642
- (0, common_1.assertParamExists)('updateShipmentTrackingDetails', 'body', body);
1643
- const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/trackingDetails`
1644
- .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
1645
- .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
1646
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1647
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1648
- let baseOptions;
1649
- if (configuration) {
1650
- baseOptions = configuration.baseOptions;
1651
- }
1652
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
1653
- const localVarHeaderParameter = {};
1654
- const localVarQueryParameter = {};
1655
- localVarHeaderParameter['Content-Type'] = 'application/json';
1656
- localVarHeaderParameter['Accept'] = 'application/json';
1657
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1658
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1659
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1660
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
1661
- return {
1662
- url: (0, common_1.toPathString)(localVarUrlObj),
1663
- options: localVarRequestOptions,
1664
- };
1665
- },
1666
- };
1667
- };
1668
- exports.FulfillmentInboundApiAxiosParamCreator = FulfillmentInboundApiAxiosParamCreator;
1669
- /**
1670
- * FulfillmentInboundApi - functional programming interface
1671
- */
1672
- const FulfillmentInboundApiFp = function (configuration) {
1673
- const localVarAxiosParamCreator = (0, exports.FulfillmentInboundApiAxiosParamCreator)(configuration);
1674
- return {
1675
- /**
1676
- * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments.
1677
- * @param {string} inboundPlanId Identifier of an inbound plan.
1678
- * @param {*} [options] Override http request option.
1679
- * @throws {RequiredError}
1680
- */
1681
- async cancelInboundPlan(inboundPlanId, options) {
1682
- const localVarAxiosArgs = await localVarAxiosParamCreator.cancelInboundPlan(inboundPlanId, options);
1683
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1684
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.cancelInboundPlan']?.[localVarOperationServerIndex]?.url;
1685
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1686
- },
1687
- /**
1688
- * Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
1689
- * @param {string} inboundPlanId Identifier of an inbound plan.
1690
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1691
- * @param {CancelSelfShipAppointmentRequest} body The body of the request to &#x60;cancelSelfShipAppointment&#x60;.
1692
- * @param {*} [options] Override http request option.
1693
- * @throws {RequiredError}
1694
- */
1695
- async cancelSelfShipAppointment(inboundPlanId, shipmentId, body, options) {
1696
- const localVarAxiosArgs = await localVarAxiosParamCreator.cancelSelfShipAppointment(inboundPlanId, shipmentId, body, options);
1697
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1698
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.cancelSelfShipAppointment']?.[localVarOperationServerIndex]?.url;
1699
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1700
- },
1701
- /**
1702
- * 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.
1703
- * @param {string} inboundPlanId Identifier of an inbound plan.
1704
- * @param {string} shipmentId The shipment to confirm the delivery window option for.
1705
- * @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed.
1706
- * @param {*} [options] Override http request option.
1707
- * @throws {RequiredError}
1708
- */
1709
- async confirmDeliveryWindowOptions(inboundPlanId, shipmentId, deliveryWindowOptionId, options) {
1710
- const localVarAxiosArgs = await localVarAxiosParamCreator.confirmDeliveryWindowOptions(inboundPlanId, shipmentId, deliveryWindowOptionId, options);
1711
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1712
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.confirmDeliveryWindowOptions']?.[localVarOperationServerIndex]?.url;
1713
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1714
- },
1715
- /**
1716
- * Confirms the packing option for an inbound plan.
1717
- * @param {string} inboundPlanId Identifier of an inbound plan.
1718
- * @param {string} packingOptionId Identifier of a packing option.
1719
- * @param {*} [options] Override http request option.
1720
- * @throws {RequiredError}
1721
- */
1722
- async confirmPackingOption(inboundPlanId, packingOptionId, options) {
1723
- const localVarAxiosArgs = await localVarAxiosParamCreator.confirmPackingOption(inboundPlanId, packingOptionId, options);
1724
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1725
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.confirmPackingOption']?.[localVarOperationServerIndex]?.url;
1726
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1727
- },
1728
- /**
1729
- * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
1730
- * @param {string} inboundPlanId Identifier of an inbound plan.
1731
- * @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
1732
- * @param {*} [options] Override http request option.
1733
- * @throws {RequiredError}
1734
- */
1735
- async confirmPlacementOption(inboundPlanId, placementOptionId, options) {
1736
- const localVarAxiosArgs = await localVarAxiosParamCreator.confirmPlacementOption(inboundPlanId, placementOptionId, options);
1737
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1738
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.confirmPlacementOption']?.[localVarOperationServerIndex]?.url;
1739
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1740
- },
1741
- /**
1742
- * Confirm a shipment content update preview and accept the changes in transportation cost.
1743
- * @param {string} inboundPlanId Identifier of an inbound plan.
1744
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1745
- * @param {string} contentUpdatePreviewId Identifier of a content update preview.
1746
- * @param {*} [options] Override http request option.
1747
- * @throws {RequiredError}
1748
- */
1749
- async confirmShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options) {
1750
- const localVarAxiosArgs = await localVarAxiosParamCreator.confirmShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options);
1751
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1752
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.confirmShipmentContentUpdatePreview']?.[localVarOperationServerIndex]?.url;
1753
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1754
- },
1755
- /**
1756
- * 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.
1757
- * @param {string} inboundPlanId Identifier of an inbound plan.
1758
- * @param {ConfirmTransportationOptionsRequest} body The body of the request to &#x60;confirmTransportationOptions&#x60;.
1759
- * @param {*} [options] Override http request option.
1760
- * @throws {RequiredError}
1761
- */
1762
- async confirmTransportationOptions(inboundPlanId, body, options) {
1763
- const localVarAxiosArgs = await localVarAxiosParamCreator.confirmTransportationOptions(inboundPlanId, body, options);
1764
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1765
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.confirmTransportationOptions']?.[localVarOperationServerIndex]?.url;
1766
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1767
- },
1768
- /**
1769
- * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network.
1770
- * @param {CreateInboundPlanRequest} body The body of the request to &#x60;createInboundPlan&#x60;.
1771
- * @param {*} [options] Override http request option.
1772
- * @throws {RequiredError}
1773
- */
1774
- async createInboundPlan(body, options) {
1775
- const localVarAxiosArgs = await localVarAxiosParamCreator.createInboundPlan(body, options);
1776
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1777
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.createInboundPlan']?.[localVarOperationServerIndex]?.url;
1778
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1779
- },
1780
- /**
1781
- * For a given marketplace - creates labels for a list of MSKUs.
1782
- * @param {CreateMarketplaceItemLabelsRequest} body The body of the request to &#x60;createMarketplaceItemLabels&#x60;.
1783
- * @param {*} [options] Override http request option.
1784
- * @throws {RequiredError}
1785
- */
1786
- async createMarketplaceItemLabels(body, options) {
1787
- const localVarAxiosArgs = await localVarAxiosParamCreator.createMarketplaceItemLabels(body, options);
1788
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1789
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.createMarketplaceItemLabels']?.[localVarOperationServerIndex]?.url;
1790
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1791
- },
1792
- /**
1793
- * Generates available delivery window options for a given shipment.
1794
- * @param {string} inboundPlanId Identifier of an inbound plan.
1795
- * @param {string} shipmentId The shipment to generate delivery window options for.
1796
- * @param {*} [options] Override http request option.
1797
- * @throws {RequiredError}
1798
- */
1799
- async generateDeliveryWindowOptions(inboundPlanId, shipmentId, options) {
1800
- const localVarAxiosArgs = await localVarAxiosParamCreator.generateDeliveryWindowOptions(inboundPlanId, shipmentId, options);
1801
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1802
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.generateDeliveryWindowOptions']?.[localVarOperationServerIndex]?.url;
1803
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1804
- },
1805
- /**
1806
- * Generates available packing options for the inbound plan.
1807
- * @param {string} inboundPlanId Identifier of an inbound plan.
1808
- * @param {*} [options] Override http request option.
1809
- * @throws {RequiredError}
1810
- */
1811
- async generatePackingOptions(inboundPlanId, options) {
1812
- const localVarAxiosArgs = await localVarAxiosParamCreator.generatePackingOptions(inboundPlanId, options);
1813
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1814
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.generatePackingOptions']?.[localVarOperationServerIndex]?.url;
1815
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1816
- },
1817
- /**
1818
- * Generates placement options for the inbound plan.
1819
- * @param {string} inboundPlanId Identifier of an inbound plan.
1820
- * @param {GeneratePlacementOptionsRequest} body The body of the request to &#x60;generatePlacementOptions&#x60;.
1821
- * @param {*} [options] Override http request option.
1822
- * @throws {RequiredError}
1823
- */
1824
- async generatePlacementOptions(inboundPlanId, body, options) {
1825
- const localVarAxiosArgs = await localVarAxiosParamCreator.generatePlacementOptions(inboundPlanId, body, options);
1826
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1827
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.generatePlacementOptions']?.[localVarOperationServerIndex]?.url;
1828
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1829
- },
1830
- /**
1831
- * Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
1832
- * @param {string} inboundPlanId Identifier of an inbound plan.
1833
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1834
- * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to &#x60;generateSelfShipAppointmentSlots&#x60;.
1835
- * @param {*} [options] Override http request option.
1836
- * @throws {RequiredError}
1837
- */
1838
- async generateSelfShipAppointmentSlots(inboundPlanId, shipmentId, body, options) {
1839
- const localVarAxiosArgs = await localVarAxiosParamCreator.generateSelfShipAppointmentSlots(inboundPlanId, shipmentId, body, options);
1840
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1841
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.generateSelfShipAppointmentSlots']?.[localVarOperationServerIndex]?.url;
1842
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1843
- },
1844
- /**
1845
- * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.
1846
- * @param {string} inboundPlanId Identifier of an inbound plan.
1847
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1848
- * @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to &#x60;generateShipmentContentUpdatePreviews&#x60;.
1849
- * @param {*} [options] Override http request option.
1850
- * @throws {RequiredError}
1851
- */
1852
- async generateShipmentContentUpdatePreviews(inboundPlanId, shipmentId, body, options) {
1853
- const localVarAxiosArgs = await localVarAxiosParamCreator.generateShipmentContentUpdatePreviews(inboundPlanId, shipmentId, body, options);
1854
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1855
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.generateShipmentContentUpdatePreviews']?.[localVarOperationServerIndex]?.url;
1856
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1857
- },
1858
- /**
1859
- * Generates available transportation options for a given placement option.
1860
- * @param {string} inboundPlanId Identifier of an inbound plan.
1861
- * @param {GenerateTransportationOptionsRequest} body The body of the request to &#x60;generateTransportationOptions&#x60;.
1862
- * @param {*} [options] Override http request option.
1863
- * @throws {RequiredError}
1864
- */
1865
- async generateTransportationOptions(inboundPlanId, body, options) {
1866
- const localVarAxiosArgs = await localVarAxiosParamCreator.generateTransportationOptions(inboundPlanId, body, options);
1867
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1868
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.generateTransportationOptions']?.[localVarOperationServerIndex]?.url;
1869
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1870
- },
1871
- /**
1872
- * Provide delivery challan document for PCP transportation in IN marketplace.
1873
- * @param {string} inboundPlanId Identifier of an inbound plan.
1874
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1875
- * @param {*} [options] Override http request option.
1876
- * @throws {RequiredError}
1877
- */
1878
- async getDeliveryChallanDocument(inboundPlanId, shipmentId, options) {
1879
- const localVarAxiosArgs = await localVarAxiosParamCreator.getDeliveryChallanDocument(inboundPlanId, shipmentId, options);
1880
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1881
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getDeliveryChallanDocument']?.[localVarOperationServerIndex]?.url;
1882
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1883
- },
1884
- /**
1885
- * Gets the status of the processing of an asynchronous API call.
1886
- * @param {string} operationId Identifier of an asynchronous operation.
1887
- * @param {*} [options] Override http request option.
1888
- * @throws {RequiredError}
1889
- */
1890
- async getInboundOperationStatus(operationId, options) {
1891
- const localVarAxiosArgs = await localVarAxiosParamCreator.getInboundOperationStatus(operationId, options);
1892
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1893
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getInboundOperationStatus']?.[localVarOperationServerIndex]?.url;
1894
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1895
- },
1896
- /**
1897
- * Fetches the top level information about an inbound plan.
1898
- * @param {string} inboundPlanId Identifier of an inbound plan.
1899
- * @param {*} [options] Override http request option.
1900
- * @throws {RequiredError}
1901
- */
1902
- async getInboundPlan(inboundPlanId, options) {
1903
- const localVarAxiosArgs = await localVarAxiosParamCreator.getInboundPlan(inboundPlanId, options);
1904
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1905
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getInboundPlan']?.[localVarOperationServerIndex]?.url;
1906
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1907
- },
1908
- /**
1909
- * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
1910
- * @param {string} inboundPlanId Identifier of an inbound plan.
1911
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1912
- * @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
1913
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1914
- * @param {*} [options] Override http request option.
1915
- * @throws {RequiredError}
1916
- */
1917
- async getSelfShipAppointmentSlots(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
1918
- const localVarAxiosArgs = await localVarAxiosParamCreator.getSelfShipAppointmentSlots(inboundPlanId, shipmentId, pageSize, paginationToken, options);
1919
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1920
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getSelfShipAppointmentSlots']?.[localVarOperationServerIndex]?.url;
1921
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1922
- },
1923
- /**
1924
- * 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.
1925
- * @param {string} inboundPlanId Identifier of an inbound plan.
1926
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1927
- * @param {*} [options] Override http request option.
1928
- * @throws {RequiredError}
1929
- */
1930
- async getShipment(inboundPlanId, shipmentId, options) {
1931
- const localVarAxiosArgs = await localVarAxiosParamCreator.getShipment(inboundPlanId, shipmentId, options);
1932
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1933
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getShipment']?.[localVarOperationServerIndex]?.url;
1934
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1935
- },
1936
- /**
1937
- * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
1938
- * @param {string} inboundPlanId Identifier of an inbound plan.
1939
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1940
- * @param {string} contentUpdatePreviewId Identifier of a content update preview.
1941
- * @param {*} [options] Override http request option.
1942
- * @throws {RequiredError}
1943
- */
1944
- async getShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options) {
1945
- const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options);
1946
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1947
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getShipmentContentUpdatePreview']?.[localVarOperationServerIndex]?.url;
1948
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1949
- },
1950
- /**
1951
- * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available.
1952
- * @param {string} inboundPlanId Identifier of an inbound plan.
1953
- * @param {string} shipmentId The shipment to get delivery window options for.
1954
- * @param {number} [pageSize] The number of delivery window options to return in the response matching the given query.
1955
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1956
- * @param {*} [options] Override http request option.
1957
- * @throws {RequiredError}
1958
- */
1959
- async listDeliveryWindowOptions(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
1960
- const localVarAxiosArgs = await localVarAxiosParamCreator.listDeliveryWindowOptions(inboundPlanId, shipmentId, pageSize, paginationToken, options);
1961
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1962
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listDeliveryWindowOptions']?.[localVarOperationServerIndex]?.url;
1963
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1964
- },
1965
- /**
1966
- * Provides a paginated list of box packages in an inbound plan.
1967
- * @param {string} inboundPlanId Identifier of an inbound plan.
1968
- * @param {number} [pageSize] The number of boxes to return in the response matching the given query.
1969
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1970
- * @param {*} [options] Override http request option.
1971
- * @throws {RequiredError}
1972
- */
1973
- async listInboundPlanBoxes(inboundPlanId, pageSize, paginationToken, options) {
1974
- const localVarAxiosArgs = await localVarAxiosParamCreator.listInboundPlanBoxes(inboundPlanId, pageSize, paginationToken, options);
1975
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1976
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listInboundPlanBoxes']?.[localVarOperationServerIndex]?.url;
1977
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1978
- },
1979
- /**
1980
- * Provides a paginated list of item packages in an inbound plan.
1981
- * @param {string} inboundPlanId Identifier of an inbound plan.
1982
- * @param {number} [pageSize] The number of items to return in the response matching the given query.
1983
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1984
- * @param {*} [options] Override http request option.
1985
- * @throws {RequiredError}
1986
- */
1987
- async listInboundPlanItems(inboundPlanId, pageSize, paginationToken, options) {
1988
- const localVarAxiosArgs = await localVarAxiosParamCreator.listInboundPlanItems(inboundPlanId, pageSize, paginationToken, options);
1989
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1990
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listInboundPlanItems']?.[localVarOperationServerIndex]?.url;
1991
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1992
- },
1993
- /**
1994
- * 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.
1995
- * @param {string} inboundPlanId Identifier of an inbound plan.
1996
- * @param {number} [pageSize] The number of pallets to return in the response matching the given query.
1997
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
1998
- * @param {*} [options] Override http request option.
1999
- * @throws {RequiredError}
2000
- */
2001
- async listInboundPlanPallets(inboundPlanId, pageSize, paginationToken, options) {
2002
- const localVarAxiosArgs = await localVarAxiosParamCreator.listInboundPlanPallets(inboundPlanId, pageSize, paginationToken, options);
2003
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2004
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listInboundPlanPallets']?.[localVarOperationServerIndex]?.url;
2005
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2006
- },
2007
- /**
2008
- * Provides a list of inbound plans with minimal information.
2009
- * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query.
2010
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
2011
- * @param {ListInboundPlansStatusEnum} [status] The status of an inbound plan.
2012
- * @param {ListInboundPlansSortByEnum} [sortBy] Sort by field.
2013
- * @param {ListInboundPlansSortOrderEnum} [sortOrder] The sort order.
2014
- * @param {*} [options] Override http request option.
2015
- * @throws {RequiredError}
2016
- */
2017
- async listInboundPlans(pageSize, paginationToken, status, sortBy, sortOrder, options) {
2018
- const localVarAxiosArgs = await localVarAxiosParamCreator.listInboundPlans(pageSize, paginationToken, status, sortBy, sortOrder, options);
2019
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2020
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listInboundPlans']?.[localVarOperationServerIndex]?.url;
2021
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2022
- },
2023
- /**
2024
- * List the inbound compliance details for MSKUs in a given marketplace. **Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). The following characters must be double percent encoded: - `%` - `+` - `,` **Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
2025
- * @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
2026
- * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
2027
- * @param {*} [options] Override http request option.
2028
- * @throws {RequiredError}
2029
- */
2030
- async listItemComplianceDetails(mskus, marketplaceId, options) {
2031
- const localVarAxiosArgs = await localVarAxiosParamCreator.listItemComplianceDetails(mskus, marketplaceId, options);
2032
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2033
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listItemComplianceDetails']?.[localVarOperationServerIndex]?.url;
2034
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2035
- },
2036
- /**
2037
- * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.
2038
- * @param {string} inboundPlanId Identifier of an inbound plan.
2039
- * @param {string} packingGroupId Identifier of a packing group.
2040
- * @param {number} [pageSize] The number of packing group boxes to return in the response matching the given query.
2041
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
2042
- * @param {*} [options] Override http request option.
2043
- * @throws {RequiredError}
2044
- */
2045
- async listPackingGroupBoxes(inboundPlanId, packingGroupId, pageSize, paginationToken, options) {
2046
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPackingGroupBoxes(inboundPlanId, packingGroupId, pageSize, paginationToken, options);
2047
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2048
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listPackingGroupBoxes']?.[localVarOperationServerIndex]?.url;
2049
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2050
- },
2051
- /**
2052
- * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.
2053
- * @param {string} inboundPlanId Identifier of an inbound plan.
2054
- * @param {string} packingGroupId Identifier of a packing group.
2055
- * @param {number} [pageSize] The number of packing group items to return in the response matching the given query.
2056
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
2057
- * @param {*} [options] Override http request option.
2058
- * @throws {RequiredError}
2059
- */
2060
- async listPackingGroupItems(inboundPlanId, packingGroupId, pageSize, paginationToken, options) {
2061
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPackingGroupItems(inboundPlanId, packingGroupId, pageSize, paginationToken, options);
2062
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2063
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listPackingGroupItems']?.[localVarOperationServerIndex]?.url;
2064
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2065
- },
2066
- /**
2067
- * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.
2068
- * @param {string} inboundPlanId Identifier of an inbound plan.
2069
- * @param {number} [pageSize] The number of packing options to return in the response matching the given query.
2070
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
2071
- * @param {*} [options] Override http request option.
2072
- * @throws {RequiredError}
2073
- */
2074
- async listPackingOptions(inboundPlanId, pageSize, paginationToken, options) {
2075
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPackingOptions(inboundPlanId, pageSize, paginationToken, options);
2076
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2077
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listPackingOptions']?.[localVarOperationServerIndex]?.url;
2078
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2079
- },
2080
- /**
2081
- * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.
2082
- * @param {string} inboundPlanId Identifier of an inbound plan.
2083
- * @param {number} [pageSize] The number of placement options to return in the response matching the given query.
2084
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
2085
- * @param {*} [options] Override http request option.
2086
- * @throws {RequiredError}
2087
- */
2088
- async listPlacementOptions(inboundPlanId, pageSize, paginationToken, options) {
2089
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPlacementOptions(inboundPlanId, pageSize, paginationToken, options);
2090
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2091
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listPlacementOptions']?.[localVarOperationServerIndex]?.url;
2092
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2093
- },
2094
- /**
2095
- * Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
2096
- * @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
2097
- * @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
2098
- * @param {*} [options] Override http request option.
2099
- * @throws {RequiredError}
2100
- */
2101
- async listPrepDetails(marketplaceId, mskus, options) {
2102
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPrepDetails(marketplaceId, mskus, options);
2103
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2104
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listPrepDetails']?.[localVarOperationServerIndex]?.url;
2105
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2106
- },
2107
- /**
2108
- * Provides a paginated list of box packages in a shipment.
2109
- * @param {string} inboundPlanId Identifier of an inbound plan.
2110
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
2111
- * @param {number} [pageSize] The number of boxes to return in the response matching the given query.
2112
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
2113
- * @param {*} [options] Override http request option.
2114
- * @throws {RequiredError}
2115
- */
2116
- async listShipmentBoxes(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
2117
- const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentBoxes(inboundPlanId, shipmentId, pageSize, paginationToken, options);
2118
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2119
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listShipmentBoxes']?.[localVarOperationServerIndex]?.url;
2120
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2121
- },
2122
- /**
2123
- * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
2124
- * @param {string} inboundPlanId Identifier of an inbound plan.
2125
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
2126
- * @param {number} [pageSize] The number of content update previews to return.
2127
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
2128
- * @param {*} [options] Override http request option.
2129
- * @throws {RequiredError}
2130
- */
2131
- async listShipmentContentUpdatePreviews(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
2132
- const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentContentUpdatePreviews(inboundPlanId, shipmentId, pageSize, paginationToken, options);
2133
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2134
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listShipmentContentUpdatePreviews']?.[localVarOperationServerIndex]?.url;
2135
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2136
- },
2137
- /**
2138
- * Provides a paginated list of item packages in a shipment.
2139
- * @param {string} inboundPlanId Identifier of an inbound plan.
2140
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
2141
- * @param {number} [pageSize] The number of items to return in the response matching the given query.
2142
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
2143
- * @param {*} [options] Override http request option.
2144
- * @throws {RequiredError}
2145
- */
2146
- async listShipmentItems(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
2147
- const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentItems(inboundPlanId, shipmentId, pageSize, paginationToken, options);
2148
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2149
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listShipmentItems']?.[localVarOperationServerIndex]?.url;
2150
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2151
- },
2152
- /**
2153
- * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
2154
- * @param {string} inboundPlanId Identifier of an inbound plan.
2155
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
2156
- * @param {number} [pageSize] The number of pallets to return in the response matching the given query.
2157
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
2158
- * @param {*} [options] Override http request option.
2159
- * @throws {RequiredError}
2160
- */
2161
- async listShipmentPallets(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
2162
- const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentPallets(inboundPlanId, shipmentId, pageSize, paginationToken, options);
2163
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2164
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listShipmentPallets']?.[localVarOperationServerIndex]?.url;
2165
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2166
- },
2167
- /**
2168
- * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available.
2169
- * @param {string} inboundPlanId Identifier of an inbound plan.
2170
- * @param {number} [pageSize] The number of transportation options to return in the response matching the given query.
2171
- * @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the &#x60;pagination&#x60; returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
2172
- * @param {string} [placementOptionId] The placement option to get transportation options for. Either &#x60;placementOptionId&#x60; or &#x60;shipmentId&#x60; must be specified.
2173
- * @param {string} [shipmentId] The shipment to get transportation options for. Either &#x60;placementOptionId&#x60; or &#x60;shipmentId&#x60; must be specified.
2174
- * @param {*} [options] Override http request option.
2175
- * @throws {RequiredError}
2176
- */
2177
- async listTransportationOptions(inboundPlanId, pageSize, paginationToken, placementOptionId, shipmentId, options) {
2178
- const localVarAxiosArgs = await localVarAxiosParamCreator.listTransportationOptions(inboundPlanId, pageSize, paginationToken, placementOptionId, shipmentId, options);
2179
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2180
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.listTransportationOptions']?.[localVarOperationServerIndex]?.url;
2181
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2182
- },
2183
- /**
2184
- * Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
2185
- * @param {string} inboundPlanId Identifier of an inbound plan.
2186
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
2187
- * @param {string} slotId An identifier to a self-ship appointment slot.
2188
- * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to &#x60;scheduleSelfShipAppointment&#x60;.
2189
- * @param {*} [options] Override http request option.
2190
- * @throws {RequiredError}
2191
- */
2192
- async scheduleSelfShipAppointment(inboundPlanId, shipmentId, slotId, body, options) {
2193
- const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleSelfShipAppointment(inboundPlanId, shipmentId, slotId, body, options);
2194
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2195
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.scheduleSelfShipAppointment']?.[localVarOperationServerIndex]?.url;
2196
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2197
- },
2198
- /**
2199
- * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates.
2200
- * @param {string} inboundPlanId Identifier of an inbound plan.
2201
- * @param {SetPackingInformationRequest} body The body of the request to &#x60;setPackingInformation&#x60;.
2202
- * @param {*} [options] Override http request option.
2203
- * @throws {RequiredError}
2204
- */
2205
- async setPackingInformation(inboundPlanId, body, options) {
2206
- const localVarAxiosArgs = await localVarAxiosParamCreator.setPackingInformation(inboundPlanId, body, options);
2207
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2208
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.setPackingInformation']?.[localVarOperationServerIndex]?.url;
2209
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2210
- },
2211
- /**
2212
- * Set the preparation details for a list of MSKUs in a specified marketplace.
2213
- * @param {SetPrepDetailsRequest} body The body of the request to &#x60;setPrepDetails&#x60;.
2214
- * @param {*} [options] Override http request option.
2215
- * @throws {RequiredError}
2216
- */
2217
- async setPrepDetails(body, options) {
2218
- const localVarAxiosArgs = await localVarAxiosParamCreator.setPrepDetails(body, options);
2219
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2220
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.setPrepDetails']?.[localVarOperationServerIndex]?.url;
2221
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2222
- },
2223
- /**
2224
- * Updates the name of an existing inbound plan.
2225
- * @param {string} inboundPlanId Identifier of an inbound plan.
2226
- * @param {UpdateInboundPlanNameRequest} body The body of the request to &#x60;updateInboundPlanName&#x60;.
2227
- * @param {*} [options] Override http request option.
2228
- * @throws {RequiredError}
2229
- */
2230
- async updateInboundPlanName(inboundPlanId, body, options) {
2231
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateInboundPlanName(inboundPlanId, body, options);
2232
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2233
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.updateInboundPlanName']?.[localVarOperationServerIndex]?.url;
2234
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2235
- },
2236
- /**
2237
- * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.
2238
- * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
2239
- * @param {UpdateItemComplianceDetailsRequest} body The body of the request to &#x60;updateItemComplianceDetails&#x60;.
2240
- * @param {*} [options] Override http request option.
2241
- * @throws {RequiredError}
2242
- */
2243
- async updateItemComplianceDetails(marketplaceId, body, options) {
2244
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateItemComplianceDetails(marketplaceId, body, options);
2245
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2246
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.updateItemComplianceDetails']?.[localVarOperationServerIndex]?.url;
2247
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2248
- },
2249
- /**
2250
- * Updates the name of an existing shipment.
2251
- * @param {string} inboundPlanId Identifier of an inbound plan.
2252
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
2253
- * @param {UpdateShipmentNameRequest} body The body of the request to &#x60;updateShipmentName&#x60;.
2254
- * @param {*} [options] Override http request option.
2255
- * @throws {RequiredError}
2256
- */
2257
- async updateShipmentName(inboundPlanId, shipmentId, body, options) {
2258
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentName(inboundPlanId, shipmentId, body, options);
2259
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2260
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.updateShipmentName']?.[localVarOperationServerIndex]?.url;
2261
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2262
- },
2263
- /**
2264
- * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.
2265
- * @param {string} inboundPlanId Identifier of an inbound plan.
2266
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
2267
- * @param {UpdateShipmentSourceAddressRequest} body The body of the request to &#x60;updateShipmentSourceAddress&#x60;.
2268
- * @param {*} [options] Override http request option.
2269
- * @throws {RequiredError}
2270
- */
2271
- async updateShipmentSourceAddress(inboundPlanId, shipmentId, body, options) {
2272
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentSourceAddress(inboundPlanId, shipmentId, body, options);
2273
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2274
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.updateShipmentSourceAddress']?.[localVarOperationServerIndex]?.url;
2275
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2276
- },
2277
- /**
2278
- * Updates a shipment\'s tracking details.
2279
- * @param {string} inboundPlanId Identifier of an inbound plan.
2280
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
2281
- * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to &#x60;updateShipmentTrackingDetails&#x60;.
2282
- * @param {*} [options] Override http request option.
2283
- * @throws {RequiredError}
2284
- */
2285
- async updateShipmentTrackingDetails(inboundPlanId, shipmentId, body, options) {
2286
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentTrackingDetails(inboundPlanId, shipmentId, body, options);
2287
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2288
- const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.updateShipmentTrackingDetails']?.[localVarOperationServerIndex]?.url;
2289
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2290
- },
2291
- };
2292
- };
2293
- exports.FulfillmentInboundApiFp = FulfillmentInboundApiFp;
2294
- /**
2295
- * FulfillmentInboundApi - factory interface
2296
- */
2297
- const FulfillmentInboundApiFactory = function (configuration, basePath, axios) {
2298
- const localVarFp = (0, exports.FulfillmentInboundApiFp)(configuration);
2299
- return {
2300
- /**
2301
- * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments.
2302
- * @param {FulfillmentInboundApiCancelInboundPlanRequest} requestParameters Request parameters.
2303
- * @param {*} [options] Override http request option.
2304
- * @throws {RequiredError}
2305
- */
2306
- cancelInboundPlan(requestParameters, options) {
2307
- return localVarFp.cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
2308
- },
2309
- /**
2310
- * Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
2311
- * @param {FulfillmentInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
2312
- * @param {*} [options] Override http request option.
2313
- * @throws {RequiredError}
2314
- */
2315
- cancelSelfShipAppointment(requestParameters, options) {
2316
- return localVarFp.cancelSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
2317
- },
2318
- /**
2319
- * 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.
2320
- * @param {FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest} requestParameters Request parameters.
2321
- * @param {*} [options] Override http request option.
2322
- * @throws {RequiredError}
2323
- */
2324
- confirmDeliveryWindowOptions(requestParameters, options) {
2325
- return localVarFp.confirmDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.deliveryWindowOptionId, options).then((request) => request(axios, basePath));
2326
- },
2327
- /**
2328
- * Confirms the packing option for an inbound plan.
2329
- * @param {FulfillmentInboundApiConfirmPackingOptionRequest} requestParameters Request parameters.
2330
- * @param {*} [options] Override http request option.
2331
- * @throws {RequiredError}
2332
- */
2333
- confirmPackingOption(requestParameters, options) {
2334
- return localVarFp.confirmPackingOption(requestParameters.inboundPlanId, requestParameters.packingOptionId, options).then((request) => request(axios, basePath));
2335
- },
2336
- /**
2337
- * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
2338
- * @param {FulfillmentInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters.
2339
- * @param {*} [options] Override http request option.
2340
- * @throws {RequiredError}
2341
- */
2342
- confirmPlacementOption(requestParameters, options) {
2343
- return localVarFp.confirmPlacementOption(requestParameters.inboundPlanId, requestParameters.placementOptionId, options).then((request) => request(axios, basePath));
2344
- },
2345
- /**
2346
- * Confirm a shipment content update preview and accept the changes in transportation cost.
2347
- * @param {FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
2348
- * @param {*} [options] Override http request option.
2349
- * @throws {RequiredError}
2350
- */
2351
- confirmShipmentContentUpdatePreview(requestParameters, options) {
2352
- return localVarFp.confirmShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(axios, basePath));
2353
- },
2354
- /**
2355
- * 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.
2356
- * @param {FulfillmentInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters.
2357
- * @param {*} [options] Override http request option.
2358
- * @throws {RequiredError}
2359
- */
2360
- confirmTransportationOptions(requestParameters, options) {
2361
- return localVarFp.confirmTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
2362
- },
2363
- /**
2364
- * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network.
2365
- * @param {FulfillmentInboundApiCreateInboundPlanRequest} requestParameters Request parameters.
2366
- * @param {*} [options] Override http request option.
2367
- * @throws {RequiredError}
2368
- */
2369
- createInboundPlan(requestParameters, options) {
2370
- return localVarFp.createInboundPlan(requestParameters.body, options).then((request) => request(axios, basePath));
2371
- },
2372
- /**
2373
- * For a given marketplace - creates labels for a list of MSKUs.
2374
- * @param {FulfillmentInboundApiCreateMarketplaceItemLabelsRequest} requestParameters Request parameters.
2375
- * @param {*} [options] Override http request option.
2376
- * @throws {RequiredError}
2377
- */
2378
- createMarketplaceItemLabels(requestParameters, options) {
2379
- return localVarFp.createMarketplaceItemLabels(requestParameters.body, options).then((request) => request(axios, basePath));
2380
- },
2381
- /**
2382
- * Generates available delivery window options for a given shipment.
2383
- * @param {FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest} requestParameters Request parameters.
2384
- * @param {*} [options] Override http request option.
2385
- * @throws {RequiredError}
2386
- */
2387
- generateDeliveryWindowOptions(requestParameters, options) {
2388
- return localVarFp.generateDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
2389
- },
2390
- /**
2391
- * Generates available packing options for the inbound plan.
2392
- * @param {FulfillmentInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters.
2393
- * @param {*} [options] Override http request option.
2394
- * @throws {RequiredError}
2395
- */
2396
- generatePackingOptions(requestParameters, options) {
2397
- return localVarFp.generatePackingOptions(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
2398
- },
2399
- /**
2400
- * Generates placement options for the inbound plan.
2401
- * @param {FulfillmentInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters.
2402
- * @param {*} [options] Override http request option.
2403
- * @throws {RequiredError}
2404
- */
2405
- generatePlacementOptions(requestParameters, options) {
2406
- return localVarFp.generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
2407
- },
2408
- /**
2409
- * Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
2410
- * @param {FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
2411
- * @param {*} [options] Override http request option.
2412
- * @throws {RequiredError}
2413
- */
2414
- generateSelfShipAppointmentSlots(requestParameters, options) {
2415
- return localVarFp.generateSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
2416
- },
2417
- /**
2418
- * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.
2419
- * @param {FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
2420
- * @param {*} [options] Override http request option.
2421
- * @throws {RequiredError}
2422
- */
2423
- generateShipmentContentUpdatePreviews(requestParameters, options) {
2424
- return localVarFp.generateShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
2425
- },
2426
- /**
2427
- * Generates available transportation options for a given placement option.
2428
- * @param {FulfillmentInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters.
2429
- * @param {*} [options] Override http request option.
2430
- * @throws {RequiredError}
2431
- */
2432
- generateTransportationOptions(requestParameters, options) {
2433
- return localVarFp.generateTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
2434
- },
2435
- /**
2436
- * Provide delivery challan document for PCP transportation in IN marketplace.
2437
- * @param {FulfillmentInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters.
2438
- * @param {*} [options] Override http request option.
2439
- * @throws {RequiredError}
2440
- */
2441
- getDeliveryChallanDocument(requestParameters, options) {
2442
- return localVarFp.getDeliveryChallanDocument(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
2443
- },
2444
- /**
2445
- * Gets the status of the processing of an asynchronous API call.
2446
- * @param {FulfillmentInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters.
2447
- * @param {*} [options] Override http request option.
2448
- * @throws {RequiredError}
2449
- */
2450
- getInboundOperationStatus(requestParameters, options) {
2451
- return localVarFp.getInboundOperationStatus(requestParameters.operationId, options).then((request) => request(axios, basePath));
2452
- },
2453
- /**
2454
- * Fetches the top level information about an inbound plan.
2455
- * @param {FulfillmentInboundApiGetInboundPlanRequest} requestParameters Request parameters.
2456
- * @param {*} [options] Override http request option.
2457
- * @throws {RequiredError}
2458
- */
2459
- getInboundPlan(requestParameters, options) {
2460
- return localVarFp.getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
2461
- },
2462
- /**
2463
- * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
2464
- * @param {FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
2465
- * @param {*} [options] Override http request option.
2466
- * @throws {RequiredError}
2467
- */
2468
- getSelfShipAppointmentSlots(requestParameters, options) {
2469
- return localVarFp.getSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2470
- },
2471
- /**
2472
- * 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.
2473
- * @param {FulfillmentInboundApiGetShipmentRequest} requestParameters Request parameters.
2474
- * @param {*} [options] Override http request option.
2475
- * @throws {RequiredError}
2476
- */
2477
- getShipment(requestParameters, options) {
2478
- return localVarFp.getShipment(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
2479
- },
2480
- /**
2481
- * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
2482
- * @param {FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
2483
- * @param {*} [options] Override http request option.
2484
- * @throws {RequiredError}
2485
- */
2486
- getShipmentContentUpdatePreview(requestParameters, options) {
2487
- return localVarFp.getShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(axios, basePath));
2488
- },
2489
- /**
2490
- * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available.
2491
- * @param {FulfillmentInboundApiListDeliveryWindowOptionsRequest} requestParameters Request parameters.
2492
- * @param {*} [options] Override http request option.
2493
- * @throws {RequiredError}
2494
- */
2495
- listDeliveryWindowOptions(requestParameters, options) {
2496
- return localVarFp.listDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2497
- },
2498
- /**
2499
- * Provides a paginated list of box packages in an inbound plan.
2500
- * @param {FulfillmentInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters.
2501
- * @param {*} [options] Override http request option.
2502
- * @throws {RequiredError}
2503
- */
2504
- listInboundPlanBoxes(requestParameters, options) {
2505
- return localVarFp.listInboundPlanBoxes(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2506
- },
2507
- /**
2508
- * Provides a paginated list of item packages in an inbound plan.
2509
- * @param {FulfillmentInboundApiListInboundPlanItemsRequest} requestParameters Request parameters.
2510
- * @param {*} [options] Override http request option.
2511
- * @throws {RequiredError}
2512
- */
2513
- listInboundPlanItems(requestParameters, options) {
2514
- return localVarFp.listInboundPlanItems(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2515
- },
2516
- /**
2517
- * 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.
2518
- * @param {FulfillmentInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters.
2519
- * @param {*} [options] Override http request option.
2520
- * @throws {RequiredError}
2521
- */
2522
- listInboundPlanPallets(requestParameters, options) {
2523
- return localVarFp.listInboundPlanPallets(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2524
- },
2525
- /**
2526
- * Provides a list of inbound plans with minimal information.
2527
- * @param {FulfillmentInboundApiListInboundPlansRequest} requestParameters Request parameters.
2528
- * @param {*} [options] Override http request option.
2529
- * @throws {RequiredError}
2530
- */
2531
- listInboundPlans(requestParameters = {}, options) {
2532
- return localVarFp.listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(axios, basePath));
2533
- },
2534
- /**
2535
- * List the inbound compliance details for MSKUs in a given marketplace. **Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). The following characters must be double percent encoded: - `%` - `+` - `,` **Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
2536
- * @param {FulfillmentInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
2537
- * @param {*} [options] Override http request option.
2538
- * @throws {RequiredError}
2539
- */
2540
- listItemComplianceDetails(requestParameters, options) {
2541
- return localVarFp.listItemComplianceDetails(requestParameters.mskus, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
2542
- },
2543
- /**
2544
- * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.
2545
- * @param {FulfillmentInboundApiListPackingGroupBoxesRequest} requestParameters Request parameters.
2546
- * @param {*} [options] Override http request option.
2547
- * @throws {RequiredError}
2548
- */
2549
- listPackingGroupBoxes(requestParameters, options) {
2550
- return localVarFp.listPackingGroupBoxes(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2551
- },
2552
- /**
2553
- * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.
2554
- * @param {FulfillmentInboundApiListPackingGroupItemsRequest} requestParameters Request parameters.
2555
- * @param {*} [options] Override http request option.
2556
- * @throws {RequiredError}
2557
- */
2558
- listPackingGroupItems(requestParameters, options) {
2559
- return localVarFp.listPackingGroupItems(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2560
- },
2561
- /**
2562
- * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.
2563
- * @param {FulfillmentInboundApiListPackingOptionsRequest} requestParameters Request parameters.
2564
- * @param {*} [options] Override http request option.
2565
- * @throws {RequiredError}
2566
- */
2567
- listPackingOptions(requestParameters, options) {
2568
- return localVarFp.listPackingOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2569
- },
2570
- /**
2571
- * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.
2572
- * @param {FulfillmentInboundApiListPlacementOptionsRequest} requestParameters Request parameters.
2573
- * @param {*} [options] Override http request option.
2574
- * @throws {RequiredError}
2575
- */
2576
- listPlacementOptions(requestParameters, options) {
2577
- return localVarFp.listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2578
- },
2579
- /**
2580
- * Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
2581
- * @param {FulfillmentInboundApiListPrepDetailsRequest} requestParameters Request parameters.
2582
- * @param {*} [options] Override http request option.
2583
- * @throws {RequiredError}
2584
- */
2585
- listPrepDetails(requestParameters, options) {
2586
- return localVarFp.listPrepDetails(requestParameters.marketplaceId, requestParameters.mskus, options).then((request) => request(axios, basePath));
2587
- },
2588
- /**
2589
- * Provides a paginated list of box packages in a shipment.
2590
- * @param {FulfillmentInboundApiListShipmentBoxesRequest} requestParameters Request parameters.
2591
- * @param {*} [options] Override http request option.
2592
- * @throws {RequiredError}
2593
- */
2594
- listShipmentBoxes(requestParameters, options) {
2595
- return localVarFp.listShipmentBoxes(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2596
- },
2597
- /**
2598
- * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
2599
- * @param {FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
2600
- * @param {*} [options] Override http request option.
2601
- * @throws {RequiredError}
2602
- */
2603
- listShipmentContentUpdatePreviews(requestParameters, options) {
2604
- return localVarFp.listShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2605
- },
2606
- /**
2607
- * Provides a paginated list of item packages in a shipment.
2608
- * @param {FulfillmentInboundApiListShipmentItemsRequest} requestParameters Request parameters.
2609
- * @param {*} [options] Override http request option.
2610
- * @throws {RequiredError}
2611
- */
2612
- listShipmentItems(requestParameters, options) {
2613
- return localVarFp.listShipmentItems(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2614
- },
2615
- /**
2616
- * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
2617
- * @param {FulfillmentInboundApiListShipmentPalletsRequest} requestParameters Request parameters.
2618
- * @param {*} [options] Override http request option.
2619
- * @throws {RequiredError}
2620
- */
2621
- listShipmentPallets(requestParameters, options) {
2622
- return localVarFp.listShipmentPallets(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
2623
- },
2624
- /**
2625
- * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available.
2626
- * @param {FulfillmentInboundApiListTransportationOptionsRequest} requestParameters Request parameters.
2627
- * @param {*} [options] Override http request option.
2628
- * @throws {RequiredError}
2629
- */
2630
- listTransportationOptions(requestParameters, options) {
2631
- return localVarFp.listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
2632
- },
2633
- /**
2634
- * Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
2635
- * @param {FulfillmentInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
2636
- * @param {*} [options] Override http request option.
2637
- * @throws {RequiredError}
2638
- */
2639
- scheduleSelfShipAppointment(requestParameters, options) {
2640
- return localVarFp.scheduleSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.slotId, requestParameters.body, options).then((request) => request(axios, basePath));
2641
- },
2642
- /**
2643
- * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates.
2644
- * @param {FulfillmentInboundApiSetPackingInformationRequest} requestParameters Request parameters.
2645
- * @param {*} [options] Override http request option.
2646
- * @throws {RequiredError}
2647
- */
2648
- setPackingInformation(requestParameters, options) {
2649
- return localVarFp.setPackingInformation(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
2650
- },
2651
- /**
2652
- * Set the preparation details for a list of MSKUs in a specified marketplace.
2653
- * @param {FulfillmentInboundApiSetPrepDetailsRequest} requestParameters Request parameters.
2654
- * @param {*} [options] Override http request option.
2655
- * @throws {RequiredError}
2656
- */
2657
- setPrepDetails(requestParameters, options) {
2658
- return localVarFp.setPrepDetails(requestParameters.body, options).then((request) => request(axios, basePath));
2659
- },
2660
- /**
2661
- * Updates the name of an existing inbound plan.
2662
- * @param {FulfillmentInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters.
2663
- * @param {*} [options] Override http request option.
2664
- * @throws {RequiredError}
2665
- */
2666
- updateInboundPlanName(requestParameters, options) {
2667
- return localVarFp.updateInboundPlanName(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
2668
- },
2669
- /**
2670
- * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.
2671
- * @param {FulfillmentInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters.
2672
- * @param {*} [options] Override http request option.
2673
- * @throws {RequiredError}
2674
- */
2675
- updateItemComplianceDetails(requestParameters, options) {
2676
- return localVarFp.updateItemComplianceDetails(requestParameters.marketplaceId, requestParameters.body, options).then((request) => request(axios, basePath));
2677
- },
2678
- /**
2679
- * Updates the name of an existing shipment.
2680
- * @param {FulfillmentInboundApiUpdateShipmentNameRequest} requestParameters Request parameters.
2681
- * @param {*} [options] Override http request option.
2682
- * @throws {RequiredError}
2683
- */
2684
- updateShipmentName(requestParameters, options) {
2685
- return localVarFp.updateShipmentName(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
2686
- },
2687
- /**
2688
- * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.
2689
- * @param {FulfillmentInboundApiUpdateShipmentSourceAddressRequest} requestParameters Request parameters.
2690
- * @param {*} [options] Override http request option.
2691
- * @throws {RequiredError}
2692
- */
2693
- updateShipmentSourceAddress(requestParameters, options) {
2694
- return localVarFp.updateShipmentSourceAddress(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
2695
- },
2696
- /**
2697
- * Updates a shipment\'s tracking details.
2698
- * @param {FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters.
2699
- * @param {*} [options] Override http request option.
2700
- * @throws {RequiredError}
2701
- */
2702
- updateShipmentTrackingDetails(requestParameters, options) {
2703
- return localVarFp.updateShipmentTrackingDetails(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
2704
- },
2705
- };
2706
- };
2707
- exports.FulfillmentInboundApiFactory = FulfillmentInboundApiFactory;
2708
- /**
2709
- * FulfillmentInboundApi - object-oriented interface
2710
- */
2711
- class FulfillmentInboundApi extends base_1.BaseAPI {
2712
- /**
2713
- * Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments.
2714
- * @param {FulfillmentInboundApiCancelInboundPlanRequest} requestParameters Request parameters.
2715
- * @param {*} [options] Override http request option.
2716
- * @throws {RequiredError}
2717
- */
2718
- cancelInboundPlan(requestParameters, options) {
2719
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
2720
- }
2721
- /**
2722
- * Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
2723
- * @param {FulfillmentInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
2724
- * @param {*} [options] Override http request option.
2725
- * @throws {RequiredError}
2726
- */
2727
- cancelSelfShipAppointment(requestParameters, options) {
2728
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).cancelSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
2729
- }
2730
- /**
2731
- * 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.
2732
- * @param {FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest} requestParameters Request parameters.
2733
- * @param {*} [options] Override http request option.
2734
- * @throws {RequiredError}
2735
- */
2736
- confirmDeliveryWindowOptions(requestParameters, options) {
2737
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).confirmDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.deliveryWindowOptionId, options).then((request) => request(this.axios, this.basePath));
2738
- }
2739
- /**
2740
- * Confirms the packing option for an inbound plan.
2741
- * @param {FulfillmentInboundApiConfirmPackingOptionRequest} requestParameters Request parameters.
2742
- * @param {*} [options] Override http request option.
2743
- * @throws {RequiredError}
2744
- */
2745
- confirmPackingOption(requestParameters, options) {
2746
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).confirmPackingOption(requestParameters.inboundPlanId, requestParameters.packingOptionId, options).then((request) => request(this.axios, this.basePath));
2747
- }
2748
- /**
2749
- * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
2750
- * @param {FulfillmentInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters.
2751
- * @param {*} [options] Override http request option.
2752
- * @throws {RequiredError}
2753
- */
2754
- confirmPlacementOption(requestParameters, options) {
2755
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).confirmPlacementOption(requestParameters.inboundPlanId, requestParameters.placementOptionId, options).then((request) => request(this.axios, this.basePath));
2756
- }
2757
- /**
2758
- * Confirm a shipment content update preview and accept the changes in transportation cost.
2759
- * @param {FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
2760
- * @param {*} [options] Override http request option.
2761
- * @throws {RequiredError}
2762
- */
2763
- confirmShipmentContentUpdatePreview(requestParameters, options) {
2764
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).confirmShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(this.axios, this.basePath));
2765
- }
2766
- /**
2767
- * 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.
2768
- * @param {FulfillmentInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters.
2769
- * @param {*} [options] Override http request option.
2770
- * @throws {RequiredError}
2771
- */
2772
- confirmTransportationOptions(requestParameters, options) {
2773
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).confirmTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
2774
- }
2775
- /**
2776
- * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network.
2777
- * @param {FulfillmentInboundApiCreateInboundPlanRequest} requestParameters Request parameters.
2778
- * @param {*} [options] Override http request option.
2779
- * @throws {RequiredError}
2780
- */
2781
- createInboundPlan(requestParameters, options) {
2782
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).createInboundPlan(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
2783
- }
2784
- /**
2785
- * For a given marketplace - creates labels for a list of MSKUs.
2786
- * @param {FulfillmentInboundApiCreateMarketplaceItemLabelsRequest} requestParameters Request parameters.
2787
- * @param {*} [options] Override http request option.
2788
- * @throws {RequiredError}
2789
- */
2790
- createMarketplaceItemLabels(requestParameters, options) {
2791
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).createMarketplaceItemLabels(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
2792
- }
2793
- /**
2794
- * Generates available delivery window options for a given shipment.
2795
- * @param {FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest} requestParameters Request parameters.
2796
- * @param {*} [options] Override http request option.
2797
- * @throws {RequiredError}
2798
- */
2799
- generateDeliveryWindowOptions(requestParameters, options) {
2800
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).generateDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
2801
- }
2802
- /**
2803
- * Generates available packing options for the inbound plan.
2804
- * @param {FulfillmentInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters.
2805
- * @param {*} [options] Override http request option.
2806
- * @throws {RequiredError}
2807
- */
2808
- generatePackingOptions(requestParameters, options) {
2809
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).generatePackingOptions(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
2810
- }
2811
- /**
2812
- * Generates placement options for the inbound plan.
2813
- * @param {FulfillmentInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters.
2814
- * @param {*} [options] Override http request option.
2815
- * @throws {RequiredError}
2816
- */
2817
- generatePlacementOptions(requestParameters, options) {
2818
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
2819
- }
2820
- /**
2821
- * Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
2822
- * @param {FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
2823
- * @param {*} [options] Override http request option.
2824
- * @throws {RequiredError}
2825
- */
2826
- generateSelfShipAppointmentSlots(requestParameters, options) {
2827
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).generateSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
2828
- }
2829
- /**
2830
- * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.
2831
- * @param {FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
2832
- * @param {*} [options] Override http request option.
2833
- * @throws {RequiredError}
2834
- */
2835
- generateShipmentContentUpdatePreviews(requestParameters, options) {
2836
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).generateShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
2837
- }
2838
- /**
2839
- * Generates available transportation options for a given placement option.
2840
- * @param {FulfillmentInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters.
2841
- * @param {*} [options] Override http request option.
2842
- * @throws {RequiredError}
2843
- */
2844
- generateTransportationOptions(requestParameters, options) {
2845
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).generateTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
2846
- }
2847
- /**
2848
- * Provide delivery challan document for PCP transportation in IN marketplace.
2849
- * @param {FulfillmentInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters.
2850
- * @param {*} [options] Override http request option.
2851
- * @throws {RequiredError}
2852
- */
2853
- getDeliveryChallanDocument(requestParameters, options) {
2854
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).getDeliveryChallanDocument(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
2855
- }
2856
- /**
2857
- * Gets the status of the processing of an asynchronous API call.
2858
- * @param {FulfillmentInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters.
2859
- * @param {*} [options] Override http request option.
2860
- * @throws {RequiredError}
2861
- */
2862
- getInboundOperationStatus(requestParameters, options) {
2863
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).getInboundOperationStatus(requestParameters.operationId, options).then((request) => request(this.axios, this.basePath));
2864
- }
2865
- /**
2866
- * Fetches the top level information about an inbound plan.
2867
- * @param {FulfillmentInboundApiGetInboundPlanRequest} requestParameters Request parameters.
2868
- * @param {*} [options] Override http request option.
2869
- * @throws {RequiredError}
2870
- */
2871
- getInboundPlan(requestParameters, options) {
2872
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
2873
- }
2874
- /**
2875
- * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
2876
- * @param {FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
2877
- * @param {*} [options] Override http request option.
2878
- * @throws {RequiredError}
2879
- */
2880
- getSelfShipAppointmentSlots(requestParameters, options) {
2881
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).getSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
2882
- }
2883
- /**
2884
- * 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.
2885
- * @param {FulfillmentInboundApiGetShipmentRequest} requestParameters Request parameters.
2886
- * @param {*} [options] Override http request option.
2887
- * @throws {RequiredError}
2888
- */
2889
- getShipment(requestParameters, options) {
2890
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).getShipment(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
2891
- }
2892
- /**
2893
- * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
2894
- * @param {FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
2895
- * @param {*} [options] Override http request option.
2896
- * @throws {RequiredError}
2897
- */
2898
- getShipmentContentUpdatePreview(requestParameters, options) {
2899
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).getShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(this.axios, this.basePath));
2900
- }
2901
- /**
2902
- * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available.
2903
- * @param {FulfillmentInboundApiListDeliveryWindowOptionsRequest} requestParameters Request parameters.
2904
- * @param {*} [options] Override http request option.
2905
- * @throws {RequiredError}
2906
- */
2907
- listDeliveryWindowOptions(requestParameters, options) {
2908
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
2909
- }
2910
- /**
2911
- * Provides a paginated list of box packages in an inbound plan.
2912
- * @param {FulfillmentInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters.
2913
- * @param {*} [options] Override http request option.
2914
- * @throws {RequiredError}
2915
- */
2916
- listInboundPlanBoxes(requestParameters, options) {
2917
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listInboundPlanBoxes(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
2918
- }
2919
- /**
2920
- * Provides a paginated list of item packages in an inbound plan.
2921
- * @param {FulfillmentInboundApiListInboundPlanItemsRequest} requestParameters Request parameters.
2922
- * @param {*} [options] Override http request option.
2923
- * @throws {RequiredError}
2924
- */
2925
- listInboundPlanItems(requestParameters, options) {
2926
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listInboundPlanItems(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
2927
- }
2928
- /**
2929
- * 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.
2930
- * @param {FulfillmentInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters.
2931
- * @param {*} [options] Override http request option.
2932
- * @throws {RequiredError}
2933
- */
2934
- listInboundPlanPallets(requestParameters, options) {
2935
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listInboundPlanPallets(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
2936
- }
2937
- /**
2938
- * Provides a list of inbound plans with minimal information.
2939
- * @param {FulfillmentInboundApiListInboundPlansRequest} requestParameters Request parameters.
2940
- * @param {*} [options] Override http request option.
2941
- * @throws {RequiredError}
2942
- */
2943
- listInboundPlans(requestParameters = {}, options) {
2944
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(this.axios, this.basePath));
2945
- }
2946
- /**
2947
- * List the inbound compliance details for MSKUs in a given marketplace. **Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). The following characters must be double percent encoded: - `%` - `+` - `,` **Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
2948
- * @param {FulfillmentInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
2949
- * @param {*} [options] Override http request option.
2950
- * @throws {RequiredError}
2951
- */
2952
- listItemComplianceDetails(requestParameters, options) {
2953
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listItemComplianceDetails(requestParameters.mskus, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath));
2954
- }
2955
- /**
2956
- * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.
2957
- * @param {FulfillmentInboundApiListPackingGroupBoxesRequest} requestParameters Request parameters.
2958
- * @param {*} [options] Override http request option.
2959
- * @throws {RequiredError}
2960
- */
2961
- listPackingGroupBoxes(requestParameters, options) {
2962
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listPackingGroupBoxes(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
2963
- }
2964
- /**
2965
- * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.
2966
- * @param {FulfillmentInboundApiListPackingGroupItemsRequest} requestParameters Request parameters.
2967
- * @param {*} [options] Override http request option.
2968
- * @throws {RequiredError}
2969
- */
2970
- listPackingGroupItems(requestParameters, options) {
2971
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listPackingGroupItems(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
2972
- }
2973
- /**
2974
- * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.
2975
- * @param {FulfillmentInboundApiListPackingOptionsRequest} requestParameters Request parameters.
2976
- * @param {*} [options] Override http request option.
2977
- * @throws {RequiredError}
2978
- */
2979
- listPackingOptions(requestParameters, options) {
2980
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listPackingOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
2981
- }
2982
- /**
2983
- * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.
2984
- * @param {FulfillmentInboundApiListPlacementOptionsRequest} requestParameters Request parameters.
2985
- * @param {*} [options] Override http request option.
2986
- * @throws {RequiredError}
2987
- */
2988
- listPlacementOptions(requestParameters, options) {
2989
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
2990
- }
2991
- /**
2992
- * Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
2993
- * @param {FulfillmentInboundApiListPrepDetailsRequest} requestParameters Request parameters.
2994
- * @param {*} [options] Override http request option.
2995
- * @throws {RequiredError}
2996
- */
2997
- listPrepDetails(requestParameters, options) {
2998
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listPrepDetails(requestParameters.marketplaceId, requestParameters.mskus, options).then((request) => request(this.axios, this.basePath));
2999
- }
3000
- /**
3001
- * Provides a paginated list of box packages in a shipment.
3002
- * @param {FulfillmentInboundApiListShipmentBoxesRequest} requestParameters Request parameters.
3003
- * @param {*} [options] Override http request option.
3004
- * @throws {RequiredError}
3005
- */
3006
- listShipmentBoxes(requestParameters, options) {
3007
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listShipmentBoxes(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
3008
- }
3009
- /**
3010
- * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
3011
- * @param {FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
3012
- * @param {*} [options] Override http request option.
3013
- * @throws {RequiredError}
3014
- */
3015
- listShipmentContentUpdatePreviews(requestParameters, options) {
3016
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
3017
- }
3018
- /**
3019
- * Provides a paginated list of item packages in a shipment.
3020
- * @param {FulfillmentInboundApiListShipmentItemsRequest} requestParameters Request parameters.
3021
- * @param {*} [options] Override http request option.
3022
- * @throws {RequiredError}
3023
- */
3024
- listShipmentItems(requestParameters, options) {
3025
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listShipmentItems(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
3026
- }
3027
- /**
3028
- * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
3029
- * @param {FulfillmentInboundApiListShipmentPalletsRequest} requestParameters Request parameters.
3030
- * @param {*} [options] Override http request option.
3031
- * @throws {RequiredError}
3032
- */
3033
- listShipmentPallets(requestParameters, options) {
3034
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listShipmentPallets(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
3035
- }
3036
- /**
3037
- * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available.
3038
- * @param {FulfillmentInboundApiListTransportationOptionsRequest} requestParameters Request parameters.
3039
- * @param {*} [options] Override http request option.
3040
- * @throws {RequiredError}
3041
- */
3042
- listTransportationOptions(requestParameters, options) {
3043
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
3044
- }
3045
- /**
3046
- * Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
3047
- * @param {FulfillmentInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
3048
- * @param {*} [options] Override http request option.
3049
- * @throws {RequiredError}
3050
- */
3051
- scheduleSelfShipAppointment(requestParameters, options) {
3052
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).scheduleSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.slotId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
3053
- }
3054
- /**
3055
- * Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates.
3056
- * @param {FulfillmentInboundApiSetPackingInformationRequest} requestParameters Request parameters.
3057
- * @param {*} [options] Override http request option.
3058
- * @throws {RequiredError}
3059
- */
3060
- setPackingInformation(requestParameters, options) {
3061
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).setPackingInformation(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
3062
- }
3063
- /**
3064
- * Set the preparation details for a list of MSKUs in a specified marketplace.
3065
- * @param {FulfillmentInboundApiSetPrepDetailsRequest} requestParameters Request parameters.
3066
- * @param {*} [options] Override http request option.
3067
- * @throws {RequiredError}
3068
- */
3069
- setPrepDetails(requestParameters, options) {
3070
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).setPrepDetails(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
3071
- }
3072
- /**
3073
- * Updates the name of an existing inbound plan.
3074
- * @param {FulfillmentInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters.
3075
- * @param {*} [options] Override http request option.
3076
- * @throws {RequiredError}
3077
- */
3078
- updateInboundPlanName(requestParameters, options) {
3079
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).updateInboundPlanName(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
3080
- }
3081
- /**
3082
- * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.
3083
- * @param {FulfillmentInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters.
3084
- * @param {*} [options] Override http request option.
3085
- * @throws {RequiredError}
3086
- */
3087
- updateItemComplianceDetails(requestParameters, options) {
3088
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).updateItemComplianceDetails(requestParameters.marketplaceId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
3089
- }
3090
- /**
3091
- * Updates the name of an existing shipment.
3092
- * @param {FulfillmentInboundApiUpdateShipmentNameRequest} requestParameters Request parameters.
3093
- * @param {*} [options] Override http request option.
3094
- * @throws {RequiredError}
3095
- */
3096
- updateShipmentName(requestParameters, options) {
3097
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).updateShipmentName(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
3098
- }
3099
- /**
3100
- * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.
3101
- * @param {FulfillmentInboundApiUpdateShipmentSourceAddressRequest} requestParameters Request parameters.
3102
- * @param {*} [options] Override http request option.
3103
- * @throws {RequiredError}
3104
- */
3105
- updateShipmentSourceAddress(requestParameters, options) {
3106
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).updateShipmentSourceAddress(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
3107
- }
3108
- /**
3109
- * Updates a shipment\'s tracking details.
3110
- * @param {FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters.
3111
- * @param {*} [options] Override http request option.
3112
- * @throws {RequiredError}
3113
- */
3114
- updateShipmentTrackingDetails(requestParameters, options) {
3115
- return (0, exports.FulfillmentInboundApiFp)(this.configuration).updateShipmentTrackingDetails(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
3116
- }
3117
- }
3118
- exports.FulfillmentInboundApi = FulfillmentInboundApi;
3119
- exports.ListInboundPlansStatusEnum = {
3120
- Active: 'ACTIVE',
3121
- Voided: 'VOIDED',
3122
- Shipped: 'SHIPPED'
3123
- };
3124
- exports.ListInboundPlansSortByEnum = {
3125
- LastUpdatedTime: 'LAST_UPDATED_TIME',
3126
- CreationTime: 'CREATION_TIME'
3127
- };
3128
- exports.ListInboundPlansSortOrderEnum = {
3129
- Asc: 'ASC',
3130
- Desc: 'DESC'
3131
- };