@sp-api-sdk/fulfillment-inbound-api-2024-03-20 1.0.1

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 (339) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +97 -0
  3. package/dist/cjs/index.js +18 -0
  4. package/dist/cjs/src/api-model/api/fba-inbound-api.js +1968 -0
  5. package/dist/cjs/src/api-model/api.js +30 -0
  6. package/dist/cjs/src/api-model/base.js +66 -0
  7. package/dist/cjs/src/api-model/common.js +145 -0
  8. package/dist/cjs/src/api-model/configuration.js +91 -0
  9. package/dist/cjs/src/api-model/index.js +32 -0
  10. package/dist/cjs/src/api-model/models/address.js +15 -0
  11. package/dist/cjs/src/api-model/models/appointment-slot-time.js +15 -0
  12. package/dist/cjs/src/api-model/models/appointment-slot.js +15 -0
  13. package/dist/cjs/src/api-model/models/box-content-information-source.js +26 -0
  14. package/dist/cjs/src/api-model/models/box-content.js +15 -0
  15. package/dist/cjs/src/api-model/models/box-input.js +15 -0
  16. package/dist/cjs/src/api-model/models/box.js +15 -0
  17. package/dist/cjs/src/api-model/models/cancel-inbound-plan-response.js +15 -0
  18. package/dist/cjs/src/api-model/models/cancel-self-ship-appointment-request.js +15 -0
  19. package/dist/cjs/src/api-model/models/cancel-self-ship-appointment-response.js +15 -0
  20. package/dist/cjs/src/api-model/models/carrier.js +15 -0
  21. package/dist/cjs/src/api-model/models/compliance-detail.js +15 -0
  22. package/dist/cjs/src/api-model/models/confirm-packing-option-response.js +15 -0
  23. package/dist/cjs/src/api-model/models/confirm-placement-option-response.js +15 -0
  24. package/dist/cjs/src/api-model/models/confirm-transportation-options-request.js +15 -0
  25. package/dist/cjs/src/api-model/models/confirm-transportation-options-response.js +15 -0
  26. package/dist/cjs/src/api-model/models/contact-information.js +15 -0
  27. package/dist/cjs/src/api-model/models/create-inbound-plan-request.js +15 -0
  28. package/dist/cjs/src/api-model/models/create-inbound-plan-response.js +15 -0
  29. package/dist/cjs/src/api-model/models/currency.js +15 -0
  30. package/dist/cjs/src/api-model/models/custom-placement-input.js +15 -0
  31. package/dist/cjs/src/api-model/models/dates.js +15 -0
  32. package/dist/cjs/src/api-model/models/dimensions.js +15 -0
  33. package/dist/cjs/src/api-model/models/document-download.js +15 -0
  34. package/dist/cjs/src/api-model/models/error-list.js +15 -0
  35. package/dist/cjs/src/api-model/models/generate-packing-options-response.js +15 -0
  36. package/dist/cjs/src/api-model/models/generate-placement-options-request.js +15 -0
  37. package/dist/cjs/src/api-model/models/generate-placement-options-response.js +15 -0
  38. package/dist/cjs/src/api-model/models/generate-self-ship-appointment-slots-request.js +15 -0
  39. package/dist/cjs/src/api-model/models/generate-self-ship-appointment-slots-response.js +15 -0
  40. package/dist/cjs/src/api-model/models/generate-transportation-options-request.js +15 -0
  41. package/dist/cjs/src/api-model/models/generate-transportation-options-response.js +15 -0
  42. package/dist/cjs/src/api-model/models/get-delivery-challan-document-response.js +15 -0
  43. package/dist/cjs/src/api-model/models/get-self-ship-appointment-slots-response.js +15 -0
  44. package/dist/cjs/src/api-model/models/inbound-operation-status.js +15 -0
  45. package/dist/cjs/src/api-model/models/inbound-plan-summary.js +15 -0
  46. package/dist/cjs/src/api-model/models/inbound-plan.js +15 -0
  47. package/dist/cjs/src/api-model/models/incentive.js +15 -0
  48. package/dist/cjs/src/api-model/models/index.js +119 -0
  49. package/dist/cjs/src/api-model/models/item-input.js +15 -0
  50. package/dist/cjs/src/api-model/models/item.js +15 -0
  51. package/dist/cjs/src/api-model/models/label-owner.js +25 -0
  52. package/dist/cjs/src/api-model/models/list-inbound-plan-boxes-response.js +15 -0
  53. package/dist/cjs/src/api-model/models/list-inbound-plan-items-response.js +15 -0
  54. package/dist/cjs/src/api-model/models/list-inbound-plan-pallets-response.js +15 -0
  55. package/dist/cjs/src/api-model/models/list-inbound-plans-response.js +15 -0
  56. package/dist/cjs/src/api-model/models/list-item-compliance-details-response.js +15 -0
  57. package/dist/cjs/src/api-model/models/list-packing-group-items-response.js +15 -0
  58. package/dist/cjs/src/api-model/models/list-packing-options-response.js +15 -0
  59. package/dist/cjs/src/api-model/models/list-placement-options-response.js +15 -0
  60. package/dist/cjs/src/api-model/models/list-transportation-options-response.js +15 -0
  61. package/dist/cjs/src/api-model/models/ltl-tracking-detail-input.js +15 -0
  62. package/dist/cjs/src/api-model/models/ltl-tracking-detail.js +15 -0
  63. package/dist/cjs/src/api-model/models/model-error.js +15 -0
  64. package/dist/cjs/src/api-model/models/operation-problem.js +15 -0
  65. package/dist/cjs/src/api-model/models/operation-status.js +26 -0
  66. package/dist/cjs/src/api-model/models/package-grouping-input.js +15 -0
  67. package/dist/cjs/src/api-model/models/packing-option-summary.js +15 -0
  68. package/dist/cjs/src/api-model/models/packing-option.js +15 -0
  69. package/dist/cjs/src/api-model/models/pagination.js +15 -0
  70. package/dist/cjs/src/api-model/models/pallet-information.js +15 -0
  71. package/dist/cjs/src/api-model/models/pallet-input.js +15 -0
  72. package/dist/cjs/src/api-model/models/pallet.js +15 -0
  73. package/dist/cjs/src/api-model/models/placement-option-summary.js +15 -0
  74. package/dist/cjs/src/api-model/models/placement-option.js +15 -0
  75. package/dist/cjs/src/api-model/models/prep-instruction.js +15 -0
  76. package/dist/cjs/src/api-model/models/prep-owner.js +25 -0
  77. package/dist/cjs/src/api-model/models/quote.js +15 -0
  78. package/dist/cjs/src/api-model/models/reason-comment.js +32 -0
  79. package/dist/cjs/src/api-model/models/region.js +15 -0
  80. package/dist/cjs/src/api-model/models/schedule-self-ship-appointment-request.js +15 -0
  81. package/dist/cjs/src/api-model/models/schedule-self-ship-appointment-response.js +15 -0
  82. package/dist/cjs/src/api-model/models/self-ship-appointment-details.js +15 -0
  83. package/dist/cjs/src/api-model/models/self-ship-appointment-slots-availability.js +15 -0
  84. package/dist/cjs/src/api-model/models/set-packing-information-request.js +15 -0
  85. package/dist/cjs/src/api-model/models/set-packing-information-response.js +15 -0
  86. package/dist/cjs/src/api-model/models/shipment-destination.js +15 -0
  87. package/dist/cjs/src/api-model/models/shipment-source.js +15 -0
  88. package/dist/cjs/src/api-model/models/shipment-summary.js +15 -0
  89. package/dist/cjs/src/api-model/models/shipment-transportation-configuration.js +15 -0
  90. package/dist/cjs/src/api-model/models/shipment.js +15 -0
  91. package/dist/cjs/src/api-model/models/shipping-configuration.js +15 -0
  92. package/dist/cjs/src/api-model/models/spd-tracking-detail-input.js +15 -0
  93. package/dist/cjs/src/api-model/models/spd-tracking-detail.js +15 -0
  94. package/dist/cjs/src/api-model/models/spd-tracking-item-input.js +15 -0
  95. package/dist/cjs/src/api-model/models/spd-tracking-item.js +15 -0
  96. package/dist/cjs/src/api-model/models/stackability.js +25 -0
  97. package/dist/cjs/src/api-model/models/tax-details.js +15 -0
  98. package/dist/cjs/src/api-model/models/tax-rate.js +15 -0
  99. package/dist/cjs/src/api-model/models/tracking-details-input.js +15 -0
  100. package/dist/cjs/src/api-model/models/tracking-details.js +15 -0
  101. package/dist/cjs/src/api-model/models/transportation-option.js +15 -0
  102. package/dist/cjs/src/api-model/models/transportation-selection.js +15 -0
  103. package/dist/cjs/src/api-model/models/unit-of-measurement.js +25 -0
  104. package/dist/cjs/src/api-model/models/unit-of-weight.js +25 -0
  105. package/dist/cjs/src/api-model/models/update-item-compliance-details-request.js +15 -0
  106. package/dist/cjs/src/api-model/models/update-item-compliance-details-response.js +15 -0
  107. package/dist/cjs/src/api-model/models/update-shipment-delivery-window-request.js +15 -0
  108. package/dist/cjs/src/api-model/models/update-shipment-delivery-window-response.js +15 -0
  109. package/dist/cjs/src/api-model/models/update-shipment-tracking-details-request.js +15 -0
  110. package/dist/cjs/src/api-model/models/update-shipment-tracking-details-response.js +15 -0
  111. package/dist/cjs/src/api-model/models/weight.js +15 -0
  112. package/dist/cjs/src/api-model/models/window-input.js +15 -0
  113. package/dist/cjs/src/api-model/models/window.js +15 -0
  114. package/dist/cjs/src/client.js +217 -0
  115. package/dist/es/index.js +2 -0
  116. package/dist/es/src/api-model/api/fba-inbound-api.js +1958 -0
  117. package/dist/es/src/api-model/api.js +14 -0
  118. package/dist/es/src/api-model/base.js +58 -0
  119. package/dist/es/src/api-model/common.js +133 -0
  120. package/dist/es/src/api-model/configuration.js +87 -0
  121. package/dist/es/src/api-model/index.js +16 -0
  122. package/dist/es/src/api-model/models/address.js +14 -0
  123. package/dist/es/src/api-model/models/appointment-slot-time.js +14 -0
  124. package/dist/es/src/api-model/models/appointment-slot.js +14 -0
  125. package/dist/es/src/api-model/models/box-content-information-source.js +23 -0
  126. package/dist/es/src/api-model/models/box-content.js +14 -0
  127. package/dist/es/src/api-model/models/box-input.js +14 -0
  128. package/dist/es/src/api-model/models/box.js +14 -0
  129. package/dist/es/src/api-model/models/cancel-inbound-plan-response.js +14 -0
  130. package/dist/es/src/api-model/models/cancel-self-ship-appointment-request.js +14 -0
  131. package/dist/es/src/api-model/models/cancel-self-ship-appointment-response.js +14 -0
  132. package/dist/es/src/api-model/models/carrier.js +14 -0
  133. package/dist/es/src/api-model/models/compliance-detail.js +14 -0
  134. package/dist/es/src/api-model/models/confirm-packing-option-response.js +14 -0
  135. package/dist/es/src/api-model/models/confirm-placement-option-response.js +14 -0
  136. package/dist/es/src/api-model/models/confirm-transportation-options-request.js +14 -0
  137. package/dist/es/src/api-model/models/confirm-transportation-options-response.js +14 -0
  138. package/dist/es/src/api-model/models/contact-information.js +14 -0
  139. package/dist/es/src/api-model/models/create-inbound-plan-request.js +14 -0
  140. package/dist/es/src/api-model/models/create-inbound-plan-response.js +14 -0
  141. package/dist/es/src/api-model/models/currency.js +14 -0
  142. package/dist/es/src/api-model/models/custom-placement-input.js +14 -0
  143. package/dist/es/src/api-model/models/dates.js +14 -0
  144. package/dist/es/src/api-model/models/dimensions.js +14 -0
  145. package/dist/es/src/api-model/models/document-download.js +14 -0
  146. package/dist/es/src/api-model/models/error-list.js +14 -0
  147. package/dist/es/src/api-model/models/generate-packing-options-response.js +14 -0
  148. package/dist/es/src/api-model/models/generate-placement-options-request.js +14 -0
  149. package/dist/es/src/api-model/models/generate-placement-options-response.js +14 -0
  150. package/dist/es/src/api-model/models/generate-self-ship-appointment-slots-request.js +14 -0
  151. package/dist/es/src/api-model/models/generate-self-ship-appointment-slots-response.js +14 -0
  152. package/dist/es/src/api-model/models/generate-transportation-options-request.js +14 -0
  153. package/dist/es/src/api-model/models/generate-transportation-options-response.js +14 -0
  154. package/dist/es/src/api-model/models/get-delivery-challan-document-response.js +14 -0
  155. package/dist/es/src/api-model/models/get-self-ship-appointment-slots-response.js +14 -0
  156. package/dist/es/src/api-model/models/inbound-operation-status.js +14 -0
  157. package/dist/es/src/api-model/models/inbound-plan-summary.js +14 -0
  158. package/dist/es/src/api-model/models/inbound-plan.js +14 -0
  159. package/dist/es/src/api-model/models/incentive.js +14 -0
  160. package/dist/es/src/api-model/models/index.js +103 -0
  161. package/dist/es/src/api-model/models/item-input.js +14 -0
  162. package/dist/es/src/api-model/models/item.js +14 -0
  163. package/dist/es/src/api-model/models/label-owner.js +22 -0
  164. package/dist/es/src/api-model/models/list-inbound-plan-boxes-response.js +14 -0
  165. package/dist/es/src/api-model/models/list-inbound-plan-items-response.js +14 -0
  166. package/dist/es/src/api-model/models/list-inbound-plan-pallets-response.js +14 -0
  167. package/dist/es/src/api-model/models/list-inbound-plans-response.js +14 -0
  168. package/dist/es/src/api-model/models/list-item-compliance-details-response.js +14 -0
  169. package/dist/es/src/api-model/models/list-packing-group-items-response.js +14 -0
  170. package/dist/es/src/api-model/models/list-packing-options-response.js +14 -0
  171. package/dist/es/src/api-model/models/list-placement-options-response.js +14 -0
  172. package/dist/es/src/api-model/models/list-transportation-options-response.js +14 -0
  173. package/dist/es/src/api-model/models/ltl-tracking-detail-input.js +14 -0
  174. package/dist/es/src/api-model/models/ltl-tracking-detail.js +14 -0
  175. package/dist/es/src/api-model/models/model-error.js +14 -0
  176. package/dist/es/src/api-model/models/operation-problem.js +14 -0
  177. package/dist/es/src/api-model/models/operation-status.js +23 -0
  178. package/dist/es/src/api-model/models/package-grouping-input.js +14 -0
  179. package/dist/es/src/api-model/models/packing-option-summary.js +14 -0
  180. package/dist/es/src/api-model/models/packing-option.js +14 -0
  181. package/dist/es/src/api-model/models/pagination.js +14 -0
  182. package/dist/es/src/api-model/models/pallet-information.js +14 -0
  183. package/dist/es/src/api-model/models/pallet-input.js +14 -0
  184. package/dist/es/src/api-model/models/pallet.js +14 -0
  185. package/dist/es/src/api-model/models/placement-option-summary.js +14 -0
  186. package/dist/es/src/api-model/models/placement-option.js +14 -0
  187. package/dist/es/src/api-model/models/prep-instruction.js +14 -0
  188. package/dist/es/src/api-model/models/prep-owner.js +22 -0
  189. package/dist/es/src/api-model/models/quote.js +14 -0
  190. package/dist/es/src/api-model/models/reason-comment.js +29 -0
  191. package/dist/es/src/api-model/models/region.js +14 -0
  192. package/dist/es/src/api-model/models/schedule-self-ship-appointment-request.js +14 -0
  193. package/dist/es/src/api-model/models/schedule-self-ship-appointment-response.js +14 -0
  194. package/dist/es/src/api-model/models/self-ship-appointment-details.js +14 -0
  195. package/dist/es/src/api-model/models/self-ship-appointment-slots-availability.js +14 -0
  196. package/dist/es/src/api-model/models/set-packing-information-request.js +14 -0
  197. package/dist/es/src/api-model/models/set-packing-information-response.js +14 -0
  198. package/dist/es/src/api-model/models/shipment-destination.js +14 -0
  199. package/dist/es/src/api-model/models/shipment-source.js +14 -0
  200. package/dist/es/src/api-model/models/shipment-summary.js +14 -0
  201. package/dist/es/src/api-model/models/shipment-transportation-configuration.js +14 -0
  202. package/dist/es/src/api-model/models/shipment.js +14 -0
  203. package/dist/es/src/api-model/models/shipping-configuration.js +14 -0
  204. package/dist/es/src/api-model/models/spd-tracking-detail-input.js +14 -0
  205. package/dist/es/src/api-model/models/spd-tracking-detail.js +14 -0
  206. package/dist/es/src/api-model/models/spd-tracking-item-input.js +14 -0
  207. package/dist/es/src/api-model/models/spd-tracking-item.js +14 -0
  208. package/dist/es/src/api-model/models/stackability.js +22 -0
  209. package/dist/es/src/api-model/models/tax-details.js +14 -0
  210. package/dist/es/src/api-model/models/tax-rate.js +14 -0
  211. package/dist/es/src/api-model/models/tracking-details-input.js +14 -0
  212. package/dist/es/src/api-model/models/tracking-details.js +14 -0
  213. package/dist/es/src/api-model/models/transportation-option.js +14 -0
  214. package/dist/es/src/api-model/models/transportation-selection.js +14 -0
  215. package/dist/es/src/api-model/models/unit-of-measurement.js +22 -0
  216. package/dist/es/src/api-model/models/unit-of-weight.js +22 -0
  217. package/dist/es/src/api-model/models/update-item-compliance-details-request.js +14 -0
  218. package/dist/es/src/api-model/models/update-item-compliance-details-response.js +14 -0
  219. package/dist/es/src/api-model/models/update-shipment-delivery-window-request.js +14 -0
  220. package/dist/es/src/api-model/models/update-shipment-delivery-window-response.js +14 -0
  221. package/dist/es/src/api-model/models/update-shipment-tracking-details-request.js +14 -0
  222. package/dist/es/src/api-model/models/update-shipment-tracking-details-response.js +14 -0
  223. package/dist/es/src/api-model/models/weight.js +14 -0
  224. package/dist/es/src/api-model/models/window-input.js +14 -0
  225. package/dist/es/src/api-model/models/window.js +14 -0
  226. package/dist/es/src/client.js +213 -0
  227. package/dist/types/index.d.ts +2 -0
  228. package/dist/types/src/api-model/api/fba-inbound-api.d.ts +1675 -0
  229. package/dist/types/src/api-model/api.d.ts +12 -0
  230. package/dist/types/src/api-model/base.d.ts +54 -0
  231. package/dist/types/src/api-model/common.d.ts +66 -0
  232. package/dist/types/src/api-model/configuration.d.ts +83 -0
  233. package/dist/types/src/api-model/index.d.ts +14 -0
  234. package/dist/types/src/api-model/models/address.d.ts +66 -0
  235. package/dist/types/src/api-model/models/appointment-slot-time.d.ts +30 -0
  236. package/dist/types/src/api-model/models/appointment-slot.d.ts +31 -0
  237. package/dist/types/src/api-model/models/box-content-information-source.d.ts +22 -0
  238. package/dist/types/src/api-model/models/box-content.d.ts +56 -0
  239. package/dist/types/src/api-model/models/box-input.d.ts +64 -0
  240. package/dist/types/src/api-model/models/box.d.ts +70 -0
  241. package/dist/types/src/api-model/models/cancel-inbound-plan-response.d.ts +24 -0
  242. package/dist/types/src/api-model/models/cancel-self-ship-appointment-request.d.ts +25 -0
  243. package/dist/types/src/api-model/models/cancel-self-ship-appointment-response.d.ts +24 -0
  244. package/dist/types/src/api-model/models/carrier.d.ts +30 -0
  245. package/dist/types/src/api-model/models/compliance-detail.d.ts +43 -0
  246. package/dist/types/src/api-model/models/confirm-packing-option-response.d.ts +24 -0
  247. package/dist/types/src/api-model/models/confirm-placement-option-response.d.ts +24 -0
  248. package/dist/types/src/api-model/models/confirm-transportation-options-request.d.ts +25 -0
  249. package/dist/types/src/api-model/models/confirm-transportation-options-response.d.ts +24 -0
  250. package/dist/types/src/api-model/models/contact-information.d.ts +36 -0
  251. package/dist/types/src/api-model/models/create-inbound-plan-request.d.ts +51 -0
  252. package/dist/types/src/api-model/models/create-inbound-plan-response.d.ts +30 -0
  253. package/dist/types/src/api-model/models/currency.d.ts +30 -0
  254. package/dist/types/src/api-model/models/custom-placement-input.d.ts +31 -0
  255. package/dist/types/src/api-model/models/dates.d.ts +31 -0
  256. package/dist/types/src/api-model/models/dimensions.d.ts +43 -0
  257. package/dist/types/src/api-model/models/document-download.d.ts +36 -0
  258. package/dist/types/src/api-model/models/error-list.d.ts +24 -0
  259. package/dist/types/src/api-model/models/generate-packing-options-response.d.ts +24 -0
  260. package/dist/types/src/api-model/models/generate-placement-options-request.d.ts +25 -0
  261. package/dist/types/src/api-model/models/generate-placement-options-response.d.ts +24 -0
  262. package/dist/types/src/api-model/models/generate-self-ship-appointment-slots-request.d.ts +30 -0
  263. package/dist/types/src/api-model/models/generate-self-ship-appointment-slots-response.d.ts +24 -0
  264. package/dist/types/src/api-model/models/generate-transportation-options-request.d.ts +31 -0
  265. package/dist/types/src/api-model/models/generate-transportation-options-response.d.ts +24 -0
  266. package/dist/types/src/api-model/models/get-delivery-challan-document-response.d.ts +25 -0
  267. package/dist/types/src/api-model/models/get-self-ship-appointment-slots-response.d.ts +32 -0
  268. package/dist/types/src/api-model/models/inbound-operation-status.d.ts +44 -0
  269. package/dist/types/src/api-model/models/inbound-plan-summary.d.ts +68 -0
  270. package/dist/types/src/api-model/models/inbound-plan.d.ts +89 -0
  271. package/dist/types/src/api-model/models/incentive.d.ts +43 -0
  272. package/dist/types/src/api-model/models/index.d.ts +103 -0
  273. package/dist/types/src/api-model/models/item-input.d.ts +56 -0
  274. package/dist/types/src/api-model/models/item.d.ts +67 -0
  275. package/dist/types/src/api-model/models/label-owner.d.ts +21 -0
  276. package/dist/types/src/api-model/models/list-inbound-plan-boxes-response.d.ts +32 -0
  277. package/dist/types/src/api-model/models/list-inbound-plan-items-response.d.ts +32 -0
  278. package/dist/types/src/api-model/models/list-inbound-plan-pallets-response.d.ts +32 -0
  279. package/dist/types/src/api-model/models/list-inbound-plans-response.d.ts +32 -0
  280. package/dist/types/src/api-model/models/list-item-compliance-details-response.d.ts +25 -0
  281. package/dist/types/src/api-model/models/list-packing-group-items-response.d.ts +32 -0
  282. package/dist/types/src/api-model/models/list-packing-options-response.d.ts +32 -0
  283. package/dist/types/src/api-model/models/list-placement-options-response.d.ts +32 -0
  284. package/dist/types/src/api-model/models/list-transportation-options-response.d.ts +32 -0
  285. package/dist/types/src/api-model/models/ltl-tracking-detail-input.d.ts +30 -0
  286. package/dist/types/src/api-model/models/ltl-tracking-detail.d.ts +30 -0
  287. package/dist/types/src/api-model/models/model-error.d.ts +36 -0
  288. package/dist/types/src/api-model/models/operation-problem.d.ts +42 -0
  289. package/dist/types/src/api-model/models/operation-status.d.ts +22 -0
  290. package/dist/types/src/api-model/models/package-grouping-input.d.ts +37 -0
  291. package/dist/types/src/api-model/models/packing-option-summary.d.ts +30 -0
  292. package/dist/types/src/api-model/models/packing-option.d.ts +68 -0
  293. package/dist/types/src/api-model/models/pagination.d.ts +24 -0
  294. package/dist/types/src/api-model/models/pallet-information.d.ts +38 -0
  295. package/dist/types/src/api-model/models/pallet-input.d.ts +45 -0
  296. package/dist/types/src/api-model/models/pallet.d.ts +51 -0
  297. package/dist/types/src/api-model/models/placement-option-summary.d.ts +30 -0
  298. package/dist/types/src/api-model/models/placement-option.d.ts +55 -0
  299. package/dist/types/src/api-model/models/prep-instruction.d.ts +37 -0
  300. package/dist/types/src/api-model/models/prep-owner.d.ts +21 -0
  301. package/dist/types/src/api-model/models/quote.d.ts +37 -0
  302. package/dist/types/src/api-model/models/reason-comment.d.ts +28 -0
  303. package/dist/types/src/api-model/models/region.d.ts +36 -0
  304. package/dist/types/src/api-model/models/schedule-self-ship-appointment-request.d.ts +25 -0
  305. package/dist/types/src/api-model/models/schedule-self-ship-appointment-response.d.ts +25 -0
  306. package/dist/types/src/api-model/models/self-ship-appointment-details.d.ts +37 -0
  307. package/dist/types/src/api-model/models/self-ship-appointment-slots-availability.d.ts +31 -0
  308. package/dist/types/src/api-model/models/set-packing-information-request.d.ts +25 -0
  309. package/dist/types/src/api-model/models/set-packing-information-response.d.ts +24 -0
  310. package/dist/types/src/api-model/models/shipment-destination.d.ts +37 -0
  311. package/dist/types/src/api-model/models/shipment-source.d.ts +31 -0
  312. package/dist/types/src/api-model/models/shipment-summary.d.ts +30 -0
  313. package/dist/types/src/api-model/models/shipment-transportation-configuration.d.ts +45 -0
  314. package/dist/types/src/api-model/models/shipment.d.ts +115 -0
  315. package/dist/types/src/api-model/models/shipping-configuration.d.ts +30 -0
  316. package/dist/types/src/api-model/models/spd-tracking-detail-input.d.ts +25 -0
  317. package/dist/types/src/api-model/models/spd-tracking-detail.d.ts +25 -0
  318. package/dist/types/src/api-model/models/spd-tracking-item-input.d.ts +30 -0
  319. package/dist/types/src/api-model/models/spd-tracking-item.d.ts +36 -0
  320. package/dist/types/src/api-model/models/stackability.d.ts +21 -0
  321. package/dist/types/src/api-model/models/tax-details.d.ts +38 -0
  322. package/dist/types/src/api-model/models/tax-rate.d.ts +36 -0
  323. package/dist/types/src/api-model/models/tracking-details-input.d.ts +32 -0
  324. package/dist/types/src/api-model/models/tracking-details.d.ts +32 -0
  325. package/dist/types/src/api-model/models/transportation-option.d.ts +75 -0
  326. package/dist/types/src/api-model/models/transportation-selection.d.ts +44 -0
  327. package/dist/types/src/api-model/models/unit-of-measurement.d.ts +21 -0
  328. package/dist/types/src/api-model/models/unit-of-weight.d.ts +21 -0
  329. package/dist/types/src/api-model/models/update-item-compliance-details-request.d.ts +31 -0
  330. package/dist/types/src/api-model/models/update-item-compliance-details-response.d.ts +24 -0
  331. package/dist/types/src/api-model/models/update-shipment-delivery-window-request.d.ts +25 -0
  332. package/dist/types/src/api-model/models/update-shipment-delivery-window-response.d.ts +24 -0
  333. package/dist/types/src/api-model/models/update-shipment-tracking-details-request.d.ts +25 -0
  334. package/dist/types/src/api-model/models/update-shipment-tracking-details-response.d.ts +24 -0
  335. package/dist/types/src/api-model/models/weight.d.ts +31 -0
  336. package/dist/types/src/api-model/models/window-input.d.ts +24 -0
  337. package/dist/types/src/api-model/models/window.d.ts +36 -0
  338. package/dist/types/src/client.d.ts +6 -0
  339. package/package.json +44 -0
@@ -0,0 +1,1958 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * The Selling Partner API for FBA inbound operations.
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 2024-03-20
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import globalAxios from 'axios';
15
+ // Some imports not used depending on template conditions
16
+ // @ts-ignore
17
+ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
18
+ // @ts-ignore
19
+ import { BASE_PATH, BaseAPI } from '../base';
20
+ /**
21
+ * FbaInboundApi - axios parameter creator
22
+ * @export
23
+ */
24
+ export const FbaInboundApiAxiosParamCreator = function (configuration) {
25
+ return {
26
+ /**
27
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
28
+ * @param {string} inboundPlanId Identifier to an inbound plan.
29
+ * @param {*} [options] Override http request option.
30
+ * @throws {RequiredError}
31
+ */
32
+ cancelInboundPlan: async (inboundPlanId, options = {}) => {
33
+ // verify required parameter 'inboundPlanId' is not null or undefined
34
+ assertParamExists('cancelInboundPlan', 'inboundPlanId', inboundPlanId);
35
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/cancellation`
36
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
37
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
38
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
39
+ let baseOptions;
40
+ if (configuration) {
41
+ baseOptions = configuration.baseOptions;
42
+ }
43
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
44
+ const localVarHeaderParameter = {};
45
+ const localVarQueryParameter = {};
46
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
47
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
48
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
49
+ return {
50
+ url: toPathString(localVarUrlObj),
51
+ options: localVarRequestOptions,
52
+ };
53
+ },
54
+ /**
55
+ * Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
56
+ * @param {string} inboundPlanId Identifier to an inbound plan.
57
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
58
+ * @param {string} slotId Identifier to a self-ship appointment slot.
59
+ * @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`.
60
+ * @param {*} [options] Override http request option.
61
+ * @throws {RequiredError}
62
+ */
63
+ cancelSelfShipAppointment: async (inboundPlanId, shipmentId, slotId, body, options = {}) => {
64
+ // verify required parameter 'inboundPlanId' is not null or undefined
65
+ assertParamExists('cancelSelfShipAppointment', 'inboundPlanId', inboundPlanId);
66
+ // verify required parameter 'shipmentId' is not null or undefined
67
+ assertParamExists('cancelSelfShipAppointment', 'shipmentId', shipmentId);
68
+ // verify required parameter 'slotId' is not null or undefined
69
+ assertParamExists('cancelSelfShipAppointment', 'slotId', slotId);
70
+ // verify required parameter 'body' is not null or undefined
71
+ assertParamExists('cancelSelfShipAppointment', 'body', body);
72
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots/{slotId}/cancellation`
73
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
74
+ .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)))
75
+ .replace(`{${"slotId"}}`, encodeURIComponent(String(slotId)));
76
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
77
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
78
+ let baseOptions;
79
+ if (configuration) {
80
+ baseOptions = configuration.baseOptions;
81
+ }
82
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
83
+ const localVarHeaderParameter = {};
84
+ const localVarQueryParameter = {};
85
+ localVarHeaderParameter['Content-Type'] = 'application/json';
86
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
87
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
88
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
89
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
90
+ return {
91
+ url: toPathString(localVarUrlObj),
92
+ options: localVarRequestOptions,
93
+ };
94
+ },
95
+ /**
96
+ * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
97
+ * @param {string} inboundPlanId Identifier to an inbound plan.
98
+ * @param {string} packingOptionId Identifier to a packing option.
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ confirmPackingOption: async (inboundPlanId, packingOptionId, options = {}) => {
103
+ // verify required parameter 'inboundPlanId' is not null or undefined
104
+ assertParamExists('confirmPackingOption', 'inboundPlanId', inboundPlanId);
105
+ // verify required parameter 'packingOptionId' is not null or undefined
106
+ assertParamExists('confirmPackingOption', 'packingOptionId', packingOptionId);
107
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions/{packingOptionId}/confirmation`
108
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
109
+ .replace(`{${"packingOptionId"}}`, encodeURIComponent(String(packingOptionId)));
110
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
111
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
112
+ let baseOptions;
113
+ if (configuration) {
114
+ baseOptions = configuration.baseOptions;
115
+ }
116
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
117
+ const localVarHeaderParameter = {};
118
+ const localVarQueryParameter = {};
119
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
120
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
121
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
122
+ return {
123
+ url: toPathString(localVarUrlObj),
124
+ options: localVarRequestOptions,
125
+ };
126
+ },
127
+ /**
128
+ * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
129
+ * @param {string} inboundPlanId Identifier to an inbound plan.
130
+ * @param {string} placementOptionId Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs.
131
+ * @param {*} [options] Override http request option.
132
+ * @throws {RequiredError}
133
+ */
134
+ confirmPlacementOption: async (inboundPlanId, placementOptionId, options = {}) => {
135
+ // verify required parameter 'inboundPlanId' is not null or undefined
136
+ assertParamExists('confirmPlacementOption', 'inboundPlanId', inboundPlanId);
137
+ // verify required parameter 'placementOptionId' is not null or undefined
138
+ assertParamExists('confirmPlacementOption', 'placementOptionId', placementOptionId);
139
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions/{placementOptionId}/confirmation`
140
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
141
+ .replace(`{${"placementOptionId"}}`, encodeURIComponent(String(placementOptionId)));
142
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
143
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
144
+ let baseOptions;
145
+ if (configuration) {
146
+ baseOptions = configuration.baseOptions;
147
+ }
148
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
149
+ const localVarHeaderParameter = {};
150
+ const localVarQueryParameter = {};
151
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
152
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
153
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
154
+ return {
155
+ url: toPathString(localVarUrlObj),
156
+ options: localVarRequestOptions,
157
+ };
158
+ },
159
+ /**
160
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
161
+ * @param {string} inboundPlanId Identifier to an inbound plan.
162
+ * @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`.
163
+ * @param {*} [options] Override http request option.
164
+ * @throws {RequiredError}
165
+ */
166
+ confirmTransportationOptions: async (inboundPlanId, body, options = {}) => {
167
+ // verify required parameter 'inboundPlanId' is not null or undefined
168
+ assertParamExists('confirmTransportationOptions', 'inboundPlanId', inboundPlanId);
169
+ // verify required parameter 'body' is not null or undefined
170
+ assertParamExists('confirmTransportationOptions', 'body', body);
171
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions/confirmation`
172
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
173
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
174
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
175
+ let baseOptions;
176
+ if (configuration) {
177
+ baseOptions = configuration.baseOptions;
178
+ }
179
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
180
+ const localVarHeaderParameter = {};
181
+ const localVarQueryParameter = {};
182
+ localVarHeaderParameter['Content-Type'] = 'application/json';
183
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
184
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
185
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
186
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
187
+ return {
188
+ url: toPathString(localVarUrlObj),
189
+ options: localVarRequestOptions,
190
+ };
191
+ },
192
+ /**
193
+ * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
194
+ * @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`.
195
+ * @param {*} [options] Override http request option.
196
+ * @throws {RequiredError}
197
+ */
198
+ createInboundPlan: async (body, options = {}) => {
199
+ // verify required parameter 'body' is not null or undefined
200
+ assertParamExists('createInboundPlan', 'body', body);
201
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans`;
202
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
203
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
204
+ let baseOptions;
205
+ if (configuration) {
206
+ baseOptions = configuration.baseOptions;
207
+ }
208
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
209
+ const localVarHeaderParameter = {};
210
+ const localVarQueryParameter = {};
211
+ localVarHeaderParameter['Content-Type'] = 'application/json';
212
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
213
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
214
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
215
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
216
+ return {
217
+ url: toPathString(localVarUrlObj),
218
+ options: localVarRequestOptions,
219
+ };
220
+ },
221
+ /**
222
+ * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
223
+ * @param {string} inboundPlanId Identifier to an inbound plan.
224
+ * @param {*} [options] Override http request option.
225
+ * @throws {RequiredError}
226
+ */
227
+ generatePackingOptions: async (inboundPlanId, options = {}) => {
228
+ // verify required parameter 'inboundPlanId' is not null or undefined
229
+ assertParamExists('generatePackingOptions', 'inboundPlanId', inboundPlanId);
230
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions`
231
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
232
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
233
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
234
+ let baseOptions;
235
+ if (configuration) {
236
+ baseOptions = configuration.baseOptions;
237
+ }
238
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
239
+ const localVarHeaderParameter = {};
240
+ const localVarQueryParameter = {};
241
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
242
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
243
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
244
+ return {
245
+ url: toPathString(localVarUrlObj),
246
+ options: localVarRequestOptions,
247
+ };
248
+ },
249
+ /**
250
+ * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
251
+ * @param {string} inboundPlanId Identifier to an inbound plan.
252
+ * @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`.
253
+ * @param {*} [options] Override http request option.
254
+ * @throws {RequiredError}
255
+ */
256
+ generatePlacementOptions: async (inboundPlanId, body, options = {}) => {
257
+ // verify required parameter 'inboundPlanId' is not null or undefined
258
+ assertParamExists('generatePlacementOptions', 'inboundPlanId', inboundPlanId);
259
+ // verify required parameter 'body' is not null or undefined
260
+ assertParamExists('generatePlacementOptions', 'body', body);
261
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions`
262
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
263
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
264
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
265
+ let baseOptions;
266
+ if (configuration) {
267
+ baseOptions = configuration.baseOptions;
268
+ }
269
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
270
+ const localVarHeaderParameter = {};
271
+ const localVarQueryParameter = {};
272
+ localVarHeaderParameter['Content-Type'] = 'application/json';
273
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
274
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
275
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
276
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
277
+ return {
278
+ url: toPathString(localVarUrlObj),
279
+ options: localVarRequestOptions,
280
+ };
281
+ },
282
+ /**
283
+ * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
284
+ * @param {string} inboundPlanId Identifier to an inbound plan.
285
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
286
+ * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request `generateSelfShipAppointmentSlots`.
287
+ * @param {*} [options] Override http request option.
288
+ * @throws {RequiredError}
289
+ */
290
+ generateSelfShipAppointmentSlots: async (inboundPlanId, shipmentId, body, options = {}) => {
291
+ // verify required parameter 'inboundPlanId' is not null or undefined
292
+ assertParamExists('generateSelfShipAppointmentSlots', 'inboundPlanId', inboundPlanId);
293
+ // verify required parameter 'shipmentId' is not null or undefined
294
+ assertParamExists('generateSelfShipAppointmentSlots', 'shipmentId', shipmentId);
295
+ // verify required parameter 'body' is not null or undefined
296
+ assertParamExists('generateSelfShipAppointmentSlots', 'body', body);
297
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots`
298
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
299
+ .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
300
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
301
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
302
+ let baseOptions;
303
+ if (configuration) {
304
+ baseOptions = configuration.baseOptions;
305
+ }
306
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
307
+ const localVarHeaderParameter = {};
308
+ const localVarQueryParameter = {};
309
+ localVarHeaderParameter['Content-Type'] = 'application/json';
310
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
311
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
312
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
313
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
314
+ return {
315
+ url: toPathString(localVarUrlObj),
316
+ options: localVarRequestOptions,
317
+ };
318
+ },
319
+ /**
320
+ * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
321
+ * @param {string} inboundPlanId Identifier to an inbound plan.
322
+ * @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`.
323
+ * @param {*} [options] Override http request option.
324
+ * @throws {RequiredError}
325
+ */
326
+ generateTransportationOptions: async (inboundPlanId, body, options = {}) => {
327
+ // verify required parameter 'inboundPlanId' is not null or undefined
328
+ assertParamExists('generateTransportationOptions', 'inboundPlanId', inboundPlanId);
329
+ // verify required parameter 'body' is not null or undefined
330
+ assertParamExists('generateTransportationOptions', 'body', body);
331
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions`
332
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
333
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
334
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
335
+ let baseOptions;
336
+ if (configuration) {
337
+ baseOptions = configuration.baseOptions;
338
+ }
339
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
340
+ const localVarHeaderParameter = {};
341
+ const localVarQueryParameter = {};
342
+ localVarHeaderParameter['Content-Type'] = 'application/json';
343
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
344
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
345
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
346
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
347
+ return {
348
+ url: toPathString(localVarUrlObj),
349
+ options: localVarRequestOptions,
350
+ };
351
+ },
352
+ /**
353
+ * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
354
+ * @param {string} inboundPlanId Identifier to an inbound plan.
355
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
356
+ * @param {*} [options] Override http request option.
357
+ * @throws {RequiredError}
358
+ */
359
+ getDeliveryChallanDocument: async (inboundPlanId, shipmentId, options = {}) => {
360
+ // verify required parameter 'inboundPlanId' is not null or undefined
361
+ assertParamExists('getDeliveryChallanDocument', 'inboundPlanId', inboundPlanId);
362
+ // verify required parameter 'shipmentId' is not null or undefined
363
+ assertParamExists('getDeliveryChallanDocument', 'shipmentId', shipmentId);
364
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryChallanDocument`
365
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
366
+ .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
367
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
368
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
369
+ let baseOptions;
370
+ if (configuration) {
371
+ baseOptions = configuration.baseOptions;
372
+ }
373
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
374
+ const localVarHeaderParameter = {};
375
+ const localVarQueryParameter = {};
376
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
377
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
378
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
379
+ return {
380
+ url: toPathString(localVarUrlObj),
381
+ options: localVarRequestOptions,
382
+ };
383
+ },
384
+ /**
385
+ * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
386
+ * @param {string} operationId Identifier to an asynchronous operation.
387
+ * @param {*} [options] Override http request option.
388
+ * @throws {RequiredError}
389
+ */
390
+ getInboundOperationStatus: async (operationId, options = {}) => {
391
+ // verify required parameter 'operationId' is not null or undefined
392
+ assertParamExists('getInboundOperationStatus', 'operationId', operationId);
393
+ const localVarPath = `/inbound/fba/2024-03-20/operations/{operationId}`
394
+ .replace(`{${"operationId"}}`, encodeURIComponent(String(operationId)));
395
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
396
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
397
+ let baseOptions;
398
+ if (configuration) {
399
+ baseOptions = configuration.baseOptions;
400
+ }
401
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
402
+ const localVarHeaderParameter = {};
403
+ const localVarQueryParameter = {};
404
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
405
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
406
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
407
+ return {
408
+ url: toPathString(localVarUrlObj),
409
+ options: localVarRequestOptions,
410
+ };
411
+ },
412
+ /**
413
+ * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
414
+ * @param {string} inboundPlanId Identifier to an inbound plan.
415
+ * @param {*} [options] Override http request option.
416
+ * @throws {RequiredError}
417
+ */
418
+ getInboundPlan: async (inboundPlanId, options = {}) => {
419
+ // verify required parameter 'inboundPlanId' is not null or undefined
420
+ assertParamExists('getInboundPlan', 'inboundPlanId', inboundPlanId);
421
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}`
422
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
423
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
424
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
425
+ let baseOptions;
426
+ if (configuration) {
427
+ baseOptions = configuration.baseOptions;
428
+ }
429
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
430
+ const localVarHeaderParameter = {};
431
+ const localVarQueryParameter = {};
432
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
433
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
434
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
435
+ return {
436
+ url: toPathString(localVarUrlObj),
437
+ options: localVarRequestOptions,
438
+ };
439
+ },
440
+ /**
441
+ * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
442
+ * @param {string} inboundPlanId Identifier to an inbound plan.
443
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
444
+ * @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
445
+ * @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.
446
+ * @param {*} [options] Override http request option.
447
+ * @throws {RequiredError}
448
+ */
449
+ getSelfShipAppointmentSlots: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
450
+ // verify required parameter 'inboundPlanId' is not null or undefined
451
+ assertParamExists('getSelfShipAppointmentSlots', 'inboundPlanId', inboundPlanId);
452
+ // verify required parameter 'shipmentId' is not null or undefined
453
+ assertParamExists('getSelfShipAppointmentSlots', 'shipmentId', shipmentId);
454
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots`
455
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
456
+ .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
457
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
458
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
459
+ let baseOptions;
460
+ if (configuration) {
461
+ baseOptions = configuration.baseOptions;
462
+ }
463
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
464
+ const localVarHeaderParameter = {};
465
+ const localVarQueryParameter = {};
466
+ if (pageSize !== undefined) {
467
+ localVarQueryParameter['pageSize'] = pageSize;
468
+ }
469
+ if (paginationToken !== undefined) {
470
+ localVarQueryParameter['paginationToken'] = paginationToken;
471
+ }
472
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
473
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
474
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
475
+ return {
476
+ url: toPathString(localVarUrlObj),
477
+ options: localVarRequestOptions,
478
+ };
479
+ },
480
+ /**
481
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
482
+ * @param {string} inboundPlanId Identifier to an inbound plan.
483
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
484
+ * @param {*} [options] Override http request option.
485
+ * @throws {RequiredError}
486
+ */
487
+ getShipment: async (inboundPlanId, shipmentId, options = {}) => {
488
+ // verify required parameter 'inboundPlanId' is not null or undefined
489
+ assertParamExists('getShipment', 'inboundPlanId', inboundPlanId);
490
+ // verify required parameter 'shipmentId' is not null or undefined
491
+ assertParamExists('getShipment', 'shipmentId', shipmentId);
492
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}`
493
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
494
+ .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
495
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
496
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
497
+ let baseOptions;
498
+ if (configuration) {
499
+ baseOptions = configuration.baseOptions;
500
+ }
501
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
502
+ const localVarHeaderParameter = {};
503
+ const localVarQueryParameter = {};
504
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
505
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
506
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
507
+ return {
508
+ url: toPathString(localVarUrlObj),
509
+ options: localVarRequestOptions,
510
+ };
511
+ },
512
+ /**
513
+ * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
514
+ * @param {string} inboundPlanId Identifier to an inbound plan.
515
+ * @param {number} [pageSize] The number of boxes to return in the response matching the given query.
516
+ * @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.
517
+ * @param {*} [options] Override http request option.
518
+ * @throws {RequiredError}
519
+ */
520
+ listInboundPlanBoxes: async (inboundPlanId, pageSize, paginationToken, options = {}) => {
521
+ // verify required parameter 'inboundPlanId' is not null or undefined
522
+ assertParamExists('listInboundPlanBoxes', 'inboundPlanId', inboundPlanId);
523
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/boxes`
524
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
525
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
526
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
527
+ let baseOptions;
528
+ if (configuration) {
529
+ baseOptions = configuration.baseOptions;
530
+ }
531
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
532
+ const localVarHeaderParameter = {};
533
+ const localVarQueryParameter = {};
534
+ if (pageSize !== undefined) {
535
+ localVarQueryParameter['pageSize'] = pageSize;
536
+ }
537
+ if (paginationToken !== undefined) {
538
+ localVarQueryParameter['paginationToken'] = paginationToken;
539
+ }
540
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
541
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
542
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
543
+ return {
544
+ url: toPathString(localVarUrlObj),
545
+ options: localVarRequestOptions,
546
+ };
547
+ },
548
+ /**
549
+ * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
550
+ * @param {string} inboundPlanId Identifier to an inbound plan.
551
+ * @param {number} [pageSize] The number of items to return in the response matching the given query.
552
+ * @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.
553
+ * @param {*} [options] Override http request option.
554
+ * @throws {RequiredError}
555
+ */
556
+ listInboundPlanItems: async (inboundPlanId, pageSize, paginationToken, options = {}) => {
557
+ // verify required parameter 'inboundPlanId' is not null or undefined
558
+ assertParamExists('listInboundPlanItems', 'inboundPlanId', inboundPlanId);
559
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/items`
560
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
561
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
562
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
563
+ let baseOptions;
564
+ if (configuration) {
565
+ baseOptions = configuration.baseOptions;
566
+ }
567
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
568
+ const localVarHeaderParameter = {};
569
+ const localVarQueryParameter = {};
570
+ if (pageSize !== undefined) {
571
+ localVarQueryParameter['pageSize'] = pageSize;
572
+ }
573
+ if (paginationToken !== undefined) {
574
+ localVarQueryParameter['paginationToken'] = paginationToken;
575
+ }
576
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
577
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
578
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
579
+ return {
580
+ url: toPathString(localVarUrlObj),
581
+ options: localVarRequestOptions,
582
+ };
583
+ },
584
+ /**
585
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
586
+ * @param {string} inboundPlanId Identifier to an inbound plan.
587
+ * @param {number} [pageSize] The number of pallets to return in the response matching the given query.
588
+ * @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.
589
+ * @param {*} [options] Override http request option.
590
+ * @throws {RequiredError}
591
+ */
592
+ listInboundPlanPallets: async (inboundPlanId, pageSize, paginationToken, options = {}) => {
593
+ // verify required parameter 'inboundPlanId' is not null or undefined
594
+ assertParamExists('listInboundPlanPallets', 'inboundPlanId', inboundPlanId);
595
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/pallets`
596
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
597
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
598
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
599
+ let baseOptions;
600
+ if (configuration) {
601
+ baseOptions = configuration.baseOptions;
602
+ }
603
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
604
+ const localVarHeaderParameter = {};
605
+ const localVarQueryParameter = {};
606
+ if (pageSize !== undefined) {
607
+ localVarQueryParameter['pageSize'] = pageSize;
608
+ }
609
+ if (paginationToken !== undefined) {
610
+ localVarQueryParameter['paginationToken'] = paginationToken;
611
+ }
612
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
613
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
614
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
615
+ return {
616
+ url: toPathString(localVarUrlObj),
617
+ options: localVarRequestOptions,
618
+ };
619
+ },
620
+ /**
621
+ * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
622
+ * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query.
623
+ * @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.
624
+ * @param {'ACTIVE' | 'VOIDED' | 'SHIPPED'} [status] The status of an inbound plan.
625
+ * @param {'LAST_UPDATED_TIME' | 'CREATION_TIME'} [sortBy] Sort by field.
626
+ * @param {'ASC' | 'DESC'} [sortOrder] The sort order.
627
+ * @param {*} [options] Override http request option.
628
+ * @throws {RequiredError}
629
+ */
630
+ listInboundPlans: async (pageSize, paginationToken, status, sortBy, sortOrder, options = {}) => {
631
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans`;
632
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
633
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
634
+ let baseOptions;
635
+ if (configuration) {
636
+ baseOptions = configuration.baseOptions;
637
+ }
638
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
639
+ const localVarHeaderParameter = {};
640
+ const localVarQueryParameter = {};
641
+ if (pageSize !== undefined) {
642
+ localVarQueryParameter['pageSize'] = pageSize;
643
+ }
644
+ if (paginationToken !== undefined) {
645
+ localVarQueryParameter['paginationToken'] = paginationToken;
646
+ }
647
+ if (status !== undefined) {
648
+ localVarQueryParameter['status'] = status;
649
+ }
650
+ if (sortBy !== undefined) {
651
+ localVarQueryParameter['sortBy'] = sortBy;
652
+ }
653
+ if (sortOrder !== undefined) {
654
+ localVarQueryParameter['sortOrder'] = sortOrder;
655
+ }
656
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
657
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
658
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
659
+ return {
660
+ url: toPathString(localVarUrlObj),
661
+ options: localVarRequestOptions,
662
+ };
663
+ },
664
+ /**
665
+ * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
666
+ * @param {Array<string>} mskus List of merchant SKUs, a merchant-supplied identifier for a specific SKU.
667
+ * @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
668
+ * @param {*} [options] Override http request option.
669
+ * @throws {RequiredError}
670
+ */
671
+ listItemComplianceDetails: async (mskus, marketplaceId, options = {}) => {
672
+ // verify required parameter 'mskus' is not null or undefined
673
+ assertParamExists('listItemComplianceDetails', 'mskus', mskus);
674
+ // verify required parameter 'marketplaceId' is not null or undefined
675
+ assertParamExists('listItemComplianceDetails', 'marketplaceId', marketplaceId);
676
+ const localVarPath = `/inbound/fba/2024-03-20/items/compliance`;
677
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
678
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
679
+ let baseOptions;
680
+ if (configuration) {
681
+ baseOptions = configuration.baseOptions;
682
+ }
683
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
684
+ const localVarHeaderParameter = {};
685
+ const localVarQueryParameter = {};
686
+ if (mskus) {
687
+ localVarQueryParameter['mskus'] = mskus;
688
+ }
689
+ if (marketplaceId !== undefined) {
690
+ localVarQueryParameter['marketplaceId'] = marketplaceId;
691
+ }
692
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
693
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
694
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
695
+ return {
696
+ url: toPathString(localVarUrlObj),
697
+ options: localVarRequestOptions,
698
+ };
699
+ },
700
+ /**
701
+ * Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
702
+ * @param {string} inboundPlanId Identifier to an inbound plan.
703
+ * @param {string} packingOptionId Identifier to a packing option.
704
+ * @param {string} packingGroupId Identifier to a packing group.
705
+ * @param {number} [pageSize] The number of packing group items to return in the response matching the given query.
706
+ * @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.
707
+ * @param {*} [options] Override http request option.
708
+ * @throws {RequiredError}
709
+ */
710
+ listPackingGroupItems: async (inboundPlanId, packingOptionId, packingGroupId, pageSize, paginationToken, options = {}) => {
711
+ // verify required parameter 'inboundPlanId' is not null or undefined
712
+ assertParamExists('listPackingGroupItems', 'inboundPlanId', inboundPlanId);
713
+ // verify required parameter 'packingOptionId' is not null or undefined
714
+ assertParamExists('listPackingGroupItems', 'packingOptionId', packingOptionId);
715
+ // verify required parameter 'packingGroupId' is not null or undefined
716
+ assertParamExists('listPackingGroupItems', 'packingGroupId', packingGroupId);
717
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions/{packingOptionId}/packingGroups/{packingGroupId}/items`
718
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
719
+ .replace(`{${"packingOptionId"}}`, encodeURIComponent(String(packingOptionId)))
720
+ .replace(`{${"packingGroupId"}}`, encodeURIComponent(String(packingGroupId)));
721
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
722
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
723
+ let baseOptions;
724
+ if (configuration) {
725
+ baseOptions = configuration.baseOptions;
726
+ }
727
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
728
+ const localVarHeaderParameter = {};
729
+ const localVarQueryParameter = {};
730
+ if (pageSize !== undefined) {
731
+ localVarQueryParameter['pageSize'] = pageSize;
732
+ }
733
+ if (paginationToken !== undefined) {
734
+ localVarQueryParameter['paginationToken'] = paginationToken;
735
+ }
736
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
737
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
738
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
739
+ return {
740
+ url: toPathString(localVarUrlObj),
741
+ options: localVarRequestOptions,
742
+ };
743
+ },
744
+ /**
745
+ * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
746
+ * @param {string} inboundPlanId Identifier to an inbound plan.
747
+ * @param {number} [pageSize] The number of packing options to return in the response matching the given query.
748
+ * @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.
749
+ * @param {*} [options] Override http request option.
750
+ * @throws {RequiredError}
751
+ */
752
+ listPackingOptions: async (inboundPlanId, pageSize, paginationToken, options = {}) => {
753
+ // verify required parameter 'inboundPlanId' is not null or undefined
754
+ assertParamExists('listPackingOptions', 'inboundPlanId', inboundPlanId);
755
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions`
756
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
757
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
758
+ const localVarUrlObj = new URL(localVarPath, 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
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
773
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
774
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
775
+ return {
776
+ url: toPathString(localVarUrlObj),
777
+ options: localVarRequestOptions,
778
+ };
779
+ },
780
+ /**
781
+ * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
782
+ * @param {string} inboundPlanId Identifier to an inbound plan.
783
+ * @param {number} [pageSize] The number of placement options to return in the response matching the given query.
784
+ * @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.
785
+ * @param {*} [options] Override http request option.
786
+ * @throws {RequiredError}
787
+ */
788
+ listPlacementOptions: async (inboundPlanId, pageSize, paginationToken, options = {}) => {
789
+ // verify required parameter 'inboundPlanId' is not null or undefined
790
+ assertParamExists('listPlacementOptions', 'inboundPlanId', inboundPlanId);
791
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/placementOptions`
792
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
793
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
794
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
795
+ let baseOptions;
796
+ if (configuration) {
797
+ baseOptions = configuration.baseOptions;
798
+ }
799
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
800
+ const localVarHeaderParameter = {};
801
+ const localVarQueryParameter = {};
802
+ if (pageSize !== undefined) {
803
+ localVarQueryParameter['pageSize'] = pageSize;
804
+ }
805
+ if (paginationToken !== undefined) {
806
+ localVarQueryParameter['paginationToken'] = paginationToken;
807
+ }
808
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
809
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
810
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
811
+ return {
812
+ url: toPathString(localVarUrlObj),
813
+ options: localVarRequestOptions,
814
+ };
815
+ },
816
+ /**
817
+ * Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
818
+ * @param {string} inboundPlanId Identifier to an inbound plan.
819
+ * @param {number} [pageSize] The number of transportation options to return in the response matching the given query.
820
+ * @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.
821
+ * @param {string} [placementOptionId] The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.
822
+ * @param {string} [shipmentId] The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.
823
+ * @param {*} [options] Override http request option.
824
+ * @throws {RequiredError}
825
+ */
826
+ listTransportationOptions: async (inboundPlanId, pageSize, paginationToken, placementOptionId, shipmentId, options = {}) => {
827
+ // verify required parameter 'inboundPlanId' is not null or undefined
828
+ assertParamExists('listTransportationOptions', 'inboundPlanId', inboundPlanId);
829
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/transportationOptions`
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, 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
+ if (placementOptionId !== undefined) {
847
+ localVarQueryParameter['placementOptionId'] = placementOptionId;
848
+ }
849
+ if (shipmentId !== undefined) {
850
+ localVarQueryParameter['shipmentId'] = shipmentId;
851
+ }
852
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
853
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
854
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
855
+ return {
856
+ url: toPathString(localVarUrlObj),
857
+ options: localVarRequestOptions,
858
+ };
859
+ },
860
+ /**
861
+ * Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
862
+ * @param {string} inboundPlanId Identifier to an inbound plan.
863
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
864
+ * @param {string} slotId Identifier to a self-ship appointment slot.
865
+ * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to &#x60;scheduleSelfShipAppointment&#x60;.
866
+ * @param {*} [options] Override http request option.
867
+ * @throws {RequiredError}
868
+ */
869
+ scheduleSelfShipAppointment: async (inboundPlanId, shipmentId, slotId, body, options = {}) => {
870
+ // verify required parameter 'inboundPlanId' is not null or undefined
871
+ assertParamExists('scheduleSelfShipAppointment', 'inboundPlanId', inboundPlanId);
872
+ // verify required parameter 'shipmentId' is not null or undefined
873
+ assertParamExists('scheduleSelfShipAppointment', 'shipmentId', shipmentId);
874
+ // verify required parameter 'slotId' is not null or undefined
875
+ assertParamExists('scheduleSelfShipAppointment', 'slotId', slotId);
876
+ // verify required parameter 'body' is not null or undefined
877
+ assertParamExists('scheduleSelfShipAppointment', 'body', body);
878
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots/{slotId}/schedule`
879
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
880
+ .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)))
881
+ .replace(`{${"slotId"}}`, encodeURIComponent(String(slotId)));
882
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
883
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
884
+ let baseOptions;
885
+ if (configuration) {
886
+ baseOptions = configuration.baseOptions;
887
+ }
888
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
889
+ const localVarHeaderParameter = {};
890
+ const localVarQueryParameter = {};
891
+ localVarHeaderParameter['Content-Type'] = 'application/json';
892
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
893
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
894
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
895
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
896
+ return {
897
+ url: toPathString(localVarUrlObj),
898
+ options: localVarRequestOptions,
899
+ };
900
+ },
901
+ /**
902
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
903
+ * @param {string} inboundPlanId Identifier to an inbound plan.
904
+ * @param {SetPackingInformationRequest} body The body of the request to &#x60;setPackingInformation&#x60;.
905
+ * @param {*} [options] Override http request option.
906
+ * @throws {RequiredError}
907
+ */
908
+ setPackingInformation: async (inboundPlanId, body, options = {}) => {
909
+ // verify required parameter 'inboundPlanId' is not null or undefined
910
+ assertParamExists('setPackingInformation', 'inboundPlanId', inboundPlanId);
911
+ // verify required parameter 'body' is not null or undefined
912
+ assertParamExists('setPackingInformation', 'body', body);
913
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingInformation`
914
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
915
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
916
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
917
+ let baseOptions;
918
+ if (configuration) {
919
+ baseOptions = configuration.baseOptions;
920
+ }
921
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
922
+ const localVarHeaderParameter = {};
923
+ const localVarQueryParameter = {};
924
+ localVarHeaderParameter['Content-Type'] = 'application/json';
925
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
926
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
927
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
928
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
929
+ return {
930
+ url: toPathString(localVarUrlObj),
931
+ options: localVarRequestOptions,
932
+ };
933
+ },
934
+ /**
935
+ * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
936
+ * @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
937
+ * @param {UpdateItemComplianceDetailsRequest} body The body of the request to &#x60;updateItemComplianceDetails&#x60;.
938
+ * @param {*} [options] Override http request option.
939
+ * @throws {RequiredError}
940
+ */
941
+ updateItemComplianceDetails: async (marketplaceId, body, options = {}) => {
942
+ // verify required parameter 'marketplaceId' is not null or undefined
943
+ assertParamExists('updateItemComplianceDetails', 'marketplaceId', marketplaceId);
944
+ // verify required parameter 'body' is not null or undefined
945
+ assertParamExists('updateItemComplianceDetails', 'body', body);
946
+ const localVarPath = `/inbound/fba/2024-03-20/items/compliance`;
947
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
948
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
949
+ let baseOptions;
950
+ if (configuration) {
951
+ baseOptions = configuration.baseOptions;
952
+ }
953
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
954
+ const localVarHeaderParameter = {};
955
+ const localVarQueryParameter = {};
956
+ if (marketplaceId !== undefined) {
957
+ localVarQueryParameter['marketplaceId'] = marketplaceId;
958
+ }
959
+ localVarHeaderParameter['Content-Type'] = 'application/json';
960
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
961
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
962
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
963
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
964
+ return {
965
+ url: toPathString(localVarUrlObj),
966
+ options: localVarRequestOptions,
967
+ };
968
+ },
969
+ /**
970
+ * Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
971
+ * @param {string} inboundPlanId Identifier to an inbound plan.
972
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
973
+ * @param {UpdateShipmentDeliveryWindowRequest} body The body of the request to &#x60;updateShipmentDeliveryWindow&#x60;.
974
+ * @param {*} [options] Override http request option.
975
+ * @throws {RequiredError}
976
+ */
977
+ updateShipmentDeliveryWindow: async (inboundPlanId, shipmentId, body, options = {}) => {
978
+ // verify required parameter 'inboundPlanId' is not null or undefined
979
+ assertParamExists('updateShipmentDeliveryWindow', 'inboundPlanId', inboundPlanId);
980
+ // verify required parameter 'shipmentId' is not null or undefined
981
+ assertParamExists('updateShipmentDeliveryWindow', 'shipmentId', shipmentId);
982
+ // verify required parameter 'body' is not null or undefined
983
+ assertParamExists('updateShipmentDeliveryWindow', 'body', body);
984
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindow`
985
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
986
+ .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
987
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
988
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
989
+ let baseOptions;
990
+ if (configuration) {
991
+ baseOptions = configuration.baseOptions;
992
+ }
993
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
994
+ const localVarHeaderParameter = {};
995
+ const localVarQueryParameter = {};
996
+ localVarHeaderParameter['Content-Type'] = 'application/json';
997
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
998
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
999
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1000
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
1001
+ return {
1002
+ url: toPathString(localVarUrlObj),
1003
+ options: localVarRequestOptions,
1004
+ };
1005
+ },
1006
+ /**
1007
+ * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1008
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1009
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1010
+ * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to &#x60;updateShipmentTrackingDetails&#x60;.
1011
+ * @param {*} [options] Override http request option.
1012
+ * @throws {RequiredError}
1013
+ */
1014
+ updateShipmentTrackingDetails: async (inboundPlanId, shipmentId, body, options = {}) => {
1015
+ // verify required parameter 'inboundPlanId' is not null or undefined
1016
+ assertParamExists('updateShipmentTrackingDetails', 'inboundPlanId', inboundPlanId);
1017
+ // verify required parameter 'shipmentId' is not null or undefined
1018
+ assertParamExists('updateShipmentTrackingDetails', 'shipmentId', shipmentId);
1019
+ // verify required parameter 'body' is not null or undefined
1020
+ assertParamExists('updateShipmentTrackingDetails', 'body', body);
1021
+ const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/trackingDetails`
1022
+ .replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
1023
+ .replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
1024
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1025
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1026
+ let baseOptions;
1027
+ if (configuration) {
1028
+ baseOptions = configuration.baseOptions;
1029
+ }
1030
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
1031
+ const localVarHeaderParameter = {};
1032
+ const localVarQueryParameter = {};
1033
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1034
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1035
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1036
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1037
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
1038
+ return {
1039
+ url: toPathString(localVarUrlObj),
1040
+ options: localVarRequestOptions,
1041
+ };
1042
+ },
1043
+ };
1044
+ };
1045
+ /**
1046
+ * FbaInboundApi - functional programming interface
1047
+ * @export
1048
+ */
1049
+ export const FbaInboundApiFp = function (configuration) {
1050
+ const localVarAxiosParamCreator = FbaInboundApiAxiosParamCreator(configuration);
1051
+ return {
1052
+ /**
1053
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1054
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1055
+ * @param {*} [options] Override http request option.
1056
+ * @throws {RequiredError}
1057
+ */
1058
+ async cancelInboundPlan(inboundPlanId, options) {
1059
+ const localVarAxiosArgs = await localVarAxiosParamCreator.cancelInboundPlan(inboundPlanId, options);
1060
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1061
+ },
1062
+ /**
1063
+ * Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1064
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1065
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1066
+ * @param {string} slotId Identifier to a self-ship appointment slot.
1067
+ * @param {CancelSelfShipAppointmentRequest} body The body of the request to &#x60;cancelSelfShipAppointment&#x60;.
1068
+ * @param {*} [options] Override http request option.
1069
+ * @throws {RequiredError}
1070
+ */
1071
+ async cancelSelfShipAppointment(inboundPlanId, shipmentId, slotId, body, options) {
1072
+ const localVarAxiosArgs = await localVarAxiosParamCreator.cancelSelfShipAppointment(inboundPlanId, shipmentId, slotId, body, options);
1073
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1074
+ },
1075
+ /**
1076
+ * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1077
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1078
+ * @param {string} packingOptionId Identifier to a packing option.
1079
+ * @param {*} [options] Override http request option.
1080
+ * @throws {RequiredError}
1081
+ */
1082
+ async confirmPackingOption(inboundPlanId, packingOptionId, options) {
1083
+ const localVarAxiosArgs = await localVarAxiosParamCreator.confirmPackingOption(inboundPlanId, packingOptionId, options);
1084
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1085
+ },
1086
+ /**
1087
+ * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1088
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1089
+ * @param {string} placementOptionId Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs.
1090
+ * @param {*} [options] Override http request option.
1091
+ * @throws {RequiredError}
1092
+ */
1093
+ async confirmPlacementOption(inboundPlanId, placementOptionId, options) {
1094
+ const localVarAxiosArgs = await localVarAxiosParamCreator.confirmPlacementOption(inboundPlanId, placementOptionId, options);
1095
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1096
+ },
1097
+ /**
1098
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1099
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1100
+ * @param {ConfirmTransportationOptionsRequest} body The body of the request to &#x60;confirmTransportationOptions&#x60;.
1101
+ * @param {*} [options] Override http request option.
1102
+ * @throws {RequiredError}
1103
+ */
1104
+ async confirmTransportationOptions(inboundPlanId, body, options) {
1105
+ const localVarAxiosArgs = await localVarAxiosParamCreator.confirmTransportationOptions(inboundPlanId, body, options);
1106
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1107
+ },
1108
+ /**
1109
+ * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1110
+ * @param {CreateInboundPlanRequest} body The body of the request to &#x60;createInboundPlan&#x60;.
1111
+ * @param {*} [options] Override http request option.
1112
+ * @throws {RequiredError}
1113
+ */
1114
+ async createInboundPlan(body, options) {
1115
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createInboundPlan(body, options);
1116
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1117
+ },
1118
+ /**
1119
+ * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1120
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1121
+ * @param {*} [options] Override http request option.
1122
+ * @throws {RequiredError}
1123
+ */
1124
+ async generatePackingOptions(inboundPlanId, options) {
1125
+ const localVarAxiosArgs = await localVarAxiosParamCreator.generatePackingOptions(inboundPlanId, options);
1126
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1127
+ },
1128
+ /**
1129
+ * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1130
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1131
+ * @param {GeneratePlacementOptionsRequest} body The body of the request to &#x60;generatePlacementOptions&#x60;.
1132
+ * @param {*} [options] Override http request option.
1133
+ * @throws {RequiredError}
1134
+ */
1135
+ async generatePlacementOptions(inboundPlanId, body, options) {
1136
+ const localVarAxiosArgs = await localVarAxiosParamCreator.generatePlacementOptions(inboundPlanId, body, options);
1137
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1138
+ },
1139
+ /**
1140
+ * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1141
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1142
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1143
+ * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request &#x60;generateSelfShipAppointmentSlots&#x60;.
1144
+ * @param {*} [options] Override http request option.
1145
+ * @throws {RequiredError}
1146
+ */
1147
+ async generateSelfShipAppointmentSlots(inboundPlanId, shipmentId, body, options) {
1148
+ const localVarAxiosArgs = await localVarAxiosParamCreator.generateSelfShipAppointmentSlots(inboundPlanId, shipmentId, body, options);
1149
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1150
+ },
1151
+ /**
1152
+ * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1153
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1154
+ * @param {GenerateTransportationOptionsRequest} body The body of the request to &#x60;generateTransportationOptions&#x60;.
1155
+ * @param {*} [options] Override http request option.
1156
+ * @throws {RequiredError}
1157
+ */
1158
+ async generateTransportationOptions(inboundPlanId, body, options) {
1159
+ const localVarAxiosArgs = await localVarAxiosParamCreator.generateTransportationOptions(inboundPlanId, body, options);
1160
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1161
+ },
1162
+ /**
1163
+ * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1164
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1165
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1166
+ * @param {*} [options] Override http request option.
1167
+ * @throws {RequiredError}
1168
+ */
1169
+ async getDeliveryChallanDocument(inboundPlanId, shipmentId, options) {
1170
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDeliveryChallanDocument(inboundPlanId, shipmentId, options);
1171
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1172
+ },
1173
+ /**
1174
+ * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1175
+ * @param {string} operationId Identifier to an asynchronous operation.
1176
+ * @param {*} [options] Override http request option.
1177
+ * @throws {RequiredError}
1178
+ */
1179
+ async getInboundOperationStatus(operationId, options) {
1180
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getInboundOperationStatus(operationId, options);
1181
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1182
+ },
1183
+ /**
1184
+ * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1185
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1186
+ * @param {*} [options] Override http request option.
1187
+ * @throws {RequiredError}
1188
+ */
1189
+ async getInboundPlan(inboundPlanId, options) {
1190
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getInboundPlan(inboundPlanId, options);
1191
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1192
+ },
1193
+ /**
1194
+ * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1195
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1196
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1197
+ * @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
1198
+ * @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.
1199
+ * @param {*} [options] Override http request option.
1200
+ * @throws {RequiredError}
1201
+ */
1202
+ async getSelfShipAppointmentSlots(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
1203
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSelfShipAppointmentSlots(inboundPlanId, shipmentId, pageSize, paginationToken, options);
1204
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1205
+ },
1206
+ /**
1207
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1208
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1209
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1210
+ * @param {*} [options] Override http request option.
1211
+ * @throws {RequiredError}
1212
+ */
1213
+ async getShipment(inboundPlanId, shipmentId, options) {
1214
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getShipment(inboundPlanId, shipmentId, options);
1215
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1216
+ },
1217
+ /**
1218
+ * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1219
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1220
+ * @param {number} [pageSize] The number of boxes to return in the response matching the given query.
1221
+ * @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.
1222
+ * @param {*} [options] Override http request option.
1223
+ * @throws {RequiredError}
1224
+ */
1225
+ async listInboundPlanBoxes(inboundPlanId, pageSize, paginationToken, options) {
1226
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listInboundPlanBoxes(inboundPlanId, pageSize, paginationToken, options);
1227
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1228
+ },
1229
+ /**
1230
+ * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1231
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1232
+ * @param {number} [pageSize] The number of items to return in the response matching the given query.
1233
+ * @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.
1234
+ * @param {*} [options] Override http request option.
1235
+ * @throws {RequiredError}
1236
+ */
1237
+ async listInboundPlanItems(inboundPlanId, pageSize, paginationToken, options) {
1238
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listInboundPlanItems(inboundPlanId, pageSize, paginationToken, options);
1239
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1240
+ },
1241
+ /**
1242
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1243
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1244
+ * @param {number} [pageSize] The number of pallets to return in the response matching the given query.
1245
+ * @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.
1246
+ * @param {*} [options] Override http request option.
1247
+ * @throws {RequiredError}
1248
+ */
1249
+ async listInboundPlanPallets(inboundPlanId, pageSize, paginationToken, options) {
1250
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listInboundPlanPallets(inboundPlanId, pageSize, paginationToken, options);
1251
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1252
+ },
1253
+ /**
1254
+ * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1255
+ * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query.
1256
+ * @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.
1257
+ * @param {'ACTIVE' | 'VOIDED' | 'SHIPPED'} [status] The status of an inbound plan.
1258
+ * @param {'LAST_UPDATED_TIME' | 'CREATION_TIME'} [sortBy] Sort by field.
1259
+ * @param {'ASC' | 'DESC'} [sortOrder] The sort order.
1260
+ * @param {*} [options] Override http request option.
1261
+ * @throws {RequiredError}
1262
+ */
1263
+ async listInboundPlans(pageSize, paginationToken, status, sortBy, sortOrder, options) {
1264
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listInboundPlans(pageSize, paginationToken, status, sortBy, sortOrder, options);
1265
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1266
+ },
1267
+ /**
1268
+ * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1269
+ * @param {Array<string>} mskus List of merchant SKUs, a merchant-supplied identifier for a specific SKU.
1270
+ * @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
1271
+ * @param {*} [options] Override http request option.
1272
+ * @throws {RequiredError}
1273
+ */
1274
+ async listItemComplianceDetails(mskus, marketplaceId, options) {
1275
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listItemComplianceDetails(mskus, marketplaceId, options);
1276
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1277
+ },
1278
+ /**
1279
+ * Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1280
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1281
+ * @param {string} packingOptionId Identifier to a packing option.
1282
+ * @param {string} packingGroupId Identifier to a packing group.
1283
+ * @param {number} [pageSize] The number of packing group items to return in the response matching the given query.
1284
+ * @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.
1285
+ * @param {*} [options] Override http request option.
1286
+ * @throws {RequiredError}
1287
+ */
1288
+ async listPackingGroupItems(inboundPlanId, packingOptionId, packingGroupId, pageSize, paginationToken, options) {
1289
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPackingGroupItems(inboundPlanId, packingOptionId, packingGroupId, pageSize, paginationToken, options);
1290
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1291
+ },
1292
+ /**
1293
+ * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1294
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1295
+ * @param {number} [pageSize] The number of packing options to return in the response matching the given query.
1296
+ * @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.
1297
+ * @param {*} [options] Override http request option.
1298
+ * @throws {RequiredError}
1299
+ */
1300
+ async listPackingOptions(inboundPlanId, pageSize, paginationToken, options) {
1301
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPackingOptions(inboundPlanId, pageSize, paginationToken, options);
1302
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1303
+ },
1304
+ /**
1305
+ * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1306
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1307
+ * @param {number} [pageSize] The number of placement options to return in the response matching the given query.
1308
+ * @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.
1309
+ * @param {*} [options] Override http request option.
1310
+ * @throws {RequiredError}
1311
+ */
1312
+ async listPlacementOptions(inboundPlanId, pageSize, paginationToken, options) {
1313
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPlacementOptions(inboundPlanId, pageSize, paginationToken, options);
1314
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1315
+ },
1316
+ /**
1317
+ * Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1318
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1319
+ * @param {number} [pageSize] The number of transportation options to return in the response matching the given query.
1320
+ * @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.
1321
+ * @param {string} [placementOptionId] The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.
1322
+ * @param {string} [shipmentId] The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.
1323
+ * @param {*} [options] Override http request option.
1324
+ * @throws {RequiredError}
1325
+ */
1326
+ async listTransportationOptions(inboundPlanId, pageSize, paginationToken, placementOptionId, shipmentId, options) {
1327
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listTransportationOptions(inboundPlanId, pageSize, paginationToken, placementOptionId, shipmentId, options);
1328
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1329
+ },
1330
+ /**
1331
+ * Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1332
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1333
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1334
+ * @param {string} slotId Identifier to a self-ship appointment slot.
1335
+ * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to &#x60;scheduleSelfShipAppointment&#x60;.
1336
+ * @param {*} [options] Override http request option.
1337
+ * @throws {RequiredError}
1338
+ */
1339
+ async scheduleSelfShipAppointment(inboundPlanId, shipmentId, slotId, body, options) {
1340
+ const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleSelfShipAppointment(inboundPlanId, shipmentId, slotId, body, options);
1341
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1342
+ },
1343
+ /**
1344
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1345
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1346
+ * @param {SetPackingInformationRequest} body The body of the request to &#x60;setPackingInformation&#x60;.
1347
+ * @param {*} [options] Override http request option.
1348
+ * @throws {RequiredError}
1349
+ */
1350
+ async setPackingInformation(inboundPlanId, body, options) {
1351
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setPackingInformation(inboundPlanId, body, options);
1352
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1353
+ },
1354
+ /**
1355
+ * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1356
+ * @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
1357
+ * @param {UpdateItemComplianceDetailsRequest} body The body of the request to &#x60;updateItemComplianceDetails&#x60;.
1358
+ * @param {*} [options] Override http request option.
1359
+ * @throws {RequiredError}
1360
+ */
1361
+ async updateItemComplianceDetails(marketplaceId, body, options) {
1362
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateItemComplianceDetails(marketplaceId, body, options);
1363
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1364
+ },
1365
+ /**
1366
+ * Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1367
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1368
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1369
+ * @param {UpdateShipmentDeliveryWindowRequest} body The body of the request to &#x60;updateShipmentDeliveryWindow&#x60;.
1370
+ * @param {*} [options] Override http request option.
1371
+ * @throws {RequiredError}
1372
+ */
1373
+ async updateShipmentDeliveryWindow(inboundPlanId, shipmentId, body, options) {
1374
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentDeliveryWindow(inboundPlanId, shipmentId, body, options);
1375
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1376
+ },
1377
+ /**
1378
+ * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1379
+ * @param {string} inboundPlanId Identifier to an inbound plan.
1380
+ * @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
1381
+ * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to &#x60;updateShipmentTrackingDetails&#x60;.
1382
+ * @param {*} [options] Override http request option.
1383
+ * @throws {RequiredError}
1384
+ */
1385
+ async updateShipmentTrackingDetails(inboundPlanId, shipmentId, body, options) {
1386
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentTrackingDetails(inboundPlanId, shipmentId, body, options);
1387
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1388
+ },
1389
+ };
1390
+ };
1391
+ /**
1392
+ * FbaInboundApi - factory interface
1393
+ * @export
1394
+ */
1395
+ export const FbaInboundApiFactory = function (configuration, basePath, axios) {
1396
+ const localVarFp = FbaInboundApiFp(configuration);
1397
+ return {
1398
+ /**
1399
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1400
+ * @param {FbaInboundApiCancelInboundPlanRequest} requestParameters Request parameters.
1401
+ * @param {*} [options] Override http request option.
1402
+ * @throws {RequiredError}
1403
+ */
1404
+ cancelInboundPlan(requestParameters, options) {
1405
+ return localVarFp.cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
1406
+ },
1407
+ /**
1408
+ * Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1409
+ * @param {FbaInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
1410
+ * @param {*} [options] Override http request option.
1411
+ * @throws {RequiredError}
1412
+ */
1413
+ cancelSelfShipAppointment(requestParameters, options) {
1414
+ return localVarFp.cancelSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.slotId, requestParameters.body, options).then((request) => request(axios, basePath));
1415
+ },
1416
+ /**
1417
+ * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1418
+ * @param {FbaInboundApiConfirmPackingOptionRequest} requestParameters Request parameters.
1419
+ * @param {*} [options] Override http request option.
1420
+ * @throws {RequiredError}
1421
+ */
1422
+ confirmPackingOption(requestParameters, options) {
1423
+ return localVarFp.confirmPackingOption(requestParameters.inboundPlanId, requestParameters.packingOptionId, options).then((request) => request(axios, basePath));
1424
+ },
1425
+ /**
1426
+ * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1427
+ * @param {FbaInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters.
1428
+ * @param {*} [options] Override http request option.
1429
+ * @throws {RequiredError}
1430
+ */
1431
+ confirmPlacementOption(requestParameters, options) {
1432
+ return localVarFp.confirmPlacementOption(requestParameters.inboundPlanId, requestParameters.placementOptionId, options).then((request) => request(axios, basePath));
1433
+ },
1434
+ /**
1435
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1436
+ * @param {FbaInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters.
1437
+ * @param {*} [options] Override http request option.
1438
+ * @throws {RequiredError}
1439
+ */
1440
+ confirmTransportationOptions(requestParameters, options) {
1441
+ return localVarFp.confirmTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
1442
+ },
1443
+ /**
1444
+ * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1445
+ * @param {FbaInboundApiCreateInboundPlanRequest} requestParameters Request parameters.
1446
+ * @param {*} [options] Override http request option.
1447
+ * @throws {RequiredError}
1448
+ */
1449
+ createInboundPlan(requestParameters, options) {
1450
+ return localVarFp.createInboundPlan(requestParameters.body, options).then((request) => request(axios, basePath));
1451
+ },
1452
+ /**
1453
+ * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1454
+ * @param {FbaInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters.
1455
+ * @param {*} [options] Override http request option.
1456
+ * @throws {RequiredError}
1457
+ */
1458
+ generatePackingOptions(requestParameters, options) {
1459
+ return localVarFp.generatePackingOptions(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
1460
+ },
1461
+ /**
1462
+ * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1463
+ * @param {FbaInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters.
1464
+ * @param {*} [options] Override http request option.
1465
+ * @throws {RequiredError}
1466
+ */
1467
+ generatePlacementOptions(requestParameters, options) {
1468
+ return localVarFp.generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
1469
+ },
1470
+ /**
1471
+ * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1472
+ * @param {FbaInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
1473
+ * @param {*} [options] Override http request option.
1474
+ * @throws {RequiredError}
1475
+ */
1476
+ generateSelfShipAppointmentSlots(requestParameters, options) {
1477
+ return localVarFp.generateSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
1478
+ },
1479
+ /**
1480
+ * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1481
+ * @param {FbaInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters.
1482
+ * @param {*} [options] Override http request option.
1483
+ * @throws {RequiredError}
1484
+ */
1485
+ generateTransportationOptions(requestParameters, options) {
1486
+ return localVarFp.generateTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
1487
+ },
1488
+ /**
1489
+ * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1490
+ * @param {FbaInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters.
1491
+ * @param {*} [options] Override http request option.
1492
+ * @throws {RequiredError}
1493
+ */
1494
+ getDeliveryChallanDocument(requestParameters, options) {
1495
+ return localVarFp.getDeliveryChallanDocument(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
1496
+ },
1497
+ /**
1498
+ * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1499
+ * @param {FbaInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters.
1500
+ * @param {*} [options] Override http request option.
1501
+ * @throws {RequiredError}
1502
+ */
1503
+ getInboundOperationStatus(requestParameters, options) {
1504
+ return localVarFp.getInboundOperationStatus(requestParameters.operationId, options).then((request) => request(axios, basePath));
1505
+ },
1506
+ /**
1507
+ * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1508
+ * @param {FbaInboundApiGetInboundPlanRequest} requestParameters Request parameters.
1509
+ * @param {*} [options] Override http request option.
1510
+ * @throws {RequiredError}
1511
+ */
1512
+ getInboundPlan(requestParameters, options) {
1513
+ return localVarFp.getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
1514
+ },
1515
+ /**
1516
+ * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1517
+ * @param {FbaInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
1518
+ * @param {*} [options] Override http request option.
1519
+ * @throws {RequiredError}
1520
+ */
1521
+ getSelfShipAppointmentSlots(requestParameters, options) {
1522
+ return localVarFp.getSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
1523
+ },
1524
+ /**
1525
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1526
+ * @param {FbaInboundApiGetShipmentRequest} requestParameters Request parameters.
1527
+ * @param {*} [options] Override http request option.
1528
+ * @throws {RequiredError}
1529
+ */
1530
+ getShipment(requestParameters, options) {
1531
+ return localVarFp.getShipment(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
1532
+ },
1533
+ /**
1534
+ * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1535
+ * @param {FbaInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters.
1536
+ * @param {*} [options] Override http request option.
1537
+ * @throws {RequiredError}
1538
+ */
1539
+ listInboundPlanBoxes(requestParameters, options) {
1540
+ return localVarFp.listInboundPlanBoxes(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
1541
+ },
1542
+ /**
1543
+ * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1544
+ * @param {FbaInboundApiListInboundPlanItemsRequest} requestParameters Request parameters.
1545
+ * @param {*} [options] Override http request option.
1546
+ * @throws {RequiredError}
1547
+ */
1548
+ listInboundPlanItems(requestParameters, options) {
1549
+ return localVarFp.listInboundPlanItems(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
1550
+ },
1551
+ /**
1552
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1553
+ * @param {FbaInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters.
1554
+ * @param {*} [options] Override http request option.
1555
+ * @throws {RequiredError}
1556
+ */
1557
+ listInboundPlanPallets(requestParameters, options) {
1558
+ return localVarFp.listInboundPlanPallets(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
1559
+ },
1560
+ /**
1561
+ * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1562
+ * @param {FbaInboundApiListInboundPlansRequest} requestParameters Request parameters.
1563
+ * @param {*} [options] Override http request option.
1564
+ * @throws {RequiredError}
1565
+ */
1566
+ listInboundPlans(requestParameters = {}, options) {
1567
+ return localVarFp.listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(axios, basePath));
1568
+ },
1569
+ /**
1570
+ * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1571
+ * @param {FbaInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
1572
+ * @param {*} [options] Override http request option.
1573
+ * @throws {RequiredError}
1574
+ */
1575
+ listItemComplianceDetails(requestParameters, options) {
1576
+ return localVarFp.listItemComplianceDetails(requestParameters.mskus, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
1577
+ },
1578
+ /**
1579
+ * Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1580
+ * @param {FbaInboundApiListPackingGroupItemsRequest} requestParameters Request parameters.
1581
+ * @param {*} [options] Override http request option.
1582
+ * @throws {RequiredError}
1583
+ */
1584
+ listPackingGroupItems(requestParameters, options) {
1585
+ return localVarFp.listPackingGroupItems(requestParameters.inboundPlanId, requestParameters.packingOptionId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
1586
+ },
1587
+ /**
1588
+ * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1589
+ * @param {FbaInboundApiListPackingOptionsRequest} requestParameters Request parameters.
1590
+ * @param {*} [options] Override http request option.
1591
+ * @throws {RequiredError}
1592
+ */
1593
+ listPackingOptions(requestParameters, options) {
1594
+ return localVarFp.listPackingOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
1595
+ },
1596
+ /**
1597
+ * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1598
+ * @param {FbaInboundApiListPlacementOptionsRequest} requestParameters Request parameters.
1599
+ * @param {*} [options] Override http request option.
1600
+ * @throws {RequiredError}
1601
+ */
1602
+ listPlacementOptions(requestParameters, options) {
1603
+ return localVarFp.listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
1604
+ },
1605
+ /**
1606
+ * Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1607
+ * @param {FbaInboundApiListTransportationOptionsRequest} requestParameters Request parameters.
1608
+ * @param {*} [options] Override http request option.
1609
+ * @throws {RequiredError}
1610
+ */
1611
+ listTransportationOptions(requestParameters, options) {
1612
+ return localVarFp.listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
1613
+ },
1614
+ /**
1615
+ * Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1616
+ * @param {FbaInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
1617
+ * @param {*} [options] Override http request option.
1618
+ * @throws {RequiredError}
1619
+ */
1620
+ scheduleSelfShipAppointment(requestParameters, options) {
1621
+ return localVarFp.scheduleSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.slotId, requestParameters.body, options).then((request) => request(axios, basePath));
1622
+ },
1623
+ /**
1624
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1625
+ * @param {FbaInboundApiSetPackingInformationRequest} requestParameters Request parameters.
1626
+ * @param {*} [options] Override http request option.
1627
+ * @throws {RequiredError}
1628
+ */
1629
+ setPackingInformation(requestParameters, options) {
1630
+ return localVarFp.setPackingInformation(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
1631
+ },
1632
+ /**
1633
+ * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1634
+ * @param {FbaInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters.
1635
+ * @param {*} [options] Override http request option.
1636
+ * @throws {RequiredError}
1637
+ */
1638
+ updateItemComplianceDetails(requestParameters, options) {
1639
+ return localVarFp.updateItemComplianceDetails(requestParameters.marketplaceId, requestParameters.body, options).then((request) => request(axios, basePath));
1640
+ },
1641
+ /**
1642
+ * Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1643
+ * @param {FbaInboundApiUpdateShipmentDeliveryWindowRequest} requestParameters Request parameters.
1644
+ * @param {*} [options] Override http request option.
1645
+ * @throws {RequiredError}
1646
+ */
1647
+ updateShipmentDeliveryWindow(requestParameters, options) {
1648
+ return localVarFp.updateShipmentDeliveryWindow(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
1649
+ },
1650
+ /**
1651
+ * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1652
+ * @param {FbaInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters.
1653
+ * @param {*} [options] Override http request option.
1654
+ * @throws {RequiredError}
1655
+ */
1656
+ updateShipmentTrackingDetails(requestParameters, options) {
1657
+ return localVarFp.updateShipmentTrackingDetails(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
1658
+ },
1659
+ };
1660
+ };
1661
+ /**
1662
+ * FbaInboundApi - object-oriented interface
1663
+ * @export
1664
+ * @class FbaInboundApi
1665
+ * @extends {BaseAPI}
1666
+ */
1667
+ export class FbaInboundApi extends BaseAPI {
1668
+ /**
1669
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1670
+ * @param {FbaInboundApiCancelInboundPlanRequest} requestParameters Request parameters.
1671
+ * @param {*} [options] Override http request option.
1672
+ * @throws {RequiredError}
1673
+ * @memberof FbaInboundApi
1674
+ */
1675
+ cancelInboundPlan(requestParameters, options) {
1676
+ return FbaInboundApiFp(this.configuration).cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
1677
+ }
1678
+ /**
1679
+ * Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1680
+ * @param {FbaInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
1681
+ * @param {*} [options] Override http request option.
1682
+ * @throws {RequiredError}
1683
+ * @memberof FbaInboundApi
1684
+ */
1685
+ cancelSelfShipAppointment(requestParameters, options) {
1686
+ return FbaInboundApiFp(this.configuration).cancelSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.slotId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
1687
+ }
1688
+ /**
1689
+ * Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1690
+ * @param {FbaInboundApiConfirmPackingOptionRequest} requestParameters Request parameters.
1691
+ * @param {*} [options] Override http request option.
1692
+ * @throws {RequiredError}
1693
+ * @memberof FbaInboundApi
1694
+ */
1695
+ confirmPackingOption(requestParameters, options) {
1696
+ return FbaInboundApiFp(this.configuration).confirmPackingOption(requestParameters.inboundPlanId, requestParameters.packingOptionId, options).then((request) => request(this.axios, this.basePath));
1697
+ }
1698
+ /**
1699
+ * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1700
+ * @param {FbaInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters.
1701
+ * @param {*} [options] Override http request option.
1702
+ * @throws {RequiredError}
1703
+ * @memberof FbaInboundApi
1704
+ */
1705
+ confirmPlacementOption(requestParameters, options) {
1706
+ return FbaInboundApiFp(this.configuration).confirmPlacementOption(requestParameters.inboundPlanId, requestParameters.placementOptionId, options).then((request) => request(this.axios, this.basePath));
1707
+ }
1708
+ /**
1709
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1710
+ * @param {FbaInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters.
1711
+ * @param {*} [options] Override http request option.
1712
+ * @throws {RequiredError}
1713
+ * @memberof FbaInboundApi
1714
+ */
1715
+ confirmTransportationOptions(requestParameters, options) {
1716
+ return FbaInboundApiFp(this.configuration).confirmTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
1717
+ }
1718
+ /**
1719
+ * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1720
+ * @param {FbaInboundApiCreateInboundPlanRequest} requestParameters Request parameters.
1721
+ * @param {*} [options] Override http request option.
1722
+ * @throws {RequiredError}
1723
+ * @memberof FbaInboundApi
1724
+ */
1725
+ createInboundPlan(requestParameters, options) {
1726
+ return FbaInboundApiFp(this.configuration).createInboundPlan(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
1727
+ }
1728
+ /**
1729
+ * Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1730
+ * @param {FbaInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters.
1731
+ * @param {*} [options] Override http request option.
1732
+ * @throws {RequiredError}
1733
+ * @memberof FbaInboundApi
1734
+ */
1735
+ generatePackingOptions(requestParameters, options) {
1736
+ return FbaInboundApiFp(this.configuration).generatePackingOptions(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
1737
+ }
1738
+ /**
1739
+ * Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1740
+ * @param {FbaInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters.
1741
+ * @param {*} [options] Override http request option.
1742
+ * @throws {RequiredError}
1743
+ * @memberof FbaInboundApi
1744
+ */
1745
+ generatePlacementOptions(requestParameters, options) {
1746
+ return FbaInboundApiFp(this.configuration).generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
1747
+ }
1748
+ /**
1749
+ * Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1750
+ * @param {FbaInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
1751
+ * @param {*} [options] Override http request option.
1752
+ * @throws {RequiredError}
1753
+ * @memberof FbaInboundApi
1754
+ */
1755
+ generateSelfShipAppointmentSlots(requestParameters, options) {
1756
+ return FbaInboundApiFp(this.configuration).generateSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
1757
+ }
1758
+ /**
1759
+ * Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1760
+ * @param {FbaInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters.
1761
+ * @param {*} [options] Override http request option.
1762
+ * @throws {RequiredError}
1763
+ * @memberof FbaInboundApi
1764
+ */
1765
+ generateTransportationOptions(requestParameters, options) {
1766
+ return FbaInboundApiFp(this.configuration).generateTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
1767
+ }
1768
+ /**
1769
+ * Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1770
+ * @param {FbaInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters.
1771
+ * @param {*} [options] Override http request option.
1772
+ * @throws {RequiredError}
1773
+ * @memberof FbaInboundApi
1774
+ */
1775
+ getDeliveryChallanDocument(requestParameters, options) {
1776
+ return FbaInboundApiFp(this.configuration).getDeliveryChallanDocument(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
1777
+ }
1778
+ /**
1779
+ * Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1780
+ * @param {FbaInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters.
1781
+ * @param {*} [options] Override http request option.
1782
+ * @throws {RequiredError}
1783
+ * @memberof FbaInboundApi
1784
+ */
1785
+ getInboundOperationStatus(requestParameters, options) {
1786
+ return FbaInboundApiFp(this.configuration).getInboundOperationStatus(requestParameters.operationId, options).then((request) => request(this.axios, this.basePath));
1787
+ }
1788
+ /**
1789
+ * Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1790
+ * @param {FbaInboundApiGetInboundPlanRequest} requestParameters Request parameters.
1791
+ * @param {*} [options] Override http request option.
1792
+ * @throws {RequiredError}
1793
+ * @memberof FbaInboundApi
1794
+ */
1795
+ getInboundPlan(requestParameters, options) {
1796
+ return FbaInboundApiFp(this.configuration).getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
1797
+ }
1798
+ /**
1799
+ * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1800
+ * @param {FbaInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
1801
+ * @param {*} [options] Override http request option.
1802
+ * @throws {RequiredError}
1803
+ * @memberof FbaInboundApi
1804
+ */
1805
+ getSelfShipAppointmentSlots(requestParameters, options) {
1806
+ return FbaInboundApiFp(this.configuration).getSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
1807
+ }
1808
+ /**
1809
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1810
+ * @param {FbaInboundApiGetShipmentRequest} requestParameters Request parameters.
1811
+ * @param {*} [options] Override http request option.
1812
+ * @throws {RequiredError}
1813
+ * @memberof FbaInboundApi
1814
+ */
1815
+ getShipment(requestParameters, options) {
1816
+ return FbaInboundApiFp(this.configuration).getShipment(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
1817
+ }
1818
+ /**
1819
+ * Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1820
+ * @param {FbaInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters.
1821
+ * @param {*} [options] Override http request option.
1822
+ * @throws {RequiredError}
1823
+ * @memberof FbaInboundApi
1824
+ */
1825
+ listInboundPlanBoxes(requestParameters, options) {
1826
+ return FbaInboundApiFp(this.configuration).listInboundPlanBoxes(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
1827
+ }
1828
+ /**
1829
+ * Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1830
+ * @param {FbaInboundApiListInboundPlanItemsRequest} requestParameters Request parameters.
1831
+ * @param {*} [options] Override http request option.
1832
+ * @throws {RequiredError}
1833
+ * @memberof FbaInboundApi
1834
+ */
1835
+ listInboundPlanItems(requestParameters, options) {
1836
+ return FbaInboundApiFp(this.configuration).listInboundPlanItems(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
1837
+ }
1838
+ /**
1839
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1840
+ * @param {FbaInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters.
1841
+ * @param {*} [options] Override http request option.
1842
+ * @throws {RequiredError}
1843
+ * @memberof FbaInboundApi
1844
+ */
1845
+ listInboundPlanPallets(requestParameters, options) {
1846
+ return FbaInboundApiFp(this.configuration).listInboundPlanPallets(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
1847
+ }
1848
+ /**
1849
+ * Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1850
+ * @param {FbaInboundApiListInboundPlansRequest} requestParameters Request parameters.
1851
+ * @param {*} [options] Override http request option.
1852
+ * @throws {RequiredError}
1853
+ * @memberof FbaInboundApi
1854
+ */
1855
+ listInboundPlans(requestParameters = {}, options) {
1856
+ return FbaInboundApiFp(this.configuration).listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(this.axios, this.basePath));
1857
+ }
1858
+ /**
1859
+ * List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1860
+ * @param {FbaInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
1861
+ * @param {*} [options] Override http request option.
1862
+ * @throws {RequiredError}
1863
+ * @memberof FbaInboundApi
1864
+ */
1865
+ listItemComplianceDetails(requestParameters, options) {
1866
+ return FbaInboundApiFp(this.configuration).listItemComplianceDetails(requestParameters.mskus, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath));
1867
+ }
1868
+ /**
1869
+ * Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1870
+ * @param {FbaInboundApiListPackingGroupItemsRequest} requestParameters Request parameters.
1871
+ * @param {*} [options] Override http request option.
1872
+ * @throws {RequiredError}
1873
+ * @memberof FbaInboundApi
1874
+ */
1875
+ listPackingGroupItems(requestParameters, options) {
1876
+ return FbaInboundApiFp(this.configuration).listPackingGroupItems(requestParameters.inboundPlanId, requestParameters.packingOptionId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
1877
+ }
1878
+ /**
1879
+ * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1880
+ * @param {FbaInboundApiListPackingOptionsRequest} requestParameters Request parameters.
1881
+ * @param {*} [options] Override http request option.
1882
+ * @throws {RequiredError}
1883
+ * @memberof FbaInboundApi
1884
+ */
1885
+ listPackingOptions(requestParameters, options) {
1886
+ return FbaInboundApiFp(this.configuration).listPackingOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
1887
+ }
1888
+ /**
1889
+ * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1890
+ * @param {FbaInboundApiListPlacementOptionsRequest} requestParameters Request parameters.
1891
+ * @param {*} [options] Override http request option.
1892
+ * @throws {RequiredError}
1893
+ * @memberof FbaInboundApi
1894
+ */
1895
+ listPlacementOptions(requestParameters, options) {
1896
+ return FbaInboundApiFp(this.configuration).listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
1897
+ }
1898
+ /**
1899
+ * Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1900
+ * @param {FbaInboundApiListTransportationOptionsRequest} requestParameters Request parameters.
1901
+ * @param {*} [options] Override http request option.
1902
+ * @throws {RequiredError}
1903
+ * @memberof FbaInboundApi
1904
+ */
1905
+ listTransportationOptions(requestParameters, options) {
1906
+ return FbaInboundApiFp(this.configuration).listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
1907
+ }
1908
+ /**
1909
+ * Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1910
+ * @param {FbaInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
1911
+ * @param {*} [options] Override http request option.
1912
+ * @throws {RequiredError}
1913
+ * @memberof FbaInboundApi
1914
+ */
1915
+ scheduleSelfShipAppointment(requestParameters, options) {
1916
+ return FbaInboundApiFp(this.configuration).scheduleSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.slotId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
1917
+ }
1918
+ /**
1919
+ * 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1920
+ * @param {FbaInboundApiSetPackingInformationRequest} requestParameters Request parameters.
1921
+ * @param {*} [options] Override http request option.
1922
+ * @throws {RequiredError}
1923
+ * @memberof FbaInboundApi
1924
+ */
1925
+ setPackingInformation(requestParameters, options) {
1926
+ return FbaInboundApiFp(this.configuration).setPackingInformation(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
1927
+ }
1928
+ /**
1929
+ * Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1930
+ * @param {FbaInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters.
1931
+ * @param {*} [options] Override http request option.
1932
+ * @throws {RequiredError}
1933
+ * @memberof FbaInboundApi
1934
+ */
1935
+ updateItemComplianceDetails(requestParameters, options) {
1936
+ return FbaInboundApiFp(this.configuration).updateItemComplianceDetails(requestParameters.marketplaceId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
1937
+ }
1938
+ /**
1939
+ * Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1940
+ * @param {FbaInboundApiUpdateShipmentDeliveryWindowRequest} requestParameters Request parameters.
1941
+ * @param {*} [options] Override http request option.
1942
+ * @throws {RequiredError}
1943
+ * @memberof FbaInboundApi
1944
+ */
1945
+ updateShipmentDeliveryWindow(requestParameters, options) {
1946
+ return FbaInboundApiFp(this.configuration).updateShipmentDeliveryWindow(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
1947
+ }
1948
+ /**
1949
+ * Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
1950
+ * @param {FbaInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters.
1951
+ * @param {*} [options] Override http request option.
1952
+ * @throws {RequiredError}
1953
+ * @memberof FbaInboundApi
1954
+ */
1955
+ updateShipmentTrackingDetails(requestParameters, options) {
1956
+ return FbaInboundApiFp(this.configuration).updateShipmentTrackingDetails(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
1957
+ }
1958
+ }